JMS Serializer处理数组类型属性的问题解析

2025-07-02 05:54:29作者：吴年前Myrtle

问题背景

在使用JMS Serializer进行JSON反序列化时，开发者遇到了一个关于数组类型属性的问题。具体表现为当模型类中包含数组类型的属性时，反序列化会抛出"必须为属性定义类型"的错误，即使已经通过注解明确指定了类型信息。

问题复现

考虑以下用户模型类定义：

class User
{
    /**
     * @var string|null
     * @SerializedName("email")
     * @Assert\NotNull()
     * @Assert\Type("string")
     * @Type("string")
     */
    protected ?string $email = null;

    /**
     * @var string[]|null
     * @SerializedName("roles")
     * @Assert\NotNull()
     * @Assert\All({
     *   @Assert\Type("string")
     * })
     * @Type("array<string>")
     */
    protected ?array $roles = null;
}

当尝试反序列化包含roles数组的JSON数据时：

$jsonData = '{
    "email":"test@serializer.com",
    "roles": ["ROLE_ADMIN"]
}';

$myUser = $serializer->deserialize($jsonData, User::class, "json");

系统会抛出错误："You must define a type for App\Model\User::$roles"。

问题根源

这个问题的根本原因在于JMS Serializer的TypedPropertiesDriver默认不支持数组类型。TypedPropertiesDriver是用于从PHP类型声明中提取类型信息的驱动，其内部维护了一个允许的基本类型列表：

[
    'int', 'float', 'bool', 'boolean', 
    'string', 'double', 'iterable', 'resource'
]

由于"array"不在这个默认允许列表中，当遇到数组类型的属性时，TypedPropertiesDriver无法正确处理，导致类型信息缺失的错误。

解决方案

方案一：使用自定义驱动工厂

开发者可以创建自定义的驱动工厂，扩展TypedPropertiesDriver以支持数组类型：

class CustomDriverFactory implements DriverFactoryInterface
{
    public function createDriver(array $metadataDirs, Reader $annotationReader)
    {
        $driver = new AnnotationDriver($annotationReader, $metadataDirs);
        return new TypedPropertiesDriver($driver, new TypeParser(), ['array']);
    }
}

然后在构建序列化器时使用这个自定义工厂：

$serializer = SerializerBuilder::create()
    ->setMetadataDriverFactory(new CustomDriverFactory())
    ->build();

方案二：迁移到PHP原生属性

JMS Serializer官方推荐的做法是迁移到PHP原生属性(Attributes)而非注解(Annotations)。使用原生属性可以更好地与现代PHP特性集成，避免一些注解解析的问题。

将上述模型类改写为使用属性：

use JMS\Serializer\Annotation as Serializer;
use Symfony\Component\Validator\Constraints as Assert;

class User
{
    #[Serializer\SerializedName('email')]
    #[Assert\NotNull]
    #[Assert\Type('string')]
    #[Serializer\Type('string')]
    protected ?string $email = null;

    #[Serializer\SerializedName('roles')]
    #[Assert\NotNull]
    #[Assert\All([new Assert\Type('string')])]
    #[Serializer\Type('array<string>')]
    protected ?array $roles = null;
}