Hibernate 6中@OnDelete与@CollectionTable搭配的问题解决咨询

问题背景 #

从 Spring Boot 2.x 迁移至 3.x，同步将 Hibernate 从 5.x 升级到 6.4.1 后，实体类中 endStatus 字段的原有配置在新版本中启动报错。以下是 Hibernate 5.x 中可正常运行的代码：

@NotNull
@JoinColumn
@CollectionTable(
    name = "ex_active_monitor_end_status",
    foreignKey = @ForeignKey(name = "exFk_monitor_end_trigger")
)
@OnDelete(action = OnDeleteAction.CASCADE)
@ElementCollection(targetClass = String.class, fetch = FetchType.EAGER)
public List<String> getEndStatus() {
    return endStatus;
}

报错情况 #

1. 使用如下配置时：

@NotNull
@CollectionTable(
    joinColumns = @JoinColumn(name = "e_end_status"),
    name = "ex_active_monitor_end_status",
    foreignKey = @ForeignKey(name = "exFk_monitor_end_trigger")
)
@OnDelete(action = OnDeleteAction.CASCADE)
@ElementCollection(targetClass = String.class, fetch = FetchType.EAGER)
public List<String> getEndStatus() {
    return endStatus;
}    

触发报错：

Caused by: org.hibernate.AnnotationException: Unidirectional '@OneToMany' association 'domain.timemonitoring.ActiveTimeMonitoring.endStatus' is annotated '@OnDelete' and must explicitly specify a '@JoinColumn'
    at org.hibernate.boot.model.internal.CollectionBinder.detectMappedByProblem(CollectionBinder.java:1291)
    at org.hibernate.boot.model.internal.CollectionBinder.bind(CollectionBinder.java:1189)

2. 直接在字段上添加 @JoinColumn 注解后，又出现新报错：

Caused by: org.hibernate.AnnotationException: Property 'domain.timemonitoring.ActiveTimeMonitoring.endStatus' is a '@ElementCollection' and is directly annotated '@JoinColumn' (specify '@JoinColumn' inside '@JoinTable' or '@CollectionTable')
    at org.hibernate.boot.model.internal.CollectionBinder.checkAnnotations(CollectionBinder.java:446)
    ...

解决方案 #

Hibernate 6 对 @ElementCollection 和级联删除的配置校验更严格，正确的配置方式是：

• 保留 @CollectionTable 内部的 joinColumns 配置，明确关联字段
• 通过 @CollectionTable 的 foreignKey 属性指定级联删除行为，替代原有的 @OnDelete 注解

修改后的代码如下：

@NotNull
@CollectionTable(
    name = "ex_active_monitor_end_status",
    joinColumns = @JoinColumn(name = "e_end_status"),
    foreignKey = @ForeignKey(
        name = "exFk_monitor_end_trigger",
        onDelete = ForeignKeyAction.CASCADE
    )
)
@ElementCollection(targetClass = String.class, fetch = FetchType.EAGER)
public List<String> getEndStatus() {
    return endStatus;
}

关键说明 #

• Hibernate 6 中，@OnDelete 注解更适配 @OneToMany 关联场景，对于 @ElementCollection，应当通过 @CollectionTable 的 foreignKey 配置级联删除
• 必须确保 joinColumns 定义在 @CollectionTable 内部，禁止直接在字段上添加 @JoinColumn

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