如何自動填充SQL語句中的公共欄位

碼農小胖哥發表於2020-09-30
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

相關文章