symfony 4序列化程序:反序列化请求并将其与客户端未完全传递的实体(包括关系)合并

2022-03-14 00:00:00 php symfony doctrine symfony4 entity

假设我有一个名为user的实体:

class User implements UserInterface
    /**
     * @ORMId()
     * @ORMGeneratedValue()
     * @ORMColumn(type="integer")
     */
     private $id;

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

     /**
     * @ORMOneToOne(targetEntity="AppEntityAddress", cascade={"persist", "remove"})
     * @ORMJoinColumn(nullable=false)
     */
    private $address;

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

class Address
{
    /**
     * @ORMId()
     * @ORMGeneratedValue()
     * @ORMColumn(type="integer")
     */
    private $id;

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

    /**
     * @ORMColumn(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

实体合并似乎不起作用。


解决方案

根据docs,

AbstractObjectNormalizer::DEEP_OBJECT_TO_POPULATE选项设置为true时,根OBJECT_TO_POPULATE的现有子项将从规范化数据中更新,而不是由去规格化程序重新创建它们。[.] (强调我的)

所以您必须设置一个额外的选项,因此您的行应该是:

    $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';

来源:https://github.com/symfony/symfony/blob/d8a026bcadb46c9955beb25fc68080c54f2cbe1a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php#L82

相关文章