README

警告我们决定停止维护此包。

考虑迁移到 spatie/laravel-data 或 cuyz/valinor。

欢迎fork我们的代码并根据您的需求进行修改。

包含电池的数据传输对象

安装

您可以通过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

更改日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全性

如果您发现与安全相关的错误，请通过电子邮件发送至 security@spatie.be，而不是使用问题跟踪器。

明信片软件

您可以免费使用此包，但如果它进入您的生产环境，我们非常希望您能从您的家乡寄给我们一张明信片，说明您正在使用我们的哪个（些）包。

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

我们将公布所有收到的明信片在我们的公司网站上。

外部工具

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

鸣谢

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

许可证

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

acat / dto

维护者

详细信息