springboot~jpa優雅的處理isDelete的默認值
如果多個實體類都有 isDelete 字(zi)段,并且你希望在(zai)插入時為它們統一設置默認(ren)值,可以采(cai)取以下(xia)幾種方法來(lai)減(jian)少(shao)代(dai)碼(ma)重復:
1. 使用基類(抽象類)
創建一個基類,其中包含 isDelete 字段和 @PrePersist 方法。然后讓所有需要這個(ge)字段(duan)的實體(ti)類(lei)(lei)繼承這個(ge)基(ji)類(lei)(lei)。
示例代碼:
import javax.persistence.MappedSuperclass;
import javax.persistence.PrePersist;
@MappedSuperclass
public abstract class BaseEntity {
protected Integer isDelete;
@PrePersist
public void prePersist() {
if (isDelete == null) {
isDelete = 0; // 設置默認值為0
}
}
// Getter 和 Setter
public Integer getIsDelete() {
return isDelete;
}
public void setIsDelete(Integer isDelete) {
this.isDelete = isDelete;
}
}
然后在其他實體類中繼承 BaseEntity:
import javax.persistence.Entity;
import javax.persistence.Id;
@Entity
public class MyEntity extends BaseEntity {
@Id
private Long id;
// 其他字段、getter 和 setter
}
2. 使用 AOP(面向切面編程)
通過 Spring AOP 創建一個切面,在插入操作時檢查并設置 isDelete 的默認值(zhi)。這種方式不(bu)需(xu)要修(xiu)改每個實體(ti)類,適合大規模應用。
示例代碼:
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import java.lang.reflect.Field;
@Aspect
@Component
public class DefaultValueAspect {
@PersistenceContext
private EntityManager entityManager;
@Before("execution(* com.example.repository.*.save(..))") // 根據你的倉庫路徑調整
public void setDefaultValues(Object entity) throws IllegalAccessException {
Field[] fields = entity.getClass().getDeclaredFields();
for (Field field : fields) {
if ("isDelete".equals(field.getName())) { // 檢查字段名
field.setAccessible(true);
if (field.get(entity) == null) {
field.set(entity, 0); // 設置默認值為0
}
}
}
}
}
3. 使用 JPA 審計功能
使用 Spring Data JPA 的審計功能,通過實現 AuditorAware 接口來統一處理審計字段,包括 createdBy,createdTime,updatedBy,updatedTime等,而isDelete這(zhe)種(zhong)狀態字段在審計注(zhu)釋中(zhong)并沒(mei)有實現。
4. 使用事件監聽@EntityListeners
JPA 提供了事件監聽器的功能(neng),你可以定(ding)義一個事件監聽器來(lai)處(chu)理所有需要(yao)設置(zhi)默認值的實體類(lei)。
示例代碼:
import javax.persistence.PostLoad;
import javax.persistence.PrePersist;
import javax.persistence.EntityListeners;
public interface DeletedField {
Integer getIsDelete();
void setIsDelete(Integer deletedFlag);
}
public class DeleteDefaultValueListener {
@PrePersist
public void setDefaultValues(DeletedFlagField deletedFlagField) {
if (deletedFlagField.getIsDelete() == null) {
deletedFlagField.setIsDelete(0); // 設置默認值為0
}
}
}
@EntityListeners(DefaultValueListener.class)
@Entity
public class TableUserAccount extends EntityBase implements DeletedFlagField {
/**
* 刪除標識(邏輯刪除),1刪除 0未刪除
*/
@Column(name = "is_delete")
private Integer isDelete;
}
5. 擴展JPA,對審計字段建立者和更新者的擴展
- CreatedByField 建立者字段接口
- UpdatedByField 更新者字段接口
- CreatedByDefaultValueListener 建立者字段監聽器
- UpdatedByDefaultValueListener 更新者字段監聽器
- AuditorAwareImpl 審計接口,返回當前用戶
CreatedByField
public interface CreatedByField {
String getCreatedBy();
void setCreatedBy(String createdBy);
}
擴展EntityBase實體,不使用默認的CreatedBy和LastModifiedBy
@Getter
@Setter
@MappedSuperclass
@EntityListeners({ AuditingEntityListener.class, UpdatedByDefaultValueListener.class,
CreatedByDefaultValueListener.class })
public abstract class EntityBase implements Serializable, CreatedByField, UpdatedByField {
/**
* 創建人
*/
@Column(name = "created_by")
private String createdBy;
/**
* 修改人
*/
@Column(name = "updated_by")
private String updatedBy;
}
CreatedByDefaultValueListener
public class CreatedByDefaultValueListener implements ApplicationContextAware {
private ApplicationContext applicationContext;
@PrePersist
public void setDefaultValues(CreatedByField createdByField) {
if (createdByField.getCreatedBy() == null) {
if (this.applicationContext.getBean(AuditorAwareImpl.class) != null) {
createdByField.setCreatedBy(
this.applicationContext.getBean(AuditorAwareImpl.class).getCurrentAuditor().orElse(""));
}
}
}
/**
* @param applicationContext
* @throws BeansException
*/
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
}