Symfony中处理自引用实体与CollectionType表单的递归问题

本文旨在解决symfony框架中，使用collectiontype处理自引用（many-to-many）实体关系时可能出现的无限递归问题。通过引入一个独立的子表单类型来避免循环引用，并结合前端javascript动态管理表单原型，实现高效、可扩展的家族成员添加功能，确保表单渲染和数据提交的顺畅进行。

引言：自引用实体与Symfony表单的挑战

在开发复杂的应用程序时，我们经常会遇到实体之间存在自引用关系的情况。例如，一个“人”实体可能需要关联多个其他“人”实体作为其家族成员。在Symfony中，处理这种Many-to-Many自引用关系并将其呈现在表单中，尤其是需要动态添加（allow_add）新的关联实体时，会遇到一个常见的陷阱：无限递归。当CollectionType的entry_type被设置为其父表单类型本身时，Symfony在尝试渲染表单原型（prototype）时会陷入无限循环，导致内存溢出或超时。

实体定义：建立自引用关系

首先，我们定义一个Person实体，其中包含基本的个人信息，以及一个关键的自引用Many-to-Many关系myFamily。

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;

/**
 * @ORM\Entity(repositoryClass="App\Repository\PersonRepository")
 */
class Person
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

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

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

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $birthdayDate; // 实际项目中建议使用DateTimeInterface

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

    /**
     * @ORM\ManyToMany(targetEntity="Person")
     * @ORM\JoinTable(name="family",
     *      joinColumns={@ORM\JoinColumn(name="person_id", referencedColumnName="id")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="family_member_id", referencedColumnName="id")}
     * )
     */
    private $myFamily;

    public function __construct()
    {
        $this->myFamily = new ArrayCollection();
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getName(): ?string
    {
        return $this->name;
    }

    public function setName(string $name): self
    {
        $this->name = $name;
        return $this;
    }

    public function getFirstname(): ?string
    {
        return $this->firstname;
    }

    public function setFirstname(string $firstname): self
    {
        $this->firstname = $firstname;
        return $this;
    }

    public function getBirthdayDate(): ?string
    {
        return $this->birthdayDate;
    }

    public function setBirthdayDate(string $birthdayDate): self
    {
        $this->birthdayDate = $birthdayDate;
        return $this;
    }

    public function getGender(): ?string
    {
        return $this->gender;
    }

    public function setGender(string $gender): self
    {
        $this->gender = $gender;
        return $this;
    }

    /**
     * @return Collection|Person[]
     */
    public function getMyFamily(): Collection
    {
        return $this->myFamily;
    }

    public function addMyFamily(Person $person): self
    {
        if (!$this->myFamily->contains($person)) {
            $this->myFamily[] = $person;
        }
        return $this;
    }

    public function removeMyFamily(Person $person): self
    {
        $this->myFamily->removeElement($person);
        return $this;
    }
}

在myFamily属性中，@ORM\ManyToMany(targetEntity="Person")明确了这是一个指向Person实体自身的Many-to-Many关系。@ORM\JoinTable定义了中间表的名称及其连接列。

问题剖析：CollectionType的递归陷阱

最初，开发者可能会尝试在PersonType表单中直接使用PersonType::class作为myFamily字段的entry_type，期望通过allow_add实现动态添加家族成员。

// 错误的 PersonType 示例 (会导致无限递归)
namespace App\Form;

use App\Entity\Person;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Form\Extension\Core\Type\CollectionType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;

class PersonType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('name', TextType::class,  ['attr' => ['class' => 'form_textfield']])
            ->add('firstname')
            ->add('birthdayDate', TextType::class,  ['attr' => ['class' => 'form_datetime']])
            ->add('gender', GenderType::class) // 假设 GenderType 存在
            ->add('myFamily', CollectionType::class, [
                'entry_type' => PersonType::class, // <-- 问题所在：自引用导致无限递归
                'allow_add' => true,
                'allow_delete' => true,
                'by_reference' => false,
            ])
            ->add('submit', SubmitType::class);
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => Person::class,
        ]);
    }
}

