启用 Spring Data JPA 审计功能-白红宇

突然发现 Spring Data JPA 有这么一个功能，英文是 Auditing

JPA Audit 说明

在spring jpa中，支持在字段或者方法上进行注解@CreatedDate、@CreatedBy、

@LastModifiedDate、@LastModifiedBy，从字面意思可以很清楚的了解，这几个注解的用处。

@CreatedDate

表示该字段为创建时间时间字段，在这个实体被insert的时候，会设置值

@CreatedBy

表示该字段为创建人，在这个实体被insert的时候，会设置值

@LastModifiedDate、@LastModifiedBy同理。

如何使用审计功能

首先申明实体类，需要在类上加上注解@EntityListeners(AuditingEntityListener.class)，其次在application启动类中加上注解EnableJpaAuditing，同时在需要的字段上加上@CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy等注解。

这个时候，在jpa.save方法被调用的时候，时间字段会自动设置并插入数据库，但是CreatedBy和LastModifiedBy并没有赋值，因为需要实现AuditorAware接口来返回你需要插入的值。

1.编写AuditorAware

/** * 监听 * @CreatedBy * @LastModifiedBy * 自动注入用户名 */@Configurationpublic class UserAuditorAware implements AuditorAware
     
       {    @Override    public Optional
      
        getCurrentAuditor() {        //TODO: 根据实际情况取真实用户        return Optional.of("admin");    }}

2.在实体类中声明@EntityListeners和相应的注解

考虑到所有实体都需要声明，就写在BaseEntityModel 中

@MappedSuperclass@EntityListeners(AuditingEntityListener.class)public class BaseEntityModel  implements Serializable {    /**     *      */    private static final long serialVersionUID = -6163675075289529459L;    @JsonIgnore    String entityName = this.getClass().getSimpleName();    @CreatedBy    String createdBy;    @LastModifiedBy    String modifiedBy;    /**     * 实体创建时间     */    @Temporal(TemporalType.TIMESTAMP)    @CreatedDate    protected Date dateCreated = new Date();    /**     * 实体修改时间     */    @Temporal(TemporalType.TIMESTAMP)    @LastModifiedDate    protected Date dateModified = new Date();     #省略getter setter}

3.在Application 中启用审计@EnableJpaAuditing

@SpringBootApplication@EnableJpaAuditingpublic class Application {        public static void main(String[] args) throws Exception {        SpringApplication.run(Application .class, args);    }    /**     * 测试中如果无法自动识别,可能是包路径的问题，采用手动声明bean的方式     * @return     */    @Bean    public UserAuditorAware setUserAuditorAware(){        return new UserAuditorAware();    }}

经过测试如果你的实体类上面的多个字段使用了@CreatedBy这样的注解，只会有一个生效，也就是说在一次请求中，只会被调用一次