Java SpringBoot JPA
有些业务数据需要对数据的创建人、创建时间、最后更新人和最后更新时间进行记录。如果使用Spring Data Jpa做数据新增或更新，可实现自动保存这些信息而不需要显式设置对应字段的值。实现自动记录上述信息主要有5个注解：

  • @EnableJpaAuditing：审计功能开关
  • @CreatedBy：标记数据创建者属性
  • @LastModifiedBy：标记数据最近一次修改者属性
  • @CreatedDate：标记数据创建日期属性

  • @LastModifiedDate：标记数据最近一次修改日期属性

    依赖引用

    使用Spring Data JPA要引用依赖spring-boot-starter-data-jpa

    1. <dependency>
    2. <groupId>org.springframework.boot</groupId>
    3. <artifactId>spring-boot-starter-data-jpa</artifactId>
    4. </dependency>

    实体类标记审计属性

    案例使用User实体演示过程，需要在实体对应的字段上添加对应的注解表示是审计属性，另外需要在实体类上开启审计监听，如下：

    1. @Entity
    2. @Table(name = "t_user")
    3. @EntityListeners({AuditingEntityListener.class})//开启审计监听
    4. public class UserDO implement Serializable {
    5.       @Id
    6.   @GeneratedValue(strategy = GenerationType.IDENTITY)
    7.   private Integer id;
    9.   //保存创建人的字段
    10.   @CreatedBy
    11.   @Column(name = "created_by")
    12.   private String createdBy;
    14.   //保存最近修改人的字段
    15.   @LastModifiedBy
    16.   @Column(name = "last_modified_by")
    17.   private String lastModifiedBy;
    19.   //保存创建时间的字段
    20.   @CreatedDate
    21.   @Column(name = "created_date")
    23.   //保存最近修改日期的字段
    24.   private Date createdDate;
    25.   @LastModifiedDate
    26.   @Column(name = "last_modified_date")
    27.   private Date lastModifiedDate;
    29.   @Column(name = "real_name")
    30.   private String realName;
    32.   @Column(name = "username")    
    33.   private String username;
    35.   @Column(name = "password")
    36.   private String password;
    38.   //TODO 省略 getter setter
    39. }

    User实体对应数据表定义如下：

    1. create table t_user (
    2.   id int auto_increment primary key,
    3.   username varchar(30) default '' not null comment '登录用户名',
    4.   password varchar(100) default '' null comment '加密密码',
    5.   real_name varchar(30) default '' null comment '真实姓名',
    6.   created_by varchar(50) default 'HSystem' null comment '创建人',
    7.   created_date datetime default CURRENT_TIMESTAMP not null,
    8.   last_modified_by varchar(30) default 'HSystem' null comment '修改人',
    9.   last_modified_date datetime default CURRENT_TIMESTAMP not null,
    10.   constraint user_username_uindex unique (username)
    11. );

    审计自定义操作

    当对实体有新增或保存操作时，系统会自动获取操作时的系统时间作为创建时间和修改时间。对于创建人或最后修改人，审计过程会获取当前登录系统的用户信息，当未登录的情况下，需要指定默认操作，可通过实现AuditorAware类来实现。下面代码在未获取到用户信息时返回HSystem表示默认为系统操作。

    1. @Configuration
    2. public class SpringSecurityAuditorAware implements AuditorAware<String> {
    4.   final Logger logger = LoggerFactory.getLogger(this.getClass());
    6.   @Override
    7.   public Optional<String> getCurrentAuditor() {
    8.       try {
    9.           //TODO 这里根据具体情况获取用户信息
    10.           Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
    11.           if (authentication instanceof AnonymousAuthenticationToken) {
    12.               return Optional.of("HSystem");
    13.           } else {
    14.               if (authentication == null) {
    15.                   return Optional.of("HSystem");
    16.               }
    17.               User user = (User) authentication.getPrincipal();
    18.               return Optional.of(user.getUsername());
    19.           }
    20.       } catch (Exception ex) {
    21.           logger.error("get user Authentication failed: " + ex.getMessage(), ex);
    22.           return Optional.of("HSystem");
    23.       }
    24.   }
    25. }

    应用开启审计功能

    在应用程序入口类添加注解@EnableJpaAuditing开启审计功能，如下

    1. @SpringBootApplication
    2. //启用JPA审计功能，自动填充@CreateDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy注解的字段
    3. @EnableJpaAuditing(auditorAwareRef = "springSecurityAuditorAware")
    4. public class JapAuditApplication {
    6.   public static void main(String[] args) {
    7.       SpringApplication.run(HBackendApplication.class, args);
    8.   }
    9. }

    注意：如果系统中有多个审计实现，需要指定Bean的名称，上面案例中使用名称为springSecurityAuditorAware的bean。

    实体操作

    定义User实体类的JPA操作接口UserRepository如下 ```java @Repository public interface UserRepository extends PagingAndSortingRepository, JpaRepository {

} ``` 经过以上步骤再使用UserRepository保存User信息时，就会自动更新创建人，创建时间，更新人和更新时间者四个字段。