如何使用来自非托管实体的数据正确更新托管实体?

How to properly update a managed entity using data from a non-managed entity?

上下文

我的目标是使用来自相同 class 但不受 Doctrine 管理的对象的数据对托管实体执行更新。

如果可以在替换属性时执行 "simple update",这会很酷,但实际上,如果我清理 ArrayCollection,旧数据似乎不会被删除(即使我从 ArrayCollection 的元素中清除 fiddle 的所有引用,或者如果 orphanRemoval 设置为 true)。

但是让我们进入一个具体的例子。我有 this entity with lots of OneToOne / OneToMany relations to represent a fiddle。我可以使用 Symfony2 命令导入 fiddle 样本(之前从另一个环境导出为 json)。

如果示例已经存在,我该如何正确更新它?

坏主意:执行 DELETE + INSERT

我使用以下代码(简化)构建我的实体:

$fiddle = new Fiddle();
$fiddle->setHash($this->get($json, 'hash'));
$fiddle->setRevision($this->get($json, 'revision'));

$context = $fiddle->getContext();
$context->setFormat($this->get($json, 'context', 'format'));
$context->setContent($this->get($json, 'context', 'content'));

$fiddle->clearTemplates();
$jsonTemplates = $this->get($json, 'templates') ? : array ();
foreach ($jsonTemplates as $jsonTemplate)
{
    $template = new FiddleTemplate();
    $template->setFilename($this->get($jsonTemplate, 'filename'));
    $template->setContent($this->get($jsonTemplate, 'content'));
    $template->setIsMain($this->get($jsonTemplate, 'is-main'));
    $fiddle->addTemplate($template);
}

// ...

如果我的实体已经存在,我现在可以在删除它后保留它:

    $check = $this
       ->getContainer()
       ->get('doctrine')
       ->getRepository('FuzAppBundle:Fiddle')
       ->getFiddle($fiddle->getHash(), $fiddle->getRevision());

    if (!is_null($check->getId()))
    {
        $em->remove($check);
        $em->flush();
    }

    $em->persist($fiddle);
    $em->flush();

但是如果样本已经存在,这将创建一个 DELETE + INSERT 而不是 UPDATE。这很奇怪,因为用户可以为 fiddle 添加书签,并且关系是由 id 建立的。

丑陋的想法:对主实体和 OneToOne 关系进行更新,并对 OneToMany 关系进行 DELETE + INSERT

我先得到我的fiddle,如果它已经存在,我清理它并用新数据填充它...代码运行良好但真的很丑, 可以查看here.

作为示例,查看 tags 属性:由于标签可能已被删除/更改,我应该正确设置新标签,将旧标签替换为新标签。

// remove the old tags
foreach ($fiddle->getTags() as $tag)
{
   if (\Doctrine\ORM\UnitOfWork::STATE_MANAGED === $em->getUnitOfWork()->getEntityState($tag))
   {
      $em->remove($tag);
      $em->flush();
   }
}

// set the new tags
$tags = new ArrayCollection();
$jsonTags = $this->getFromArray($json, 'tags');
foreach ($jsonTags as $jsonTag)
{
   $tag = new FiddleTag();
   $tag->setTag($jsonTag);
   $tags->add($tag);
}
$fiddle->setTags($tags);

由于使用 fiddle 的 id 引用标签,我可以使用 ->remove,即使那很丑。这在这里没问题,但如果 id 是自动生成的,则必须有更好的解决方案。

我也试过简单地将旧的fiddle的id设置为新的并合并,但这导致了以下异常:

[Symfony\Component\Debug\Exception\ContextErrorException]  
Notice: Undefined index: 00000000125168f2000000014b64e87f

赏金?

不仅仅是一个简单的 "import feature",我想使用这种更新样式将表单绑定到非托管实体并仅在需要时更新现有实体。所以我的目标是让一些通用的东西适用于所有类型的实体。

但我当然不期望整个代码。处理托管 ArrayCollection 更新的良好做法,以及一些 hints/warnings 关于我在编写此功能之前应该考虑的内容应该足够了。

控制 Doctrine 坚持的东西

Update existing entities only if required.

这可以通过 Doctrine 相当简单地实现:

您正在寻找的是更改跟踪政策Deferred Explicit

Doctrine 默认使用更改跟踪策略 Deferred Implicit。这意味着当您调用 $em->flush() 时,Doctrine 将遍历其托管实体的 所有 来计算变更集。然后保留所有更改。

当使用更改跟踪策略 Deferred Explicit 并调用 $em->flush() 时,Doctrine 将 遍历您明确调用的实体 $em->persist() 在。换句话说:你可能有数千个托管实体,其中 2 个被称为 $em->persist(),而 Doctrine 将只计算这 2 个的变更集(并在需要时持久化变更)。

可以在实体-class 级别上设置更改跟踪策略。因此,如果您希望某个实体 class 使用 Deferred Explicit,只需在 class 文档块中添加注释:

/**
 * @Entity
 * @ChangeTrackingPolicy("DEFERRED_EXPLICIT")
 */
class Fiddle
{

那么只需要在真正需要的时候调用 $em->persist($fiddle) 即可。

为整个聚合(根实体及其所有子实体)设置相同的更改跟踪策略可能是明智的。

PS:还有一个名为 Notify 的第三个更改跟踪策略,它的设置工作有点多,但可以让您更精细地控制调用 $em->flush()。但我认为你不需要走到这一步。

正在更新 Fiddle

看到您用来更新 Fiddle 实体的代码,我认为您可以在那里改进一些东西。

首先将管理协会的责任移回实体:

/**
 * @Entity
 * @ChangeTrackingPolicy("DEFERRED_EXPLICIT")
 */
class Fiddle
{
    // ...

    /**
     * @return FiddleTag[]
     */
    public function getTags()
    {
        return $this->tags->toArray();
    }

    /**
     * @param FiddleTag $tag
     */
    public function addTag(FiddleTag $tag)
    {
        if (!$this->tags->contains($tag)) {
            $this->tags->add($tag);
            $tag->setFiddle($this);
        }
    }

    /**
     * @param FiddleTag $tag
     */
    public function removeTag(FiddleTag $tag)
    {
        if ($this->tags->contains($tag)) {
            $this->tags->removeElement($tag);
            $tag->setFiddle(null);
        }
    }

    /**
     * @param FiddleTag[] $newTags
     */
    public function replaceTags(array $newTags)
    {
        $currentTags = $this->getTags();

        // remove tags that are not in the new list of tags
        foreach ($currentTags as $currentTag) {
            if (!in_array($currentTag, $newTags, true)) {
                $this->removeTag($currentTag);
            }
        }

        // add tags that are not in the current list of tags
        foreach ($newTags as $newTag) {
            if (!in_array($newTag, $currentTags, true)) {
                $this->addTag($newTag);
            }
        }
    }

    // ...
}

现在您的 ImportCommand 中的代码可以如下所示:

$jsonTags = $this->getFromArray($json, 'tags');
$newTags  = [];

foreach ($jsonTags as $jsonTag) {
    $tag = $tagRepo->findOneByTag($jsonTag);

    if ($tag === null) {
        $tag = new FiddleTag();
        $tag->setTag($jsonTag);
    }

    $newTags[] = $tag;
}

$fiddle->replaceTags($newTags);

然后当一切正常,可以持久化后,做:

$em->persist($fiddle);

foreach ($fiddle->getTags() as $tag) {
    $em->persist($tag);
}

$em->flush();

在关联上配置 cascade=persist 后,您应该能够省去手动保留标签的循环。

专业提示

您可以查看将其集成到 Symfony 中的 JMS Serializer library, and the Bundle