序列化器 Symfony 的回调

Question

我正在运行 Symfony 2.7，我正在尝试将对象（Doctrine 实体）输出为 JSON。

当我规范化对象时，我想转换它的一些值。为此，我在the documentation 中找到了“setCallbacks”方法，但我对如何将其应用到我的案例中感到有些困惑。

有什么方法可以在调用 Symfonys 序列化服务时设置的规范化器上调用“setCallbacks”方法？

这是我想要实现的一个简短示例：

//ExampleController.php

public function getJSONOrderByIdAction($id) {
    $serializer = $this->get('serializer');
    $normalizer = $serializer->getNormalizer(); // <- This is what I'm unable to do

    $dateTimeToString = function ($dateTime) {
        return $dateTime instanceof \DateTime ? $dateTime->format(\DateTime::ISO8601) : '';
    };

    $normalizer->setCallbacks(['time' => $dateTimeToString]);


    $order = $this->getDoctrine()->find("AppBundle:Order", $id);

    return new JsonResponse(["order" => $serializer->normalize($order, null, ["groups" => ["public"]])]);
}

我知道大多数人已经切换到 JMS 序列化程序。似乎内置的序列化程序应该能够处理我想要实现的目标。

Answer 1

默认的 Serializer 服务是在依赖注入阶段创建的，并且 Serializer 接口不允许编辑（完整）检索规范化器。

我认为您在这里（至少）有三个选择：

1. 将您的自定义规范器添加到默认的序列化器服务
2. 为您的实体添加 NormalizableInterface
3. 按照您的尝试创建一个新的 Serializer 服务（或文档建议的本地对象）。

我认为在您的场景中，案例 1 是首选（因为 2 很快就会变得无聊）。

我会做这样的事情；首先创建一个自定义 Normalizer

<?php
namespace AppBundle; 

class DateTimeNormalizer extends SerializerAwareNormalizer implements NormalizerInterface, DenormalizerInterface
{
    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = null, array $context = array())
    {
        return $object->format(\DateTime::ISO8601);
    }

    /**
     * {@inheritdoc}
     */
    public function denormalize($data, $class, $format = null, array $context = array())
    {
        return new $class($data);
    }

    /**
     * Checks if the given class is a DateTime.
     *
     * @param mixed  $data   Data to normalize.
     * @param string $format The format being (de-)serialized from or into.
     *
     * @return bool
     */
    public function supportsNormalization($data, $format = null)
    {
        return $data instanceof \DateTime;
    }

    /**
     * Checks if the given class is a DateTime.
     *
     * @param mixed  $data   Data to denormalize from.
     * @param string $type   The class to which the data should be denormalized.
     * @param string $format The format being deserialized from.
     *
     * @return bool
     */
    public function supportsDenormalization($data, $type, $format = null)
    {
        $class = new \ReflectionClass($type);

        return $class->isSubclassOf('\DateTime');
    }
}

然后将其注册到您的服务中：

# app/config/services.yml
services:
    datetime_normalizer:
        class: AppBundle\DateTimeNormalizer
        tags:
            - { name: serializer.normalizer }

Answer 2

我自己的解决方案

按照 giosh94mhz 的建议，我尝试切换到 JMS 序列化器，但最终又回到了 Symfonys 序列化器。

JMS Serializer 提出了它自己的问题，在为那些寻找答案的过程中，我偶然发现了 blog post by Thomas Jarrand，它很好地解释了如何在 Symfony 中和实现您自己的规范化器。

Answer 3

您可以使用 K. Dunglas 组件的回调规范器。

你可以在 ObjectNormalizer 中看到（在 normalize 方法中）

if (isset($this->callbacks[$attribute])) {
    $attributeValue = call_user_func($this->callbacks[$attribute], $attributeValue);
 }

这意味着您必须在回调数组键中使用您不想规范化的属性名称。

例如，在我的实体中，我有一个名为“名称”的字段，类型为“pgarray”（如 postgresql 的数组）。我不想规范化这些数据。我想要一个字符串而不是数组。

/**
     * $object represent the property "name" because callback is attached to name property (setCallback)
     */
    $nameCallback = function ($object, $outerObject = null) {
        return $object[0];      
    };
    $this->normalizer->setCallbacks(['name' => $dateCallback]);

请记住，从 Symfony 4.2 开始，您必须在 DI 中使用 $context 才能使用回调。

Answer 4

在我看来，您似乎试图使事情变得过于复杂。这是我需要将实体序列化为 JSON 时采用的方法：

PHP 2.5 及更高版本允许您在对象上实现jsonSerialize 方法，只需直接在对象上调用json_encode。

如果您仍在使用 PHP 2.4，您只需在您的对象上手动调用 jsonSerialize()。

例如：

/**
 * @ORM\Entity
 */
class MyEntity {
    ...
    public function jsonSerialize() {
        $data = array("foo" => $this->bar());
        // add other data here ...
        return $data
    }
}

然后在调用代码中：

// for PHP 2.5 and up:
$normalized = json_encode($myEntityInstance);

// for PHP 2.4 and below
$normalized = json_encode($myEntityInstance->jsonSerialize());