Symfony CollectionType 添加元素为空的解决方法

本文旨在解决在使用 Symfony 的 CollectionType 处理关联实体时，新增实体关联字段为空的问题。通过修改 CollectionType 的 by_reference 选项，强制 Symfony 调用实体自身的添加方法，从而确保关联关系的正确建立，避免数据库外键约束冲突。

在使用 Symfony 的 CollectionType 处理一对多关系时，经常会遇到新增子实体后，子实体的关联字段（通常是外键）为空的情况，导致数据库报错。这通常是由于 Symfony 的 CollectionType 默认行为导致的。

假设我们有一个 Classroom 实体，它与多个 Student 实体存在一对多关系，一个学生只属于一个教室。在 Classroom 的表单中，我们使用 CollectionType 来管理学生列表。

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Extension\Core\Type\CollectionType;

class ClassroomType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name')
            ->add('students', CollectionType::class, [
                'entry_type' => StudentType::class,
                'allow_add' => true,
                'allow_delete' => true,
            ]);
    }
}

同时，在 Classroom 实体中，我们定义了与 Student 实体的一对多关联，并设置了级联持久化：

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

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

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

    /**
     * @ORM\OneToMany(targetEntity=Student::class, mappedBy="classroom", orphanRemoval=true, cascade={"persist"})
     */
    private $students;

    public function __construct()
    {
        $this->students = 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;
    }

    /**
     * @return Collection|Student[]
     */
    public function getStudents(): Collection
    {
        return $this->students;
    }

    public function addStudent(Student $student): self
    {
        if (!$this->students->contains($student)) {
            $this->students[] = $student;
            $student->setClassroom($this);
        }

        return $this;
    }

    public function removeStudent(Student $student): self
    {
        if ($this->students->removeElement($student)) {
            // set the owning side to null (unless already changed)
            if ($student->getClassroom() === $this) {
                $student->setClassroom(null);
            }
        }

        return $this;
    }
}

尽管我们设置了级联持久化，并且在 Classroom 实体中定义了 addStudent 方法来维护关联关系，但在新增学生时，Student 实体的 classroom_id 字段仍然可能为空，导致数据库报错。

这是因为 CollectionType 默认情况下将 by_reference 选项设置为 true。这意味着 Symfony 直接操作集合，而不是调用实体自身的 addStudent 和 removeStudent 方法。因此，关联关系没有被正确设置。

解决方案：

将 CollectionType 的 by_reference 选项设置为 false，强制 Symfony 调用实体自身的添加和删除方法。

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Extension\Core\Type\CollectionType;

class ClassroomType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name')
            ->add('students', CollectionType::class, [
                'entry_type' => StudentType::class,
                'allow_add' => true,
                'allow_delete' => true,
                'by_reference' => false, // 设置 by_reference 为 false
            ]);
    }
}

通过将 by_reference 设置为 false，Symfony 将会调用 Classroom 实体中的 addStudent 方法，从而正确地设置 Student 实体的 classroom 属性，避免了数据库外键约束冲突。

总结：

在使用 Symfony 的 CollectionType 处理一对多关系时，如果遇到新增子实体关联字段为空的问题，可以通过将 by_reference 选项设置为 false 来解决。这可以确保实体自身的添加和删除方法被调用，从而正确地维护关联关系。同时，确保实体中定义了 add 和 remove 方法，并且在这些方法中维护双向关联关系。