如何自動填充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