Jpa怎么使用@EntityListeners實現實體對象的自動賦值

這篇文章主要介紹“Jpa怎么使用@EntityListeners實現實體對象的自動賦值”，在日常操作中，相信很多人在Jpa怎么使用@EntityListeners實現實體對象的自動賦值問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”Jpa怎么使用@EntityListeners實現實體對象的自動賦值”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

1、簡介

1.1 @EntityListeners

官方解釋:可以使用生命周期注解指定實體中的方法，這些方法在指定的生命周期事件發生時執行相應的業務邏輯。

簡單來說，就是監聽實體對象的增刪改查操作，并對實體對象進行相應的處理。

1.2 生命周期對應注解

JPA一共提供了7種注解，分別是：

@PostLoad ：實體對象查詢之后

@PrePersist : 實體對象保存之前

@PostPersist ：實體對象保存之后

@PreUpdate ：實體對象修改之前

@PostUpdate ：實體對象修改之后

@PreRemove ： 實體對象刪除之前

@PostRemove ：實體對象刪除之后

通常情況下，數據表中都會記錄創建人、創建時間、修改人、修改時間等通用屬性。如果每個實體對象都要對這些通用屬性手動賦值，就會過于繁瑣。

現在，使用這些生命周期注解，就可以實現對通用屬性的自動賦值，或者記錄相應操作日志。

2、環境準備

數據庫：mysql

項目搭建：演示項目通過Spring Boot 2.2.6構建，引入spring-boot-starter-data-jpa

2.1 數據表

-- 用戶表
CREATE TABLE `acc_user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `username` varchar(40) NOT NULL DEFAULT '' COMMENT '用戶名',
  `password` varchar(40) NOT NULL DEFAULT '' COMMENT '密碼',
  `create_by` varchar(80) DEFAULT NULL,
  `create_time` datetime DEFAULT CURRENT_TIMESTAMP,
  `update_by` varchar(80) DEFAULT NULL,
  `update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
-- 日志表
CREATE TABLE `modify_log` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `action` varchar(20) NOT NULL DEFAULT '' COMMENT '操作',
  `entity_name` varchar(40) NOT NULL DEFAULT '' COMMENT '實體類名',
  `entity_key` varchar(20) DEFAULT NULL COMMENT '主鍵值',
  `entity_value` varchar(400) DEFAULT NULL COMMENT '實體值',
  `create_by` varchar(80) DEFAULT NULL,
  `create_time` datetime DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

2.2 實體類

@MappedSuperclass
@Getter @Setter
@MappedSuperclass
// 指定對應監聽類
@EntityListeners(CreateListener.class)
public abstract class IdMapped {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String createBy;
    private Date createTime;
}

@Getter @Setter
@MappedSuperclass
// 指定對應監聽類
@EntityListeners(EditListener.class)
public abstract class EditMapped extends IdMapped{
    private String updateBy;
    private Date updateTime;
}

用戶類

@Entity
@Table(name = "acc_user")
@Getter @Setter
public class UserEntity extends EditMapped {
    private String username;
    private String password;
}

日志類

@Entity
@Table(name = "modify_log")
@Getter @Setter
public class ModifyLogEntity extends IdMapped{
    private String  action;
    private String  entityName;
    private String  entityKey;
    private String  entityValue;
}

2.3 監聽類

public class CreateListener extends BasicListener {
    // 保存之前，為創建時間和創建人賦值
    @PrePersist
    public void prePersist(IdMapped idMapped) {
        if (Objects.isNull(idMapped.getCreateTime())) {
            idMapped.setCreateTime(new Date());
        }
        if (StringUtils.isBlank(idMapped.getCreateBy())) {
            // 根據鑒權系統實現獲取當前操作用戶，此處只做模擬
            idMapped.setCreateBy("test_create");
        }
    }
    // 保存之后，記錄變更日志
    @PostPersist
    public void postPersist(IdMapped idMapped) throws JsonProcessingException {
        recordLog(ACTION_INSERT, idMapped);
    }
}

public class EditListener extends BasicListener {
    // 修改之前，為修改人和修改時間賦值
    @PreUpdate
    public void preUpdate(EditMapped editMapped) {
        if (Objects.isNull(editMapped.getUpdateTime())) {
            editMapped.setCreateTime(new Date());
        }
        if (StringUtils.isBlank(editMapped.getUpdateBy())) {
            // 根據鑒權系統實現獲取當前操作用戶，此處只做模擬
            editMapped.setUpdateBy("test_update");
        }
    }
    // 修改之后，記錄變更日志
    @PostUpdate
    public void postUpdate(EditMapped editMapped) throws JsonProcessingException {
        recordLog(ACTION_UPDATE, editMapped);
    }
    // 刪除之前，記錄變更日志
    @PreRemove
    public void preRemove(EditMapped editMapped) throws JsonProcessingException {
        recordLog(ACTION_DELETE, editMapped);
    }
}

public class BasicListener implements ApplicationContextAware {
    private ApplicationContext applicationContext;
    protected static final String ACTION_INSERT = "insert";
    protected static final String ACTION_UPDATE = "update";
    protected static final String ACTION_DELETE = "delete";
    // 記錄變更日志
    protected void recordLog(String action, IdMapped object) throws JsonProcessingException {
        // 日志對象不需要再記錄變更日志
        if (object instanceof ModifyLogEntity) {
            return;
        }
        ModifyLogEntity modifyLogEntity = new ModifyLogEntity();
        modifyLogEntity.setAction(action);
        modifyLogEntity.setEntityKey(String.valueOf(object.getId()));
        modifyLogEntity.setEntityName(object.getClass().getSimpleName());
        // 對象轉json字符串存儲
        modifyLogEntity.setEntityValue(new ObjectMapper().writeValueAsString(object));
        Optional.ofNullable(applicationContext.getBean(ModifyLogDao.class))
                .ifPresent(modifyLogDao -> modifyLogDao.save(modifyLogEntity));
    }
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

3、測試

3.1 Dao

@Repository
public interface UserDao extends JpaRepository<UserEntity, Long> {
}

@Repository
public interface ModifyLogDao extends JpaRepository<ModifyLogEntity, Long> {
}

3.2 Service

模擬用戶的創建、修改和刪除操作

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserDao userDao;
    @Override
    @Transactional
    public void add(String userName, String password) {
        UserEntity userEntity = new UserEntity();
        userEntity.setUsername(userName);
        userEntity.setPassword(password);
        userDao.save(userEntity);
    }
    @Override
    @Transactional
    public void update(Long id, String password) {
        UserEntity userEntity = userDao.findById(id).orElseThrow(() -> new RuntimeException("用戶不存在"));
        userEntity.setPassword(password);
        userDao.save(userEntity);
    }
    @Override
    @Transactional
    public void delete(Long id) {
        UserEntity userEntity = userDao.findById(id).orElseThrow(() -> new RuntimeException("用戶不存在"));
        userDao.delete(userEntity);
    }
}

3.3 測試

3.3.1 創建用戶

@SpringBootTest
public class SchoolApplicationTests {
    @Autowired
    private UserService userService;
    @Test
    public void testAdd() {
        userService.add("test1", "123456");
    }    
}

測試結果

3.3.2 修改用戶

@Test
    public void testUpdate() {
        userService.update(1L, "654321");
    }

測試結果

3.3.3 刪除用戶

	@Test
    public void testRemove() {
        userService.delete(1L);
    }

測試結果

到此，關于“Jpa怎么使用@EntityListeners實現實體對象的自動賦值”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！