README

内置电池的数据传输对象

安装

您可以通过 composer 安装此包

composer require spatie/data-transfer-object

注意：此包的 v3 版本仅支持 php:^8.0。如果您需要旧版本，请查看 v2。

支持我们

我们在创建一流的开放源代码包上投入了大量资源。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄来明信片，说明您正在使用我们的哪些包。您可以在我们的联系页面上找到我们的地址。我们将所有收到的明信片发布在我们的虚拟明信片墙上。

用法

此包的目标是使从（序列化的）数据数组构建对象尽可能简单。下面是一个 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;

请注意，传递给转换器构造函数的第一个参数始终是包含要转换的值的类型（s）的数组。所有其他参数都将作为在 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'];

严格的DTO

该软件包的早期版本添加了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

更新日志

请参阅更新日志以获取有关最近更改的更多信息。

贡献

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

安全性

如果您发现有关安全性的错误，请通过邮件security@spatie.be联系，而不是使用问题跟踪器。

明信片软件

您可以使用此软件包，但如果它进入您的生产环境，我们非常感谢您从您的家乡寄给我们一张明信片，提及您正在使用我们的哪个软件包。

我们的地址是：Spatie，Kruikstraat 22，2018 安特卫普，比利时。

我们将在我们的公司网站上发布所有收到的明信片[链接]。

外部工具

json2dto：一个将JSON对象转换为DTO类（具有嵌套支持）的图形用户界面。还提供用于本地使用的CLI工具。
数据传输对象工厂：智能地使用属性的正确内容生成DTO实例，基于其名称和类型。

致谢

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

许可

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

windstep / data-transfer-object

维护者

详细信息