解决Spring JPA外键约束创建错误：复合主键的正确处理-java教程-PHP中文网

解决Spring JPA外键约束创建错误：复合主键的正确处理

DDD

发布： 2025-08-24 17:30:16

原创

219人浏览过

解决spring jpa外键约束创建错误：复合主键的正确处理

本文旨在帮助开发者解决在使用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中，我们需要创建一个单独的类来表示这个复合主键。这个类需要满足以下条件：

必须实现 Serializable 接口。
需要使用 @Embeddable 注解标记。
需要重写 equals() 和 hashCode() 方法，确保对象比较的正确性。
对于复合主键中的每个字段，需要使用 @Column 注解指定对应的列名。
如果复合主键中包含外键，则需要使用 @ManyToOne 和 @JoinColumn 注解来建立关系。

例如，假设有一个 ClienteModel 表，其主键由 codigo 和 empresa 两个字段组成，那么可以创建一个 IdClienteModel 类来表示这个复合主键：

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;

}

登录后复制

在这个例子中，IdClienteModel 类使用了 @Embeddable 注解，并且实现了 Serializable 接口。idCliente 字段使用了 @Column 注解指定了对应的列名为 codigo。idEmpresa 字段使用了 @ManyToOne 和 @JoinColumn 注解，表示 IdClienteModel 与 EmpresaModel 之间存在多对一的关系，并且通过 empresa 列进行关联。

实体类中使用复合主键

定义好复合主键类后，需要在实体类中使用 @EmbeddedId 注解来标记主键字段。例如，在 ClienteModel 类中，可以这样使用 IdClienteModel：

一键抠图

在线一键抠图换背景

查看详情

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;

}

登录后复制

在这个例子中，idCliente 字段使用了 @EmbeddedId 注解，表示它是一个复合主键，并且类型为 IdClienteModel。

建立外键关系

当需要在另一个实体类中引用 ClienteModel 作为外键时，需要使用 @JoinColumns 注解来指定多个关联列。例如，在 PedidoModel 类中，如果需要引用 ClienteModel 作为外键，可以这样使用：

@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，分别对应 ClienteModel 的 codigo 和 empresa 两个主键字段。name 属性指定了 PedidoModel 表中的外键列名，referencedColumnName 属性指定了 ClienteModel 表中对应的列名。insertable = false 和 updatable = false 属性表示这个外键关系不参与插入和更新操作，通常用于只读关系。

注意事项

确保复合主键类正确实现了 equals() 和 hashCode() 方法，否则可能会导致JPA无法正确识别对象。
在使用 @JoinColumns 注解时，需要确保所有的主键字段都包含在内，并且列名对应正确。
如果数据库表已经存在，并且已经定义了外键约束，那么JPA可能会尝试重新创建这些约束，导致错误。可以通过配置 spring.jpa.hibernate.ddl-auto 属性来控制JPA的DDL生成行为。例如，设置为 validate 可以让JPA只验证数据库结构，而不进行修改。