README

分支信息

此存储库是原始存储库 spatie/data-transfer-object 的一个分支。

安装

您可以通过composer安装此包

composer require eonx/data-transfer-object

用法

此包的目的是使从数组（序列化）数据构造对象尽可能简单。下面是一个DTO的例子

use Spatie\DataTransferObject\Attributes\MapFrom;
use Spatie\DataTransferObject\DataTransferObject;

class MyDTO extends DataTransferObject
{
    public OtherDTO $otherDTO;
    
    public OtherDTOCollection $collection;
    
    #[CastWith(ComplexObjectCaster::class)]
    public ComplexObject $complexObject;
    
    public ComplexObjectWithCast $complexObjectWithCast;
    
    #[NumberBetween(1, 100)]
    public int $a;
    
    #[MapFrom('address.city')]
    public string $city;
}

您可以这样构建这个DTO

$dto = new MyDTO(
    a: 5,
    collection: [
        ['id' => 1],
        ['id' => 2],
        ['id' => 3],
    ],
    complexObject: [
        'name' => 'test',
    ],
    complexObjectWithCast: [
        'name' => 'test',
    ],
    otherDTO: ['id' => 5],
);

让我们逐一讨论所有可能性。

命名参数

可以使用命名参数来构造DTO。也可以继续使用旧的数组表示法。此示例与上面的示例等效。

$dto = new MyDTO([
    'a' => 5,
    'collection' => [
        ['id' => 1],
        ['id' => 2],
        ['id' => 3],
    ],
    'complexObject' => [
        'name' => 'test',
    ],
    'complexObjectWithCast' => [
        'name' => 'test',
    ],
    'otherDTO' => ['id' => 5],
]);

值转换

如果DTO有一个属性是另一个DTO或DTO集合，则包将负责自动将数据数组转换为这些DTO。

$dto = new MyDTO(
    collection: [ // This will become an object of class OtherDTOCollection
        ['id' => 1],
        ['id' => 2], // Each item will be an instance of OtherDTO
        ['id' => 3],
    ],
    otherDTO: ['id' => 5], // This data will be cast to OtherDTO
);

自定义转换器

您可以构建自己的转换器类，这些类将接受它们接收到的任何输入，并将该输入转换为所需的结果。

看看这个 ComplexObject

class ComplexObject
{
    public string $name;
}

及其转换器 ComplexObjectCaster

use Spatie\DataTransferObject\Caster;

class ComplexObjectCaster implements Caster
{
    /**
     * @param array|mixed $value
     *
     * @return mixed
     */
    public function cast(mixed $value): ComplexObject
    {
        return new ComplexObject(
            name: $value['name']
        );
    }
}

类特定转换器

您也可以在目标类本身上定义转换器，而不仅仅是为每个属性指定应该使用哪个转换器。

class MyDTO extends DataTransferObject
{
    public ComplexObjectWithCast $complexObjectWithCast;
}

#[CastWith(ComplexObjectWithCastCaster::class)]
class ComplexObjectWithCast
{
    public string $name;
}

默认转换器

您可以在DTO类本身上定义默认转换器。这些转换器将在DTO类中遇到给定类型的属性时使用。

#[
    DefaultCast(DateTimeImmutable::class, DateTimeImmutableCaster::class),
    DefaultCast(MyEnum::class, EnumCaster::class),
]
abstract class BaseDataTransferObject extends DataTransferObject
{
    public MyEnum $status; // EnumCaster will be used
    
    public DateTimeImmutable $date; // DateTimeImmutableCaster will be used
}

使用自定义转换器参数

任何转换器都可以传递自定义参数，内置的 ArrayCaster 实现是如何使用的良好示例。

在将输入传递给您的转换器时使用命名参数将有助于使您的代码更清晰，但它们不是必需的。

例如

    /** @var \Spatie\DataTransferObject\Tests\Foo[] */
    #[CastWith(ArrayCaster::class, itemType: Foo::class)]
    public array $collectionWithNamedArguments;
    
    /** @var \Spatie\DataTransferObject\Tests\Foo[] */
    #[CastWith(ArrayCaster::class, Foo::class)]
    public array $collectionWithoutNamedArguments;

请注意，传递给转换器构造函数的第一个参数始终是包含要转换的值类型的数组的类型。所有其他参数都将是作为额外参数传递给 CastWith 属性的参数。

验证

此包不提供任何特定的验证功能，但它确实提供了一种构建自己的验证属性的方法。例如，NumberBetween 是用户实现的验证属性。

class MyDTO extends DataTransferObject
{
    #[NumberBetween(1, 100)]
    public int $a;
}

其工作原理如下

#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
class NumberBetween implements Validator
{
    public function __construct(
        private int $min,
        private int $max
    ) {
    }

    public function validate(mixed $value): ValidationResult
    {
        if ($value < $this->min) {
            return ValidationResult::invalid("Value should be greater than or equal to {$this->min}");
        }

        if ($value > $this->max) {
            return ValidationResult::invalid("Value should be less than or equal to {$this->max}");
        }

        return ValidationResult::valid();
    }
}

映射

您可以使用 #[MapFrom] 属性将DTO属性从具有不同名称的源属性映射。

它支持“点”表示法属性名称或索引。

