Doctrine ManyToMany 映射：处理带共享属性的连接表与复合主键

当doctrine的manytomany关系连接表包含共享属性或复合主键时，直接映射可能导致插入错误。本文将深入探讨此问题，并提供解决方案：将连接表显式定义为一个独立实体，通过onetomany/manytoone关系进行关联。这种方法能确保对连接表结构和复合键的完全控制，避免重复属性插入，并增强数据模型的灵活性和准确性。

引言：Doctrine ManyToMany 关系与连接表

在关系型数据库中，多对多（ManyToMany）关系是一种常见的数据关联模式，例如“一个商品可以属于多个订单，一个订单可以包含多个商品”。为了在数据库中实现这种关系，通常会引入一个中间表，也称为连接表（Join Table），它至少包含两个外键，分别指向参与ManyToMany关系的两个实体的主键。

Doctrine ORM 提供了便捷的@ORM\ManyToMany注解，允许开发者声明这种关系，并自动处理连接表的创建和维护。然而，当连接表不仅仅包含两个外键，还需要承载额外的属性（例如关系创建时间、数量等），或者连接关系本身需要由多个字段（复合主键）来唯一标识时，直接使用@ORM\ManyToMany映射可能会遇到限制和问题。

问题剖析：直接 ManyToMany 映射的局限性

原始问题中描述的场景是，Object和Product实体之间存在ManyToMany关系，并且它们的连接表ObjectProduct以及Object和Product实体本身都包含一个共享的officeId属性。开发者尝试在@ORM\JoinTable的joinColumns和inverseJoinColumns中都指定officeId作为连接的一部分：

class Object
{
    // ... 其他属性和方法

    /**
     * @var Products[]|ArrayCollection
     *
     * @ORM\ManyToMany(targetEntity="AppBundle\Entity\Product")
     * @ORM\JoinTable(name="ObjectProduct",
     *      joinColumns={@ORM\JoinColumn(name="objectId", referencedColumnName="id"),
     *                   @ORM\JoinColumn(name="officeId", referencedColumnName="officeId")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="productId", referencedColumnName="id"),
     *                   @ORM\JoinColumn(name="officeId", referencedColumnName="officeId")}
     * )
     */
    private $products;

    // ...
}

当尝试插入数据时，Doctrine生成了类似INSERT INTO ObjectProduct (objectId, officeId, productId, officeId) VALUES (?, ?, ?, ?)的SQL语句，导致officeId属性被重复插入，从而引发数据库错误。

原因分析：

Doctrine在处理@ORM\ManyToMany关系时，期望joinColumns和inverseJoinColumns主要用于定义连接表中指向源实体和目标实体主键的外键。如果连接表需要一个额外的字段（如officeId）作为其自身复合主键的一部分，或者作为连接关系的附加属性，直接在joinColumns和inverseJoinColumns中重复指定该字段，Doctrine会将其误解为需要插入两次相同的列。

MindShow

MindShow官网 | AI生成PPT，快速演示你的想法

1492

查看详情

本质上，@ORM\ManyToMany映射适用于连接表仅由两个外键构成其主键的简单情况。当连接表有更多属性，或者其主键是复合主键（包含外键之外的字段，如这里的officeId），或者需要对连接表进行更细粒度的控制时，这种直接映射方式就显得力不从心。

解决方案：将连接表显式定义为实体

处理这种复杂ManyToMany关系的推荐方法是，将连接表（ObjectProduct）显式地定义为一个独立的Doctrine实体。通过这种方式，我们可以完全控制连接表的结构，包括其所有属性、复合主键以及与其他实体的关系。

这种方法将原有的ManyToMany关系拆解为两个OneToMany（或ManyToOne）关系：Object实体与ObjectProduct实体之间是OneToMany，Product实体与ObjectProduct实体之间也是OneToMany。

步骤一：创建连接实体 ObjectProduct

首先，为连接表ObjectProduct创建一个新的实体类。这个实体将包含指向Object和Product的外键，以及共享的officeId属性。在本例中，officeId与objectId和productId共同构成了ObjectProduct表的复合主键，以确保在特定officeId下Object和Product的关联是唯一的。

// src/AppBundle/Entity/ObjectProduct.php
namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity(repositoryClass="AppBundle\Repository\ObjectProductRepository")
 * @ORM\Table(name="ObjectProduct")
 * @ORM\IdClass(ObjectProduct::class) // 声明这是一个复合主键实体
 */
class ObjectProduct
{
    /**
     * @ORM\Id // 作为复合主键的一部分
     * @ORM\ManyToOne(targetEntity="AppBundle\Entity\Object", inversedBy="objectProducts")
     * @ORM\JoinColumn(name="objectId", referencedColumnName="id", nullable=false)
     */
    private $object;

    /**
     * @ORM\Id // 作为复合主键的一部分
     * @ORM\ManyToOne(targetEntity="AppBundle\Entity\Product", inversedBy="objectProducts")
     * @ORM\JoinColumn(name="productId", referencedColumnName="id", nullable=false)
     */
    private $product;

    /**
     * @ORM\Id // 作为复合主键

以上就是Doctrine ManyToMany 映射：处理带共享属性的连接表与复合主键的详细内容，更多请关注php中文网其它相关文章！