快捷導(dǎo)航

解析Spring Data JPA的Audit功能之審計(jì)數(shù)據(jù)庫變更

更新時(shí)間：2021年06月29日 10:43:46 作者：南瓜慢說

Spring Data JPA 提供了Audit審計(jì)功能，用來記錄創(chuàng)建時(shí)間、創(chuàng)建人、修改時(shí)間、修改人等，下面來詳細(xì)講解下審計(jì)數(shù)據(jù)庫變更

一、數(shù)據(jù)庫審計(jì)

數(shù)據(jù)庫審計(jì)是指當(dāng)數(shù)據(jù)庫有記錄變更時(shí)，可以記錄數(shù)據(jù)庫的變更時(shí)間和變更人等，這樣以后出問題回溯問責(zé)也比較方便。對于審計(jì)表記錄的變更可以兩種方式，一種是建立一張審計(jì)表專門用于記錄，另一種是在數(shù)據(jù)庫增加字段。本文所討論的是第二種方案。

那如何在新增、修改、刪除的時(shí)候同時(shí)增加記錄呢？如果每張表都單獨(dú)記錄，代碼就會顯得很冗余。更好的方式應(yīng)該是做切面或者事件監(jiān)聽，當(dāng)數(shù)據(jù)有變更時(shí)統(tǒng)一進(jìn)行記錄。

二、Spring Data JPA審計(jì)

Spring Data JPA為我們提供了方便的Audit功能，通過四個(gè)注解來標(biāo)記字段：

(1) @CreatedBy：創(chuàng)建人

(2) @CreatedDate：創(chuàng)建時(shí)間

(3) @LastModifiedBy：最后修改人

(4) @LastModifiedDate：最后修改時(shí)間

接下來我們來看看怎么使用。

2.1、項(xiàng)目準(zhǔn)備

通過Docker啟動PostgreSQL數(shù)據(jù)庫：

docker run -itd \

--name pkslow-postgres \

-e POSTGRES_DB=pkslow \

-e POSTGRES_USER=pkslow \

-e POSTGRES_PASSWORD=pkslow \

-e PGDATA=/var/lib/postgresql/data/pgdata \

-p 5432:5432 \

postgres:10

引入相關(guān)依賴：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
  <groupId>org.postgresql</groupId>
  <artifactId>postgresql</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-security</artifactId>
</dependency>

Spring Security不是必須的，這里使用它來獲取用戶名。配置的用戶為：

spring.security.user.name=pkslow
spring.security.user.password=123456

2.2、創(chuàng)建實(shí)體父類

其實(shí)父類不是必須的，你可以在每個(gè)想Audit的實(shí)體類進(jìn)行配置，但比較麻煩，不如創(chuàng)建一個(gè)父類，再讓想審計(jì)的子類都繼承它：

@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public class Auditable<U> {
    @CreatedBy
    @Column(name = "created_by")
    private U createdBy;

    @CreatedDate
    @Column(name = "created_date")
    private Date createdDate;

    @LastModifiedBy
    @Column(name = "last_modified_by")
    private U lastModifiedBy;

    @LastModifiedDate
    @Column(name = "last_modified_date")
    private Date lastModifiedDate;
  // getter
  //setter
}

@MappedSuperclass可以讓其它子實(shí)體類繼承相關(guān)的字段和屬性；

@EntityListeners設(shè)置監(jiān)聽類，會對新增和修改進(jìn)行回調(diào)處理。

有了父類之后，子類就簡單了：

@Entity
@Table(name = "pkslow_users")
public class User extends Auditable<String> {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long userId;
    private String name;
    private String email;
    private String country;
    private String website;
  //getter setter
}

2.3、如何獲取名字

數(shù)據(jù)總是被修改的，我們要提供一個(gè)獲取修改人名字的接口，配置如下：

@Configuration
@EnableJpaAuditing(auditorAwareRef = "auditorProvider")
public class JpaAuditingConfiguration {

    @Bean
    public AuditorAware<String> auditorProvider() {
        return () -> {
            String username = "system";
            SecurityContext context = SecurityContextHolder.getContext();
            if (context != null) {
                Authentication authentication = context.getAuthentication();
                if (authentication != null) {
                    username = authentication.getName();
                }
            }

            String result = username;
            return Optional.ofNullable(result);
        };
    }
}

這里配置的是通過Spring Security的Context來獲取登陸用戶的名字，當(dāng)然可以有其它方案，如獲取請求頭的某個(gè)字段等。

注意注解@EnableJpaAuditing開啟了審計(jì)功能。

2.4、測試

我們通過一個(gè)Controller來新增數(shù)據(jù)，看看會有什么效果：

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserRepository userRepository;
    @PostMapping
    public User save(@RequestBody User user) {
        return userRepository.save(user);
    }
}

通過curl命令來測試如下：

$ curl 'http://localhost:8088/user' -X POST \

-H 'Content-Type: application/json' \

-H 'Authorization:Basic cGtzbG93OjEyMzQ1Ng==' \

-d '{

"name":"larry",

"email":"admin@pkslow.com",

"country":"China",

"website":"www.pkslow.com"

}'

{"createdBy":"pkslow","createdDate":"2021-01-15T15:08:47.035+0000","lastModifiedBy":"pkslow","lastModifiedDate":"2021-01-15T15:08:47.035+0000","userId":7,"name":"larry","email":"admin@pkslow.com","country":"China","website":"www.pkslow.com"}

查看數(shù)據(jù)庫，已經(jīng)生成了審計(jì)記錄：