spatie/laravel-data的WithCast验证错误排查

问题描述 #

通过WithCast特性将字符串转换为继承自Data的Address对象时，调用validateAndCreate方法触发验证错误，提示：
"address_val字段必须是数组。"

复现代码 #

AlbumData 类 #

class AlbumData extends Data
{
    public string $title;
    #[WithCast(AddressCast::class)]
    public ?Address $address_val;
    
}

调用逻辑 #

try {
    AlbumData::validateAndCreate([
        'title' => 'Never Gonna Give You Up',
        'address_val' => 'Never Gonna Give You Up',
    ]);
} catch (ValidationException  $exception) {
    dump($exception->validator->errors()->all());
    dd($exception->getMessage());
}

关联类代码 #

class Address extends Data
{
    public function __construct(
        public ?string $text,
    ) {}
}

class AddressCast implements Cast
{
    public function cast(DataProperty $property, mixed $value, array $properties, CreationContext $context): Address
    {
        return new Address($value);
    }
}

特殊现象 #

• 使用from方法替代validateAndCreate时无错误，运行正常；
• 当Address不继承Data类时也可正常运行。

问题原因 #

当字段类型为继承自Data的类时，laravel-data会自动为该字段生成数组类型的验证规则——框架默认认为Data类型的字段需要接收符合其结构的数组数据。而你通过WithCast想要直接将字符串转换为Address对象，此时默认验证规则与转换逻辑冲突，触发了验证错误。

• 使用from方法时，框架不会自动执行验证流程，因此不会触发错误；
• 当Address不继承Data时，框架无法识别这是一个Data类型，不会生成默认的数组验证规则，因此转换逻辑可以正常运行。

解决方案 #

手动为address_val字段指定验证规则，覆盖框架默认的数组规则，明确允许字符串类型：

修改后的AlbumData类 #

use Spatie\LaravelData\Attributes\Validation\StringType;

class AlbumData extends Data
{
    public string $title;
    
    #[WithCast(AddressCast::class)]
    #[StringType] // 添加字符串验证规则，覆盖默认数组规则
    public ?Address $address_val;
    
}

如果需要支持多种输入类型（比如字符串或符合Address结构的数组），可以组合多个验证规则：

use Spatie\LaravelData\Attributes\Validation\NullableType;
use Spatie\LaravelData\Attributes\Validation\StringType;
use Spatie\LaravelData\Attributes\Validation\ArrayType;

class AlbumData extends Data
{
    public string $title;
    
    #[WithCast(AddressCast::class)]
    #[NullableType]
    #[StringType, ArrayType] // 允许字符串或数组类型
    public ?Address $address_val;
    
}

修改后，validateAndCreate会先验证输入符合指定类型，再通过AddressCast完成转换，即可避免验证错误。

内容的提问来源于stack exchange，提问作者EnikiBeniki