Symfony 4 Serializer：反序列化请求并将其与实体合并，包括客户端未完全传递的关系

Question

假设我有一个名为用户的实体：

class User implements UserInterface
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
     private $id;

    /**
     * @ORM\Column(type="string", length=255, nullable=false)
     */
     private $username;

     /**
     * @ORM\OneToOne(targetEntity="App\Entity\Address", cascade={"persist", "remove"})
     * @ORM\JoinColumn(nullable=false)
     */
    private $address;

地址字段与地址实体是一对一关系：

class Address
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $street;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $name;

我有一个用于更新用户及其地址的控制器：

...
 public function putUserSelf(Request $request)
    {
        $em = $this->getDoctrine()->getManager();
        $user = $this->getUser();

        $encoders = array(new JsonEncoder());
        $normalizers = array(new ObjectNormalizer(null, null, null, new ReflectionExtractor()));

        $serializer = new Serializer($normalizers, $encoders);
        $user = $serializer->deserialize($request->getContent(), User::class, "json", ['deep_object_to_populate' => $user]);
        $em->persist($user);
        $em->flush();

理论上我现在应该可以像这样传递 json：

{
    "username": "foo",
    "address": {"name": "bar"}
}

更新我的实体。但问题是，我收到 sql 错误：

An exception occurred while executing 'INSERT INTO address (street, name) VALUES (?, ?)' with params [null, "bar"]:

SQLSTATE[23000]: Integrity constraint violation: 1048 Column 'street' cannot be null

似乎实体合并没有成功。

Answer 1

根据 docs、

When the AbstractObjectNormalizer::DEEP_OBJECT_TO_POPULATE option is set to true, existing children of the root OBJECT_TO_POPULATE are updated from the normalized data, instead of the denormalizer re-creating them. [...] (emphasis mine)

所以你必须设置一个 extra 选项，所以你的行应该是：

    $user = $serializer->deserialize($request->getContent(), User::class, "json", [
        'object_to_populate' => $user, // this still needs to be set, without the "deep_"
        'deep_object_to_populate' => true,
    ]);

具体组件的源代码中有一些额外的注释：

/**
 * Flag to tell the denormalizer to also populate existing objects on
 * attributes of the main object.
 *
 * Setting this to true is only useful if you also specify the root object
 * in OBJECT_TO_POPULATE.
 */
public const DEEP_OBJECT_TO_POPULATE = 'deep_object_to_populate';
source: https://github.com/symfony/symfony/blob/d8a026bcadb46c9955beb25fc68080c54f2cbe1a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php#L82

Symfony 4 Serializer：反序列化请求并将其与实体合并，包括客户端未完全传递的关系

Symfony 4 Serializer: deserializing request and merging it with entity including relation that is not completely passed by client

php

entity

doctrine

symfony

symfony4