快捷導(dǎo)航

利用SpringDataJPA開啟審計功能,自動保存操作人操作時間

更新時間：2021年12月21日 11:26:54 作者：晴空排云

這篇文章主要介紹了利用SpringDataJPA開啟審計功能，自動保存操作人操作時間，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

有些業(yè)務(wù)數(shù)據(jù)對數(shù)據(jù)的創(chuàng)建、最后更新時間以及創(chuàng)建、最后操作人進(jìn)行記錄。如果使用Spring Data Jpa做數(shù)據(jù)新增或更新，可實現(xiàn)自動保存這些信息而不需要顯示設(shè)置對應(yīng)字段的值，可通過以下步驟進(jìn)行配置。

1 相關(guān)注解

實現(xiàn)自動記錄上述信息主要有5個注解

@EnableJpaAuditing：審計功能開關(guān)
@CreatedBy：標(biāo)記數(shù)據(jù)創(chuàng)建者屬性
@LastModifiedBy：標(biāo)記數(shù)據(jù)最近一次修改者屬性
@CreatedDate：標(biāo)記數(shù)據(jù)創(chuàng)建日期屬性
@LastModifiedDate：標(biāo)記數(shù)據(jù)最近一次修改日期屬性

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 實體類標(biāo)記審計屬性

案例使用User實體演示過程，需要在實體對應(yīng)的字段上添加對應(yīng)的注解表示是審計屬性，另外需要在實體類上開啟審計監(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實體對應(yīng)數(shù)據(jù)表定義如下：

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 '用戶標(biāo)記',
 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 審計自定義操作

當(dāng)對實體有新增或保存操作時，系統(tǒng)會自動獲取操作時的系統(tǒng)時間作為創(chuàng)建時間和修改時間。

對于創(chuàng)建者或最后修改這，審計過程會獲取當(dāng)前登錄系統(tǒng)的用戶信息，當(dāng)未登錄的情況下，需要指定默認(rèn)操作，可通過實現(xiàn)AuditorAware類來實現(xiàn)。

下面代碼在未獲取到用戶信息時返回HSystem表示默認(rèn)為系統(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 應(yīng)用開啟審計功能

在應(yīng)用程序入口類添加注解@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)建用戶時代碼如下，不需要顯示設(shè)置上面提到的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);

當(dāng)使用UserRepository對User類進(jìn)行保存時，系統(tǒng)會自動記錄數(shù)據(jù)的審計屬性值。

最終效果如下：

在這里插入圖片描述