本文档旨在帮助开发者解决在使用 spring JPA 映射具有复合主键的数据库表时，遇到的外键约束创建错误。通过详细的代码示例和步骤说明，我们将深入探讨如何正确配置实体类，以避免 “number of referencing and referenced columns for foreign key disagree” 错误，并成功启动后端应用。
当使用 Spring JPA 映射数据库表时，如果遇到 “number of referencing and referenced columns for foreign key disagree” 错误，通常是由于外键关联的表具有复合主键，而 JPA 无法自动推断出正确的关联列。以下是如何解决这个问题的详细步骤：
1. 理解复合主键
复合主键是指由多个列共同组成的主键。在数据库设计中，当单个列不足以唯一标识一行数据时，通常会使用复合主键。
2. 创建嵌入式 ID 类
对于具有复合主键的实体类，需要创建一个嵌入式 ID 类（@Embeddable）。这个类将包含组成复合主键的所有字段。
package com.agilsistemas.construtordepedidos.model; import java.io.Serializable; import javax.persistence.Column; import javax.persistence.Embeddable; import javax.persistence.JoinColumn; import javax.persistence.ManyToOne; import lombok.AllArgsConstructor; import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.Setter; @Embeddable @Getter @Setter @EqualsAndHashCode @AllArgsConstructor public class IdClienteModel implements Serializable { @Column(name = "codigo") private int idCliente; @ManyToOne @JoinColumn(name = "empresa") private EmpresaModel idEmpresa; }
- @Embeddable: 声明这是一个可以嵌入到其他实体类的类。
- @Getter, @Setter, @EqualsAndHashCode, @AllArgsConstructor: 使用 Lombok 简化代码，自动生成 getter/setter 方法、equals/hashCode 方法和全参数构造函数。
- Serializable: 实现 Serializable 接口，以便进行序列化和反序列化。
- @Column: 映射数据库表的列。
- @ManyToOne, @JoinColumn: 如果复合主键的一部分是外键，则需要使用这些注解来定义关系。
3. 修改实体类以使用嵌入式 ID
修改实体类，使用 @EmbeddedId 注解将嵌入式 ID 类作为主键。
package com.agilsistemas.construtordepedidos.model; import java.io.Serializable; import javax.persistence.Column; import javax.persistence.EmbeddedId; import javax.persistence.Entity; import javax.persistence.Table; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; @Entity @Getter @Setter @NoArgsConstructor @Table(name = "tbcadastro") public class ClienteModel implements Serializable { @EmbeddedId private IdClienteModel idCliente; //using the object as the ID @Column(name = "razao") String razaoSocial; @Column(name = "logradouro") String rua; @Column(name = "numero") String numero; @Column(name = "bairro") String bairro; @Column(name = "complemento") String complemento; @Column(name = "cidade") String cidade; @Column(name = "fixo") String telefoneFixo; @Column(name = "celular") String celular; @Column(name = "cliente") String cliente; }
- @EmbeddedId: 声明该字段是嵌入式 ID，对应于复合主键。
4. 定义外键关联
在需要建立外键关联的实体类中，使用 @JoinColumns 注解来指定关联的列。
@OneToOne @JoinColumns({ @JoinColumn(name = "fk_cliente", referencedColumnName = "codigo", insertable = false, updatable = false), @JoinColumn(name = "fk_empresa", referencedColumnName = "empresa", insertable = false, updatable = false) }) ClienteModel fkCliente;
- @JoinColumns: 允许指定多个 @JoinColumn，用于处理复合外键的情况。
- name: 指定当前实体类中外键列的名称。
- referencedColumnName: 指定关联实体类（ClienteModel）中主键列的名称。
- insertable = false, updatable = false: 通常设置为 false，表示该外键不由 JPA 管理，而是由数据库自身维护。 这取决于你的具体需求。
5. 注意事项
- equals() 和 hashCode() 方法: IdClienteModel 类必须正确实现 equals() 和 hashCode() 方法，因为 JPA 使用这些方法来比较实体。 Lombok 的 @EqualsAndHashCode 注解可以自动生成这些方法。
- 数据类型匹配: 确保外键列和关联主键列的数据类型完全匹配。
- 数据库约束: 确保数据库中已经定义了相应的外键约束。 JPA 可以自动生成 DDL 语句，但有时手动创建约束更可靠。
- 级联操作: 根据业务需求，考虑是否需要配置级联操作（例如，cascade = CascadeType.ALL）。
总结
处理 Spring JPA 中的复合主键和外键关联需要仔细配置实体类和嵌入式 ID 类。 通过创建嵌入式 ID 类，并在外键关联中使用 @JoinColumns 注解，可以解决 “number of referencing and referenced columns for foreign key disagree” 错误，并成功映射具有复杂关系的数据库表。 确保理解每个注解的含义，并根据实际情况进行调整，才能正确地使用 Spring JPA。
