本文旨在解决在使用 Spring Data JPA 时，数据库表字段的默认值被 JPA 覆盖的问题。通过结合 `@Generated` 注解和 `@Column` 注解的 `insertable` 属性，可以有效避免 JPA 在插入数据时覆盖数据库默认值，从而确保数据完整性和一致性。
在使用 Spring Data JPA 进行数据库操作时，有时会遇到数据库表字段的默认值（DEFAULT）没有生效，而是被 JPA 插入的 null 值或空值覆盖的情况。 这通常发生在希望数据库自动填充某些字段（例如创建时间、创建人等）时。本文将介绍如何配置 JPA，使其尊重数据库定义的默认值，并提供示例代码和注意事项。
问题分析
默认情况下，Spring Data JPA 在执行插入操作时，会显式地为所有列赋值。这意味着，即使数据库表定义了某些列的默认值，JPA 仍然会尝试插入值，如果实体类中对应的字段为 null，则 JPA 会插入 null 值，从而覆盖数据库的默认值。
解决方案
要解决这个问题，需要告诉 JPA 不要显式地插入某些列，而是让数据库在插入时使用其定义的默认值。 这可以通过结合使用 @Generated 注解和 @Column 注解来实现。
-
@Generated 注解:
@Generated(GenerationTime.INSERT) 注解用于指定该字段的值由数据库在插入时生成。GenerationTime.INSERT 表示在插入时生成值。
-
@Column 注解:
@Column 注解的 insertable = false 属性用于指定该字段在插入操作时不可插入。 这告诉 JPA 在执行插入操作时不要包含该字段。
示例代码
假设我们有一个名为 Properties 的实体类，其中 createdOn 字段需要在插入时使用数据库的默认值：
package com.example.configcrud.model;
import javax.persistence.*;
import java.sql.Timestamp;
@Entity
@Table(name = "properties")
public class Properties {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private long id;
@Column(name = "application")
private String application;
@Column(name = "profile")
private String profile;
@Column(name = "label")
private String label;
@Column(name = "prop_key")
private String propKey;
@Column(name = "value")
private String value;
@Generated(GenerationTime.INSERT)
@Column(name = "created_on", updatable = false, insertable = false)
private Timestamp createdOn;
@Column(name = "created_by", updatable = false)
private String createdBy;
// 构造函数、getter 和 setter 方法
public Properties(String application, String profile, String label, String propKey, String value) {
this.application = application;
this.profile = profile;
this.label = label;
this.propKey = propKey;
this.value = value;
}
public Properties() {
}
public String getApplication() {
return application;
}
public void setApplication(String application) {
this.application = application;
}
public String getProfile() {
return profile;
}
public void setProfile(String profile) {
this.profile = profile;
}
public String getLabel() {
return label;
}
public void setLabel(String label) {
this.label = label;
}
public String getPropKey() {
return propKey;
}
public void setPropKey(String propKey) {
this.propKey = propKey;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
public Timestamp getCreatedOn() {
return createdOn;
}
public Timestamp setCreatedOn() {
return createdOn;
}
public String getCreatedBy() {
return createdBy;
}
public String setCreatedBy() {
return createdBy;
}
@Override
public String toString() {
return "Properties [id=" + id + ", " +
"application=" + application + ", " +
"profile=" + profile + ", " +
"label=" + label +
"propkey=" + propKey +
"value=" + value +
"CreatedOn=" + createdOn +
"CreatedBy=" + createdBy + "]";
}
}在这个示例中，createdOn 字段使用了 @Generated(GenerationTime.INSERT) 和 @Column(name = "created_on", updatable = false, insertable = false) 注解。 updatable = false 表示该字段在更新操作时不可更新。
注意事项
- 确保数据库表已经定义了 created_on 字段的默认值。 例如: CREATED_ON TIMESTAMP DEFAULT SYSDATE。
- @Generated 注解需要 JPA 实现的支持。 Hibernate 5.0 及以上版本支持此注解。
- insertable = false 属性必须与 @Generated(GenerationTime.INSERT) 配合使用，才能达到预期的效果。
- 对于需要在更新时也使用数据库默认值的字段，可以使用 @Generated(GenerationTime.ALWAYS)。
总结
通过结合使用 @Generated 注解和 @Column 注解的 insertable = false 属性，可以有效地解决 Spring Data JPA 覆盖数据库默认值的问题。 这种方法可以确保数据库定义的默认值能够生效，从而保证数据的完整性和一致性。 在实际开发中，应根据具体需求选择合适的注解和属性，以达到最佳效果。
