为许多php支持的枚举自动实现JMS序列化

4szc88ey  于 2022-11-21  发布在  PHP
关注(0)|答案(1)|浏览(111)

上下文

通过使用JMS serializer library,我需要序列化/反序列化由php支持的枚举内部表示的数据。

有什么问题

我通过使用SubscribingHandlerInterface接口找到了一个解决方案,但我希望通过删除(如果可能的话)一个样板类来简化该过程,* 必须为每个新枚举 * 创建该样板类。

实际工作代码,待简化

  • 示例枚举:
<?php

namespace App\Enum;

enum MyEnum: string
{
    case Hello = 'hello';
    case World = 'world';
}
  • 这个抽象类是为了最大限度地减少最终类(我想“删除”的类)的冗余代码:
<?php

namespace App\Serializer;

use JMS\Serializer\GraphNavigator;
use JMS\Serializer\Handler\SubscribingHandlerInterface;
use JMS\Serializer\JsonDeserializationVisitor;
use JMS\Serializer\SerializationContext;
use JMS\Serializer\Visitor\SerializationVisitorInterface;
use LogicException;

abstract class AbstractEnumSerializer implements SubscribingHandlerInterface
{
    public static function getEnumClass(): string
    {
        throw new LogicException("Please implement this");
    }

    public static function getSubscribingMethods(): array
    {
        return [
            [
                'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
                'format' => 'json',
                'type' => static::getEnumClass(),
                'method' => 'deserializeFromJSON',
            ], [
                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
                'format' => 'json',
                'type' => static::getEnumClass(),
                'method' => 'serializeToJSON',
            ],
        ];
    }

    public function deserializeFromJSON(JsonDeserializationVisitor $visitor, $data, array $type)
    {
        return static::getEnumClass()::tryFrom($data);
    }

    public function serializeToJSON(
        SerializationVisitorInterface $visitor,
        $enum,
        array $type,
        SerializationContext $context
    ): string
    {
        return $enum->value;
    }
}

这是我想要“删除”的类,通过选择某种自动生成/注册:它实现了上述示例枚举的串行化(反串行化),但它是样板代码, 每个新枚举都需要 *:

<?php

namespace App\Serializer;

use App\Enum\MyEnum;

class MyEnumSerializer extends AbstractEnumSerializer
{
    public static function getEnumClass(): string
    {
        return MyEnum::class;
    }
}

问题

让我们想象一下,许多php支持的枚举必须被序列化(反序列化);是否可以通过优先选择某种自动生成/注册来避免为每个枚举编写MyEnumSerializer类?
主要目标是保持添加新的支持枚举的简单性,同时自动为它们实现JMS序列化/反序列化。

0pizxfdo

0pizxfdo1#

这是一个很有技巧的方法,但至少对于作为对象属性的支持枚举的反序列化是有效的。

public function deserializeEnum(
    JsonDeserializationVisitor $visitor,
    $value, 
    array $type,
    Context $context
) {
    $targetProperty = new ReflectionProperty(
        $visitor->getCurrentObject()::class,
        $context->getCurrentPath()[
            array_key_last($context->getCurrentPath())
        ]
    );
    $targetPropertyType = $targetProperty->getType()->getName();
    $targetPropertyNullable = $targetProperty->getType()->allowsNull();

    if ($value === null && $targetPropertyNullable) {
        return null;
    }

    return $targetPropertyType::from($value);
}

相关问题