Spring boot之数据审计jpaauditing

通常我们都有这样的需求：我需要知道数据库中的数据是由谁创建，什么时候创建，最后一次修改时间是什么时候，最后一次修改人是谁。

在Spring jpa中可以通过在实体bean的属性或者方法上添加以下注解来实现上述需求@CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy。

@CreatedDate 表示该字段为创建时间时间字段，在这个实体被insert的时候，会设置值
@CreatedBy 表示该字段为创建人，在这个实体被insert的时候，会设置值
@LastModifiedDate 最后修改时间实体被update的时候会设置
@LastModifiedBy 最后修改人实体被update的时候会设置

使用方式

实体类添加注解

首先在实体中对应的字段加上上述4个注解

在web-flash中我们提取了一个基础实体类BaseEntity，并将对应的字段添加上述4个注解,所有需要记录维护信息的表对应的实体都集成该类

import org.springframework.data.annotation.CreatedBy;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedBy;
import org.springframework.data.annotation.LastModifiedDate;
import javax.persistence.Column;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
import java.io.Serializable;
import java.util.Date;
@MappedSuperclass
@Data
public abstract class BaseEntity implements Serializable {
  @Id
  @GeneratedValue
  private Long id;
  @CreatedDate
  @Column(name = "create_time",columnDefinition="DATETIME COMMENT '创建时间/注册时间'")
  private Date createTime;
  @Column(name = "create_by",columnDefinition="bigint COMMENT '创建人'")
  @CreatedBy
  private Long createBy;
  @LastModifiedDate
  @Column(name = "modify_time",columnDefinition="DATETIME COMMENT '最后更新时间'")
  private Date modifyTime;
  @LastModifiedBy
  @Column(name = "modify_by",columnDefinition="bigint COMMENT '最后更新人'")
  private Long modifyBy;
}

实现AuditorAware接口返回操作人员的id

配置完上述4个注解后，在jpa.save方法被调用的时候，时间字段会自动设置并插入数据库，但是CreatedBy和LastModifiedBy并没有赋值这两个信息需要实现AuditorAware接口来返回操作人员的id

首先需要在项目启动类添加@EnableJpaAuditing 注解来启用审计功能

@SpringBootApplication
@EnableJpaAuditing
public class MyApplication extends SpringBootServletInitializer {
 //省略
}

然后实现AuditorAware接口返回操作人员的id

@Configuration
public class UserIDAuditorConfig implements AuditorAware<Long> {
  @Autowired
  private TokenCache tokenCache;
  @Override
  public Optional<Long> getCurrentAuditor() {
      try {
          //这里获取用户id的逻辑具体的系统可能不太一样，但是总体思路无非是通过session，或者头信息获取用户标识并最终获取当前用户id
          String token = HttpKit.getRequest().getHeader("Authorization");
          if (StringUtils.isNotEmpty(token)) {
              return Optional.of(tokenCache.get(token));
          }
      }catch (Exception e){
          //某些情况向数据的更新不是由用户操作的，而是系统自动触发，比如定时任务之类，这里可以定义一个系统自身的用户id
          return Optional.of(-1L);
      }        
  }
}

正常情况下用户通过浏览器进行系统管理操作，后台可以可以获取请求的request对象进而获取当前操作用户id，但是有时候后台系统线程（比如定时任务）进行更改系统数据的时候并没有对应的request，所以指定当前操作用户id为-1，即认定位系统自身对数据进行操作。

大功告成，是不是很简单！！