class PostDTO extends DataTransferObject
{
    #[MapFrom('postTitle')]
    public string $title;
    
    #[MapFrom('user.name')]
    public string $author;
}

$dto = new PostDTO([
    'postTitle' => 'Hello world',
    'user' => [
        'name' => 'John Doe'
    ]
]);

class UserDTO extends DataTransferObject
{

    #[MapFrom(0)]
    public string $firstName;
    
    #[MapFrom(1)]
    public string $lastName;
}

$dto = new UserDTO(['John', 'Doe']);

有时您还希望在转换到数组时映射它们。一个典型的用例是将驼峰式命名转换为蛇形命名。为此，您可以使用 #[MapTo] 属性。

class UserDTO extends DataTransferObject
{

    #[MapFrom(0)]
    #[MapTo('first_name')]
    public string $firstName;
    
    #[MapFrom(1)]
    #[MapTo('last_name')]
    public string $lastName;
}

$dto = new UserDTO(['John', 'Doe']);
$dto->toArray() // ['first_name' => 'John', 'last_name'=> 'Doe'];
$dto->only('first_name')->toArray() // ['first_name' => 'John'];

严格DTOs

此包的先前的版本添加了 FlexibleDataTransferObject 类，该类允许您忽略DTO上不存在的属性。此行为已更改，所有DTO现在默认为灵活，但您可以使用 #[Strict] 属性使它们变得严格。

class NonStrictDto extends DataTransferObject
{
    public string $name;
}

// This works
new NonStrictDto(
    name: 'name',
    unknown: 'unknown'
);

use \Spatie\DataTransferObject\Attributes\Strict;

#[Strict]
class StrictDto extends DataTransferObject
{
    public string $name;
}

// This throws a \Spatie\DataTransferObject\Exceptions\UnknownProperties exception
new StrictDto(
    name: 'name',
    unknown: 'unknown'
);

辅助函数

还提供了一些辅助函数，用于同时处理多个属性。

$postData->all();

$postData
    ->only('title', 'body')
    ->toArray();
    
$postData
    ->except('author')
    ->toArray();

请注意，all()会简单地返回所有属性，而toArray()还会将嵌套的DTO转换为数组。

您可以链式调用except()和only()方法。

$postData
    ->except('title')
    ->except('body')
    ->toArray();

需要注意的是，except()和only()是不可变的，它们不会更改原始的数据传输对象。

不可变DTO和克隆

由于PHP不支持不可变对象，该包不强制要求使用不可变对象，但您始终被鼓励保持您的DTO不可变。为了帮助您，每个DTO都有一个clone方法，该方法接受要覆盖的数据。

$clone = $original->clone(other: ['name' => 'a']);

请注意，$original中的数据没有改变。

DTO集合

此版本删除了DataTransferObjectCollection类。相反，您可以使用简单的转换器和您自己的集合类。

以下是将DTO集合转换为DTO数组的一个示例

class Bar extends DataTransferObject
{
    /** @var \Spatie\DataTransferObject\Tests\Foo[] */
    #[CastWith(FooArrayCaster::class)]
    public array $collectionOfFoo;
}

class Foo extends DataTransferObject
{
    public string $name;
}

class FooArrayCaster implements Caster
{
    public function cast(mixed $value): array
    {
        if (! is_array($value)) {
            throw new Exception("Can only cast arrays to Foo");
        }

        return array_map(
            fn (array $data) => new Foo(...$data),
            $value
        );
    }
}

如果您不想使用冗余的类型提示，或者想扩展集合功能，您可以创建自己的集合类，使用任何集合实现。在这个例子中，我们使用了Laravel的。

class Bar extends DataTransferObject
{
    #[CastWith(FooCollectionCaster::class)]
    public CollectionOfFoo $collectionOfFoo;
}

class Foo extends DataTransferObject
{
    public string $name;
}

use Illuminate\Support\Collection;

class CollectionOfFoo extends Collection
{
    // Add the correct return type here for static analyzers to know which type of array this is 
    public function offsetGet($key): Foo
    {
        return parent::offsetGet($key);
    }
}

class FooCollectionCaster implements Caster
{
    public function cast(mixed $value): CollectionOfFoo
    {
        return new CollectionOfFoo(array_map(
            fn (array $data) => new Foo(...$data),
            $value
        ));
    }
}

简单的DTO数组

对于简单的DTO数组，或者实现了PHP内置的ArrayAccess的对象，请考虑使用ArrayCaster，它需要一个项目类型。

class Bar extends DataTransferObject
{
    /** @var \Spatie\DataTransferObject\Tests\Foo[] */
    #[CastWith(ArrayCaster::class, itemType: Foo::class)]
    public array $collectionOfFoo;
}

测试

composer test

变更日志

有关最近更改的更多信息，请参阅变更日志。

贡献

有关详细信息，请参阅贡献指南。

外部工具

json2dto：一个将JSON对象转换为DTO类的GUI（支持嵌套）。同时提供CLI工具供本地使用。
数据传输对象工厂：智能地生成DTO实例，根据属性名称和类型使用正确的内容。

致谢

我们的Arr类包含从Laravel的Arr辅助函数中复制过来的函数。

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。

eonx-com / data-transfer-object

维护者

详细信息