Spring Data JPA的Audit功能，審計數據庫的變更

我最新最全的文章都在 南瓜慢說 www.pkslow.com ，歡迎大家來喝茶！

1 數據庫審計

數據庫審計是指當數據庫有記錄變更時，可以記錄數據庫的變更時間和變更人等，這樣以後出問題回溯問責也比較方便。對於審計表記錄的變更可以兩種方式，一種是建立一張審計表專門用於記錄，另一種是在數據庫增加字段。本文所討論的是第二種方案。

那如何在新增、修改、刪除的時候同時增加記錄呢？如果每張表都單獨記錄，代碼就會顯得很冗餘。更好的方式應該是做切面或者事件監聽，當數據有變更時統一進行記錄。

2 Spring Data JPA審計

Spring Data JPA爲我們提供了方便的Audit功能，通過四個註解來標記字段：

(1) @CreatedBy： 創建人

(2) @CreatedDate： 創建時間

(3) @LastModifiedBy： 最後修改人

(4) @LastModifiedDate： 最後修改時間

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

2.1 項目準備

通過Docker啓動PostgreSQL數據庫：

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

引入相關依賴：

<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 創建實體父類

其實父類不是必須的，你可以在每個想Audit的實體類進行配置，但比較麻煩，不如創建一個父類，再讓想審計的子類都繼承它：

@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可以讓其它子實體類繼承相關的字段和屬性；

@EntityListeners設置監聽類，會對新增和修改進行回調處理。

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

@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 如何獲取名字

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

@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來獲取登陸用戶的名字，當然可以有其它方案，如獲取請求頭的某個字段等。

注意註解@EnableJpaAuditing開啓了審計功能。

2.4 測試

我們通過一個Controller來新增數據，看看會有什麼效果：

@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":"[email protected]",
>     "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":"[email protected]","country":"China","website":"www.pkslow.com"}

查看數據庫，已經生成了審計記錄：

3 總結

代碼請查看：https://github.com/LarryDpk/pkslow-samples

---

歡迎關注微信公衆號<南瓜慢說>，將持續爲你更新...

多讀書，多分享；多寫作，多整理。