当Symfony尝试为myFamily字段生成其“原型”（prototype）以供前端JavaScript克隆时，它会再次实例化一个PersonType。这个PersonType又包含一个myFamily字段，而这个字段的entry_type又是PersonType自身。这就形成了一个无限循环，导致PHP进程栈溢出，最终出现超时错误。

解决方案一：引入独立的子表单类型

解决无限递归的关键在于打破循环引用。我们可以为myFamily集合中的每个“成员”创建一个独立的、简化的表单类型。这个子表单类型仍然映射到Person实体，但它不包含myFamily字段，从而避免了递归。

表单大师AI

一款基于自然语言处理技术的智能在线表单创建工具，可以帮助用户快速、高效地生成各类专业表单。

74

查看详情

1. 创建ChildType表单：

   <?php
   
   namespace App\Form;
   
   use App\Entity\Person;
   use Symfony\Component\Form\AbstractType;
   use Symfony\Component\Form\FormBuilderInterface;
   use Symfony\Component\OptionsResolver\OptionsResolver;
   use Symfony\Component\Form\Extension\Core\Type\TextType;
   // use Symfony\Component\Form\Extension\Core\Type\SubmitType; // 通常子表单不需要自己的提交按钮
   
   class ChildType extends AbstractType
   {
       public function buildForm(FormBuilderInterface $builder, array $options): void
       {
           $builder
               ->add('name', TextType::class,  ['attr' => ['class' => 'form_textfield']])
               ->add('firstname')
               ->add('birthdayDate', TextType::class,  ['attr' => ['class' => 'form_datetime']])
               ->add('gender', GenderType::class); // 假设 GenderType 存在
               // 注意：这里不包含 myFamily 字段，避免递归
               // 通常子表单也不需要自己的 submit 按钮
       }
   
       public function configureOptions(OptionsResolver $resolver): void
       {
           $resolver->setDefaults([
               'data_class' => Person::class, // 仍然映射到 Person 实体
           ]);
       }
   }

   登录后复制

   ChildType表单只包含Person实体的基本信息字段，且不包含myFamily字段。

2. 更新PersonType表单： 现在，将PersonType中myFamily字段的entry_type修改为新创建的ChildType::class。

   <?php
   
   namespace App\Form;
   
   use App\Entity\Person;
   use Symfony\Component\Form\AbstractType;
   use Symfony\Component\Form\FormBuilderInterface;
   use Symfony\Component\OptionsResolver\OptionsResolver;
   use Symfony\Component\Form\Extension\Core\Type\CollectionType;
   use Symfony\Component\Form\Extension\Core\Type\TextType;
   use Symfony\Component\Form\Extension\Core\Type\SubmitType;
   
   class PersonType extends AbstractType
   {
       public function buildForm(FormBuilderInterface $builder, array $options): void
       {
           $builder
               ->add('name', TextType::class,  ['attr' => ['class' => 'form_textfield']])
               ->add('firstname')
               ->add('birthdayDate', TextType::class,  ['attr' => ['class' => 'form_datetime']])
               ->add('gender', GenderType::class) // 假设 GenderType 存在
               ->add('myFamily', CollectionType::class, [
                   'entry_type' => ChildType::class, // <-- 关键改变：使用 ChildType
                   'allow_add' => true,
                   'allow_delete' => true,
                   'by_reference' => false,
               ])
               ->add('submit', SubmitType::class);
       }
   
       public function configureOptions(OptionsResolver $resolver): void
       {
           $resolver->setDefaults([
               'data_class' => Person::class,
           ]);
       }
   }

   登录后复制

   通过这种方式，当Symfony为myFamily生成原型时，它会实例化ChildType，而ChildType不再包含myFamily字段，从而成功打破了递归链。

解决方案二：前端动态添加表单项

