利用SpringDataJPA開啟審計功能,自動保存操作人操作時間
更新時間：2021年12月21日 11:26:54 作者：晴空排云
這篇文章主要介紹了利用SpringDataJPA開啟審計功能，自動保存操作人操作時間，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
有些業(yè)務數據對數據的創(chuàng)建、最后更新時間以及創(chuàng)建、最后操作人進行記錄。如果使用Spring Data Jpa做數據新增或更新，可實現(xiàn)自動保存這些信息而不需要顯示設置對應字段的值，可通過以下步驟進行配置。
1 相關注解
實現(xiàn)自動記錄上述信息主要有5個注解
@EnableJpaAuditing：審計功能開關@CreatedBy：標記數據創(chuàng)建者屬性@LastModifiedBy：標記數據最近一次修改者屬性@CreatedDate：標記數據創(chuàng)建日期屬性@LastModifiedDate：標記數據最近一次修改日期屬性
2 實現(xiàn)過程
2.1 依賴引用
使用Spring Data JPA要引用依賴spring-boot-starter-data-jpa，gradle引用方式如下
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
2.2 實體類標記審計屬性
案例使用User實體演示過程，需要在實體對應的字段上添加對應的注解表示是審計屬性，另外需要在實體類上開啟審計監(jiān)聽，如下：
@Entity
@Table(name = "h_user")
@EntityListeners({AuditingEntityListener.class})//開啟審計監(jiān)聽
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
//保存創(chuàng)建人的字段
@CreatedBy
@Column(name = "created_by")
private String createdBy;
//保存最近修改人的字段
@LastModifiedBy
@Column(name = "last_modified_by")
private String lastModifiedBy;
//保存創(chuàng)建時間的字段
@CreatedDate
@Column(name = "created_date")
//保存最近修改日期的字段
private Date createdDate;
@LastModifiedDate
@Column(name = "last_modified_date")
private Date lastModifiedDate;
private String realName;
private String username;
private String mobile;
private String email;
private String password;
private Integer flag;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getCreatedBy() {
return createdBy;
}
public void setCreatedBy(String createdBy) {
this.createdBy = createdBy;
}
public String getLastModifiedBy() {
return lastModifiedBy;
}
public void setLastModifiedBy(String lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy;
}
public Date getCreatedDate() {
return createdDate;
}
public void setCreatedDate(Date createdDate) {
this.createdDate = createdDate;
}
public Date getLastModifiedDate() {
return lastModifiedDate;
}
public void setLastModifiedDate(Date lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
}
public String getRealName() {
return this.realName;
}
public void setRealName(String realName) {
this.realName = realName;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getMobile() {
return mobile;
}
public void setMobile(String mobile) {
this.mobile = mobile;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
@JsonIgnore
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public Integer getFlag() {
return flag;
}
public void setFlag(Integer flag) {
this.flag = flag;
}
}
上述User實體對應數據表定義如下：
create table h_user ( id int auto_increment primary key, username varchar(30) default '' not null comment '登錄用戶名', real_name varchar(30) default '' null comment '真實姓名', mobile varchar(25) default '' null comment '手機號碼', email varchar(30) default '' null comment '郵箱', password varchar(100) default '' null comment '加密密碼', flag int default '0' null comment '用戶標記', created_by varchar(50) default 'HSystem' null comment '創(chuàng)建人', created_date datetime default CURRENT_TIMESTAMP not null, last_modified_by varchar(30) default 'HSystem' null comment '修改人', last_modified_date datetime default CURRENT_TIMESTAMP not null, constraint user_username_uindex unique (username) ) engine=InnoDB;
2.3 審計自定義操作
當對實體有新增或保存操作時，系統(tǒng)會自動獲取操作時的系統(tǒng)時間作為創(chuàng)建時間和修改時間。
對于創(chuàng)建者或最后修改這，審計過程會獲取當前登錄系統(tǒng)的用戶信息，當未登錄的情況下，需要指定默認操作，可通過實現(xiàn)AuditorAware類來實現(xiàn)。
下面代碼在未獲取到用戶信息時返回HSystem表示默認為系統(tǒng)操作。
@Configuration
public class SpringSecurityAuditorAware implements AuditorAware<String> {
final Logger logger = LoggerFactory.getLogger(this.getClass());
@Override
public Optional<String> getCurrentAuditor() {
try {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
if (authentication instanceof AnonymousAuthenticationToken) {
return Optional.of("HSystem");
} else {
if (authentication == null) {
return Optional.of("HSystem");
}
User user = (User) authentication.getPrincipal();
return Optional.of(user.getUsername());
}
} catch (Exception ex) {
logger.error("get user Authentication failed: " + ex.getMessage(), ex);
return Optional.of("HSystem");
}
}
}
2.4 應用開啟審計功能
在應用程序入口類添加注解@EnableJpaAuditing開啟審計功能，如下
@SpringBootApplication
//啟用JPA審計功能，自動填充@CreateDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy注解的字段
@EnableJpaAuditing(auditorAwareRef = "springSecurityAuditorAware")
public class HBackendApplication {
public static void main(String[] args) {
SpringApplication.run(HBackendApplication.class, args);
}
}
注意：如果系統(tǒng)中有多個審計實現(xiàn)，需要指定Bean的名稱，上面案例中使用名稱為springSecurityAuditorAware的bean。
2.5 實體操作
定義User實體類的JPA操作接口UserRepository如下
@Repository
public interface UserRepository extends PagingAndSortingRepository<User, Integer>, JpaRepository<User, Integer> {
}
例如創(chuàng)建用戶時代碼如下，不需要顯示設置上面提到的4個屬性
User user = new User();
user.setUsername(username.trim());
user.setPassword(this.passwordEncoder.encode(password));
user.setEmail("crane.liu@qq.com");
user.setFlag(0);
user.setMobile("18988888888");
user.setRealName(username);
this.userRepository.save(user);
當使用UserRepository對User類進行保存時，系統(tǒng)會自動記錄數據的審計屬性值。
最終效果如下：
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
當我們在Java應用程序中需要對字典屬性進行轉換返回給前端時，如何簡單、方便、并且優(yōu)雅的處理是一個重要問題。在本文中，我們將介紹如何使用Java中的序列化機制來優(yōu)雅地實現(xiàn)字典值的翻譯，從而簡化開發(fā)2023-04-04
springboot下實現(xiàn)RedisTemplate?List?清空
我們經常會使用Redis的List數據結構來存儲一系列的元素,當我們需要清空一個List時,可以使用RedisTemplate來實現(xiàn),本文就來詳細的介紹一下如何實現(xiàn),感興趣的可以了解一下2024-01-01
這篇文章主要為大家介紹了如何利用Java語言編寫一個電腦屏幕截圖工具，文中的示例代碼講解詳細，對我們學習有一定的幫助，需要的可以參考一下2022-05-05
這篇文章主要介紹了Java后端如何調用微信支付和支付寶支付,涵蓋了基本概念、配置步驟、代碼示例以及注意事項,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2025-04-04
本篇文章主要介紹了Eclipse配置springIDE插件的方法步驟，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-09-09
java后端返回數據給前端時去除值為空或NULL的屬性、忽略某些屬性代碼示例
在Java開發(fā)中我們處理JSON數據時經常會遇到空值(null)的情況,這篇文章主要給大家介紹了關于java后端返回數據給前端時去除值為空或NULL的屬性、忽略某些屬性的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2024-07-07
這篇文章主要介紹了Spring Security基本原理詳解,springsecurity底層實現(xiàn)為一條過濾器鏈，就是用戶請求進來，判斷有沒有請求的權限，拋出異常，重定向跳轉,需要的朋友可以參考下2023-05-05
當系統(tǒng)準備為用戶提供某個類的子類的實例,又不想讓用戶代碼和該子類形成耦合時,就可以使用工廠方法模式來設計系統(tǒng).工廠方法模式的關鍵是在一個接口或抽象類中定義一個抽象方法,下面我們會具體介紹Java使用設計模式中的工廠方法模式實例解析.2016-05-05
2018年3月20日，Oracle發(fā)布java10。java10為java帶來了很多新特性。這篇文章主要介紹了Java 10 var關鍵字詳解和示例教程,需要的朋友可以參考下2018-10-10
springboot的LogbackLoggingSystem配置加載流程解析
這篇文章主要介紹了springboot的LogbackLoggingSystem配置加載流程源碼分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-11-11