原则2:禁用延迟加载/代理生成。

时间:2015-01-12 16:45:55

标签: symfony doctrine-orm doctrine jmsserializerbundle jms-serializer

使用Doctrine 2,是否可以:

  • 从生成的代理类中排除某个属性?
  • 完全禁用延迟加载/代理生成?

我在序列化我的实体时遇到问题(使用Symfony和JMS Serializer)。我想只序列化我在查询中显式获取的关联实体。

f.e中描述的解决方案。 Disable Doctrine 2 lazy loading when using JMS Serializer?只是部分工作。当您拥有虚拟财产时:

use Doctrine\ORM\Mapping as ORM;
use JMS\Serializer\Annotation as Serializer;

/**
 * Profile
 *
 * @ORM\Table(name="profile")
 * @ORM\Entity
 */
class Profile
{
    // ...

    /**
     * @return string
     *
     * @Serializer\VirtualProperty()
     */
    public function getLabel()
    {
        return implode(' ', [$this->firstname, $this->lastname]) . " ({$this->email})";
    }
}

关联的类仍然在序列化过程中通过代理加载。

2 个答案:

答案 0 :(得分:3)

这是我迄今为止提出的解决上述问题的最佳解决方案。它不涉及更改JMSSerializer代码。完整代码在这个要点: https://gist.github.com/Jaap-van-Hengstum/0d400ea4f986d8f8a044

诀窍是创建一个空的“假”类:

namespace MyApp\ApiBundle\Serializer;

class SerializerProxyType
{
  // this class is supposed to be empty
}

并在自定义DoctrineProxySubscriber中,将事件类型设置为该类。这样JMSSerializer将使用该类型进行注释处理,因此在遇到@VirtualProperty等注释时不会触发Doctrine代理。

class DoctrineProxySubscriber implements EventSubscriberInterface
{
    public function onPreSerialize(PreSerializeEvent $event)
    {
        $object = $event->getObject();
        $type = $event->getType();

        ...
        // This line is commented, so proxy loading on serializing is disabled
        // $object->__load();

        if ( ! $virtualType) {
            // This line is commented because a different type is used
            // $event->setType(get_parent_class($object));

            // This assumes that every Doctrine entity has a single 'Id' primary
            // key field.
            $event->setType('MyApp\ApiBundle\Serializer\SerializerProxyType',
                ["id" => $object->getId()]);
        }
    }

    public static function getSubscribedEvents()
    {
        return array(
            array('event' => 'serializer.pre_serialize', 'method' => 'onPreSerialize'),
        );
    }
}

然后,您可以使用JMSSerializer处理程序为空类添加自定义处理程序。此处理程序将只包含序列化json / xml中的实体ID:

class DoctrineProxyHandler implements SubscribingHandlerInterface
{
    /**
     * {@inheritdoc}
     */
    public static function getSubscribingMethods()
    {
        $methods = [];

        foreach (array('json', 'xml') as $format)
        {
            $methods[] = [
                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
                'format' => $format,
                'type' => 'MyApp\\ApiBundle\\Serializer\\SerializerProxyType',
                'method' => 'serializeTo' . ucfirst($format),
            ];
        }

        return $methods;
    }

    public function serializeToJson(VisitorInterface $visitor, $entity, array $type, Context $context)
    {
        $object = new \stdClass();
        $object->id = $type['params']['id'];

        return $object;
    }

    public function serializeToXml(XmlSerializationVisitor $visitor, $entity, array $type, Context $context)
    {
        $visitor->getCurrentNode()->appendChild(
            $node = $visitor->getDocument()->createElement('id', $type['params']['id'])
        );

        return $node;
    }
}

配置Symfony以使用这些类:

parameters:
    jms_serializer.doctrine_proxy_subscriber.class: MyApp\ApiBundle\Serializer\DoctrineProxySubscriber

services:
  doctrineproxy_handler:
    class: MyApp\ApiBundle\Serializer\DoctrineProxyHandler
    tags:
        - { name: jms_serializer.subscribing_handler }

答案 1 :(得分:1)

我认为这是JMSSerializer中长期存在的错误。在生成代理/对象时,Doctrine实际上做得相当不错。在一个实例中,我编辑了JMSSerializer源,以禁用从代理加载对象。我总觉得很烦人。

可能的解决方法#1:在序列化之前设置NULL值。您将丢失代理参考以供进一步使用,是的,它非常难看,但它确实起作用。

可能的解决方法#2:我可能错了,但我觉得JMSSerializer的开发已经停滞不前。您可以将项目分支到您自己的GitHub,禁用执行提取的行并改为使用您自己的fork。