如何自動填充SQL語句中的公共字段

1. 前言

我們在設計數據庫的時候一定會帶上新增、更新的時間、操作者等審計信息。 之所以帶這些信息是因為假如有一天公司的數據庫被人為刪了，盡管可能有數據庫備份可以恢復數據。但是我們仍然需要追蹤到這個事是誰干的，在什么時間干的，具體干了哪些事等等，方便定責和修補。但是我們變更每條數據都要去顯式變更這些信息就十分繁瑣，我們希望無感知的來處理這些信息。

2. 通用方式

那么有什么好的解決思路呢？在Spring Data框架中提供@CreatedBy和@LastModifiedBy來捕捉誰創建或修改的實體以及@CreatedDate和@LastModifiedDate來捕捉合適創建或修改了實體。如果你使用相關的框架就可以使用這些特性。那么其實我們知道國內Spring Data JDBC、Spring Data JPA並不是主流，主流的是Mybatis。那么我們有哪些選擇？

2.1 開發Mybatis審計插件

如果你使用了原生的Mybatis可以編寫一個審計插件來實現這些功能。我在之前講解過Mybatis插件的教程，並不是非常難的事。如果你想拿來就用，其實GitHub上提供了很多可供選擇的Mybatis審計組件，本來我打算手寫一個，但是確實人家寫的好。你可以通過關鍵詞Mybatis Audit來搜索到它們選擇一款最適合你的。

2.2 Mybatis Plus 自動填充

如果你使用了Mybatis Plus，可以借助於其自動填充功能來實現。

基於 Mybatis Plus 3.3.0

只需要實現MetaObjectHandler接口：

@Component
public class MybatisAuditHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        // 聲明自動填充字段的邏輯。
        String userId = AuthHolder.getCurrentUserId();
        this.strictInsertFill(metaObject,"creator",String.class, userId);
        this.strictInsertFill(metaObject,"createTime", LocalDateTime.class,LocalDateTime.now());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        // 聲明自動填充字段的邏輯。
        String userId = AuthHolder.getCurrentUserId();
        this.strictUpdateFill(metaObject,"updater",String.class,userId);
        this.strictUpdateFill(metaObject,"updateTime", LocalDateTime.class,LocalDateTime.now());
    }
}

然后我們擴展一下Mybatis Plus的Model<T>把公共審計字段放進去並聲明對應的填充策略：

public abstract class BaseEntity<T extends Model<?>> extends Model<T> {

    @TableField(fill = FieldFill.INSERT)
    private String creator;
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime addTime;
    @TableField(fill = FieldFill.UPDATE)
    private String updater;
    @TableField(fill = FieldFill.UPDATE)
    private LocalDateTime updateTime;
}

最后我們的實體類不再直接繼承Model<T>改為上面的BaseEntity<T>：

@Data
@EqualsAndHashCode(callSuper = false)
public class UserInfo extends BaseEntity<UserInfo> {
    @TableId(value = "user_id", type = IdType.ASSIGN_ID)
    private String userId;
    private String username;

    @Override
    protected Serializable pkVal() {
        return this.userId;
    }
}

這樣我們就不用再關心這幾個公共字段了，當然你可以根據需要添加更多你需要填充的字段。

3. 總結

今天我們SQL審計中的一些公共字段的自動填充的常用方案進行了一些介紹，特別對Mybatis Plus提供的功能進行了介紹相信能夠幫助你簡化一些樣板代碼的編寫。但是SQL審計並不僅僅這么簡單，根據你的業務的不同會有不同的設計。如果設計的更加精細化的話，會通過鏡像或探針的方式采集所有數據庫的訪問流量，並基於SQL語法、語義的解析技術，記錄下數據庫的所有訪問和操作行為。有空可以從網上獲取相關的資料進行了解。今天就到這里，關注：碼農小胖哥，獲取更多的編程實戰干貨。

關注公眾號：Felordcn 獲取更多資訊

個人博客：https://felord.cn