基于Spring Data的AuditorAware审计功能的示例代码

小贝

Spring Data提供支持审计功能：即由谁在什么时候创建或修改实体。Spring Data提供了在实体类的属性上增加@CreatedBy，@LastModifiedBy，@CreatedDate，@LastModifiedDate注解，并配置相应的配置项，即可实现审计功能，有系统自动记录 createdBy CreatedDate lastModifiedBy lastModifiedDate 四个属性的值，下面为具体的配置项。

示例

创建一个实体类

2. package com.hfcsbc.infrastructureservice.domain;
4. import com.hfcsbc.repository.support.domain.AbstractAuditingEntity;
5. import lombok.Data;
6. import org.springframework.data.annotation.CreatedBy;
7. import org.springframework.data.annotation.CreatedDate;
8. import org.springframework.data.annotation.LastModifiedBy;
9. import org.springframework.data.annotation.LastModifiedDate;
10. import org.springframework.data.jpa.domain.support.AuditingEntityListener;
12. import javax.persistence.*;
13. import java.util.Date;
15. /**
16. * Create by pengchao on 2018/3/7
17. */
18. @Entity
19. @Data
20. @EntityListeners({AuditingEntityListener.class})
21. public class Person {
22. @Id
23. @GeneratedValue
24. private Long id;
26. private String name;
28. private Integer age;
29. @CreatedBy
30. @Column(
31. name = "created_by",
32. nullable = false,
33. length = 50,
34. updatable = false
35. )
36. private String createdBy;
37. @CreatedDate
38. @Column(
39. name = "created_date",
40. nullable = false,
41. updatable = false
42. )
43. private Date createdDate = new Date();
44. @LastModifiedBy
45. @Column(
46. name = "last_modified_by",
47. length = 50
48. )
49. private String lastModifiedBy;
50. @LastModifiedDate
51. @Column(
52. name = "last_modified_date"
53. )
54. private Date lastModifiedDate = new Date();
55. }

复制代码

创建相应的Repository

2. package com.hfcsbc.repository;
4. import com.hfcsbc.domain.Person;
5. import org.springframework.data.jpa.repository.JpaRepository;
7. /**
8. * Create by pengchao on 2018/3/7
9. */
10. public interface PersonRepository extends JpaRepository<Person, Long> {
11. }

复制代码

配置获取用户信息的bean

2. package com.hfcsbc.infrastructureservice.config;
4. import org.springframework.data.domain.AuditorAware;
5. import org.springframework.security.core.Authentication;
6. import org.springframework.security.core.context.SecurityContextHolder;
7. import org.springframework.stereotype.Component;
9. import java.util.Optional;
11. /**
12. * Create by pengchao on 2018/3/7
13. */
14. @Component("auditorAware")
15. public class AuditorAwareImpl implements AuditorAware<String> {
17. @Override
18. public Optional<String> getCurrentAuditor() {
19. Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
20. return Optional.of(authentication.getPrincipal().toString());
21. }
22. }

复制代码

在Spring Boot入口类开启审计功能

2. package com.hfcsbc.infrastructureservice;
4. import org.springframework.boot.SpringApplication;
5. import org.springframework.boot.autoconfigure.SpringBootApplication;
6. import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
7. import org.springframework.scheduling.annotation.EnableAsync;
9. @SpringBootApplication
10. @EnableJpaAuditing(auditorAwareRef = "auditorAware")
11. @EnableAsync
12. public class PersonApplication {
15. public static void main(String[] args) {
16. SpringApplication.run(PersonApplication.class, args);
17. }
18. }

复制代码

即完成配置，在使用 repository 保存对象时， createdBy CreatedDate lastModifiedBy lastModifiedDate 有审计功能自动插入

注：在异步方法中如何获取用户信息

由于在异步方法中使用repository保存对象，获取不到用户用户信息，需增加如下配置项，即可在Authentication获取用户的信息

2. package com.hfcsbc.config;
4. import org.springframework.beans.factory.config.MethodInvokingFactoryBean;
5. import org.springframework.context.annotation.Bean;
6. import org.springframework.context.annotation.Configuration;
7. import org.springframework.security.core.context.SecurityContextHolder;
9. /**
10. * Create by pengchao on 2018/3/7
11. */
12. @Configuration
13. public class AuditorAwareConfig {
14. @Bean
15. public MethodInvokingFactoryBean methodInvokingFactoryBean() {
16. MethodInvokingFactoryBean methodInvokingFactoryBean = new MethodInvokingFactoryBean();
17. methodInvokingFactoryBean.setTargetClass(SecurityContextHolder.class);
18. methodInvokingFactoryBean.setTargetMethod("setStrategyName");
19. methodInvokingFactoryBean.setArguments(new String[]{SecurityContextHolder.MODE_INHERITABLETHREADLOCAL});
20. return methodInvokingFactoryBean;
21. }
22. }

复制代码

SecurityContextHolder的主要功能是将当前执行的进程和SecurityContext关联起来。

SecurityContextHolder.MODE_INHERITABLETHREADLOCAL ：用于线程有父子关系的情景中，子线程集成父线程的SecurityContextHolder；

SecurityContextHolder.MODE_INHERITABLETHREADLOCAL ：全局共用SecurityContextHolder。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持程序员之家。