仅仅修改后端表单类型不足以实现动态添加功能，我们还需要通过前端JavaScript来克隆和插入新的表单项。这需要对Twig模板和JavaScript进行相应的调整。

1. Twig模板渲染： 在Twig模板中，我们需要渲染myFamily字段的现有项，并准备好一个data-prototype属性，其中包含了新表单项的HTML原型。

   {# templates/person/new.html.twig #}
   {% extends 'base.html.twig' %}
   
   {% block title %}创建新人物{% endblock %}
   
   {% block body %}
       <h1>创建人物及家族成员</h1>
   
       {{ form_start(form) }}
           {{ form_row(form.name) }}
           {{ form_row(form.firstname) }}
           {{ form_row(form.birthdayDate) }}
           {{ form_row(form.gender) }}
   
           <h3>家族成员</h3>
           <ul class="myFamily"
               data-index="{{ form.myFamily|length > 0 ? form.myFamily|last.vars.name + 1 : 0 }}"
               data-prototype="{{ form_widget(form.myFamily.vars.prototype)|e('html_attr') }}">
               {# 渲染已有的家族成员 #}
               {% for familyMemberForm in form.myFamily %}
                   <li>
                       {{ form_row(familyMemberForm.name) }}
                       {{ form_row(familyMemberForm.firstname) }}
                       {{ form_row(familyMemberForm.birthdayDate) }}
                       {{ form_row(familyMemberForm.gender) }}
                       {# 添加删除按钮等操作 #}
                   </li>
               {% endfor %}
           </ul>
           <button type="button" class="add_item_link" data-collection-holder-class="myFamily">添加家族成员</button>
   
           {{ form_end(form) }}
   {% endblock %}
   
   {% block javascripts %}
       {{ parent() }}
       <script>
           // 动态添加表单项的JavaScript代码
           const addFormToCollection = (e) => {
               const collectionHolder = document.querySelector(
                   "." + e.currentTarget.dataset.collectionHolderClass
               );
   
               const item = document.createElement("li");
   
               // 获取原型并替换 __name__ 占位符为当前索引
               item.innerHTML = collectionHolder.dataset.prototype.replace(
                   /__name__/g,
                   collectionHolder.dataset.index
               );
   
               collectionHolder.appendChild(item);
   
               // 更新索引
               collectionHolder.dataset.index++;
           };
   
           document
               .querySelectorAll(".add_item_link")
               .forEach((btn) => btn.addEventListener("click", addFormToCollection));
       </script>
   {% endblock %}

   登录后复制
   • data-prototype: 这是实现动态添加的核心。form_widget(form.myFamily.vars.prototype)|e('html_attr')会渲染myFamily字段的单个子表单的HTML结构，并将其作为字符串存储在ul元素的data-prototype属性中。|e('html_attr')是必要的，它会正确转义HTML，以便将其安全地存储在HTML属性中。
   • data-index: 这个属性用于跟踪当前集合中元素的数量，以便为新添加的表单项生成唯一的名称（例如person[myFamily][0][name]，person[myFamily][1][name]等）。
   • __name__: 在原型中，Symfony会使用__name__作为占位符。JavaScript会将其替换为当前的data-index值。

2. JavaScript实现动态添加： 上述Twig模板中的JavaScript代码负责监听“添加家族成员”按钮的点击事件。当按钮被点击时：

   • 它获取data-prototype中的HTML原型。
   • 将原型中的__name__占位符替换为当前的data-index值，生成一个带有唯一名称的新表单项HTML。
   • 将新生成的表单项插入到ul.myFamily元素中。
   • 递增data-index，为下一个新表单项做准备。

注意事项与总结

1. 子表单类型的设计： ChildType应该只包含集合项所需的字段，避免包含可能导致再次递归的字段（

以上就是Symfony中处理自引用实体与CollectionType表单的递归问题的详细内容，更多请关注php中文网其它相关文章！