springboot~jpa優雅的處理isDelete的預設值

张占岭發表於2024-11-18
Spring Bootdelete

如果多個實體類都有 isDelete 欄位，並且你希望在插入時為它們統一設定預設值，可以採取以下幾種方法來減少程式碼重複：

1. 使用基類（抽象類）

建立一個基類，其中包含 isDelete 欄位和 @PrePersist 方法。然後讓所有需要這個欄位的實體類繼承這個基類。

示例程式碼：

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 的預設值。這種方式不需要修改每個實體類，適合大規模應用。

示例程式碼：

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這種狀態欄位在審計註釋中並沒有實現。

4. 使用事件監聽@EntityListeners

JPA 提供了事件監聽器的功能，你可以定義一個事件監聽器來處理所有需要設定預設值的實體類。

示例程式碼：

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;
	}

}

相關文章