README

安装

您可以通过composer安装此包

composer require spatie/data-transfer-object

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

支持我们

我们投入了大量资源来创建最佳开源包。您可以通过购买我们的付费产品之一来支持我们。

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

用法

此包的目标是使从（序列化）数据数组构建对象尽可能简单。以下是DTO的样子

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;
}

您可以这样构建这个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实现就是一个例子

class ArrayCaster implements Caster
{
    public function __construct(
        private string $type,
        private string $itemType,
    ) {
    }

    public function cast(mixed $value): array|ArrayAccess
    {
        if ($this->type == 'array') {
            return $this->castArray($value);
        }

        if (is_subclass_of($this->type, ArrayAccess::class)) {
            return $this->castArrayAccess($value);
        }

        throw new LogicException("Caster [ArrayCaster] may only be used to cast arrays or objects that implement ArrayAccess.");
    }

    private function castArray(mixed $value): array
    {
        return array_map(
            fn(array $data) => new $this->itemType(...$data),
            $value
        );
    }

    private function castArrayAccess(mixed $value): ArrayAccess
    {
        $arrayAccess = new $this->type();

        array_walk(
            $value,
            fn(array $data) => $arrayAccess[] = new $this->itemType(...$data)
        );

        return $arrayAccess;
    }
}

请注意，您不需要使用命名参数来传递输入作为通用转换器参数，尽管它们确实使其更清晰

    /** @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();
    }
}

严格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

变更日志

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

贡献

请参阅贡献以获取详细信息。

安全

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

明信片软件

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

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

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

外部工具

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

鸣谢

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

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

roke22 / data-transfer-object

维护者

详细信息