如何在JPA实体中定义外键生成符合指定SQL结构的数据库表

以下配置可让基于Hibernate实现的JPA自动生成和给出SQL完全一致的表结构，无需额外手动调整字段、约束属性。

1. Customer实体类配置 #

Customer表主键为字符串类型的email字段，无自增属性，所有字段严格匹配非空、长度约束：

import jakarta.persistence.*;

@Entity
@Table(name = "customer")
public class Customer {
    // 对应cus_name varchar(30) NOT NULL
    @Column(name = "cus_name", length = 30, nullable = false)
    private String cusName;

    // 主键，对应email varchar(30) NOT NULL
    @Id
    @Column(name = "email", length = 30, nullable = false)
    private String email;

    // 对应password varchar(20) NOT NULL
    @Column(name = "password", length = 20, nullable = false)
    private String password;

    // 对应phone varchar(15) NOT NULL
    @Column(name = "phone", length = 15, nullable = false)
    private String phone;

    // 如需双向关联可添加以下一对多配置，不会影响表结构生成
    // @OneToMany(mappedBy = "customer")
    // private List<Booking> bookings;

    // JPA要求实体必须提供空参构造
    public Customer() {}

    // 自行生成各字段的getter、setter即可
}

2. Booking实体类配置 #

自增主键、外键列、外键约束名需严格匹配SQL定义：

import jakarta.persistence.*;

@Entity
@Table(name = "booking")
public class Booking {
    // 自增主键，对应booking_num int(11) NOT NULL AUTO_INCREMENT
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "booking_num", nullable = false)
    private Integer bookingNum;

    // 多对一关联Customer，对应外键约束
    @ManyToOne
    @JoinColumn(
            name = "pass_email", // 当前booking表的外键列名
            referencedColumnName = "email", // 关联customer表的目标列名
            foreignKey = @ForeignKey(name = "email_fk"), // 外键约束名称
            nullable = false // 外键字段非空
    )
    private Customer customer;

    // 对应name varchar(30) NOT NULL
    @Column(name = "name", length = 30, nullable = false)
    private String name;

    // 对应contact varchar(20) NOT NULL
    @Column(name = "contact", length = 20, nullable = false)
    private String contact;

    // JPA要求实体必须提供空参构造
    public Booking() {}

    // 自行生成各字段的getter、setter即可
}

3. @JoinColumn注解参数填写说明 #

针对本场景，各参数的配置逻辑如下：

• name：必填参数，指定**外键持有方（当前booking表）**中存储外键值的列名，本例固定填pass_email。如果不手动指定，JPA会默认生成关联属性名_目标主键列名格式的列名，和要求结构不符。
• referencedColumnName：指定**关联目标表（customer表）**中被外键关联的列名。本例中customer表主键列名是email而非JPA默认适配的id，必须显式声明，否则JPA会抛出找不到关联列的错误。
• foreignKey：JPA 2.1+版本支持的参数，用于显式指定外键约束的名称，本例填email_fk即可和SQL定义的约束名完全匹配；不配置的话JPA会自动生成带随机后缀的约束名。
• nullable：控制外键列是否允许为null，本例SQL中pass_email为NOT NULL约束，因此设为false。

配置校验规则 #

• 持久层配置中需将hibernate.hbm2ddl.auto设为create或update，才会触发表自动生成逻辑。
• 所有字符串类型字段必须显式声明length值，否则JPA会默认创建长度为255的varchar字段，和指定长度不匹配。
• Booking表的自增主键必须使用GenerationType.IDENTITY生成策略，才能正确映射MySQL的AUTO_INCREMENT属性。

内容的提问来源于stack exchange，提问作者Brandon Ronald