Mybatis Interceptor 攔截器

廣訓發表於2019-01-19
MyBatis

攔截器（Interceptor）在 Mybatis 中被當做外掛（plugin）對待，官方文件提供了 Executor（攔截執行器的方法），ParameterHandler（攔截引數的處理），ResultSetHandler（攔截結果集的處理），StatementHandler（攔截Sql語法構建的處理） 共4種，並且提示“這些類中方法的細節可以通過檢視每個方法的簽名來發現，或者直接檢視 MyBatis 發行包中的原始碼”。

攔截器的使用場景主要是更新資料庫的通用欄位，分庫分表，加解密等的處理。

1. Interceptor

攔截器均需要實現該 org.apache.ibatis.plugin.Interceptor 介面。

2. Intercepts 攔截器

@Intercepts({
        @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})

攔截器的使用需要檢視每一個type所提供的方法引數。

Signature 對應 Invocation 構造器，type 為 Invocation.Object，method 為 Invocation.Method，args 為 Invocation.Object[]。

method 對應的 update 包括了最常用的 insert/update/delete 三種操作，因此 update 本身無法直接判斷sql為何種執行過程。

args 包含了其餘所有的操作資訊, 按陣列進行儲存, 不同的攔截方式有不同的引數順序, 具體看type介面的方法簽名, 然後根據簽名解析。

3. Object 物件型別

args 引數列表中，Object.class 是特殊的物件型別。如果有資料庫統一的實體 Entity 類，即包含表公共欄位，比如建立、更新操作物件和時間的基類等，在編寫程式碼時儘量依據該物件來操作，會簡單很多。該物件的判斷使用

Object parameter = invocation.getArgs()[1];
if (parameter instanceof BaseEntity) {
    BaseEntity entity = (BaseEntity) parameter;
}

即可，根據語句執行型別選擇對應欄位的賦值。

如果引數不是實體，而且具體的引數，那麼 Mybatis 也做了一些處理，比如 @Param("name") String name 型別的引數，會被包裝成 Map 介面的實現來處理，即使是原始的 Map 也是如此。使用

Object parameter = invocation.getArgs()[1];
if (parameter instanceof Map) {
    Map map = (Map) parameter;
}

即可，對具體統一的引數進行賦值。

4. SqlCommandType 命令型別

Executor 提供的方法中，update 包含了 新增，修改和刪除型別，無法直接區分，需要藉助 MappedStatement 類的屬性 SqlCommandType 來進行判斷，該類包含了所有的操作型別

public enum SqlCommandType {
  UNKNOWN, INSERT, UPDATE, DELETE, SELECT, FLUSH;
}

畢竟新增和修改的場景，有些引數是有區別的，比如建立時間和更新時間，update 時是無需兼顧建立時間欄位的。

MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
SqlCommandType commandType = ms.getSqlCommandType();

5. 例項

自己編寫的小專案中，需要統一給資料庫欄位屬性賦值：

public class BaseEntity {
    private int id;
    private int creator;
    private int updater;
    private Long createTime;
    private Long updateTime;
}

dao 操作使用了實體和引數的方式，個人建議還是統一使用實體比較簡單，易讀。

使用實體：

int add(BookEntity entity);

使用引數：

int update(@Param("id") int id, @Param("url") String url, @Param("description") String description, @Param("playCount") int playCount, @Param("creator") int creator, @Param("updateTime") long updateTime);

完整的例子：

package com.github.zhgxun.talk.common.plugin;

import com.github.zhgxun.talk.common.util.DateUtil;
import com.github.zhgxun.talk.common.util.UserUtil;
import com.github.zhgxun.talk.entity.BaseEntity;
import com.github.zhgxun.talk.entity.UserEntity;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.springframework.stereotype.Component;

import java.util.Map;
import java.util.Properties;

/**
 * 全域性攔截資料庫建立和更新
 * <p>
 * Signature 對應 Invocation 構造器, type 為 Invocation.Object, method 為 Invocation.Method, args 為 Invocation.Object[]
 * method 對應的 update 包括了最常用的 insert/update/delete 三種操作, 因此 update 本身無法直接判斷sql為何種執行過程
 * args 包含了其餘多有的操作資訊, 按陣列進行儲存, 不同的攔截方式有不同的引數順序, 具體看type介面的方法簽名, 然後根據簽名解析, 參見官網
 *
 * @link http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins 外掛
 * <p>
 * MappedStatement 包括了SQL具體操作型別, 需要通過該型別判斷當前sql執行過程
 */
@Component
@Intercepts({
        @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})
@Slf4j
public class NormalPlugin implements Interceptor {

    @Override
    @SuppressWarnings("unchecked")
    public Object intercept(Invocation invocation) throws Throwable {
        // 根據簽名指定的args順序獲取具體的實現類
        // 1. 獲取MappedStatement例項, 並獲取當前SQL命令型別
        MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
        SqlCommandType commandType = ms.getSqlCommandType();

        // 2. 獲取當前正在被操作的類, 有可能是Java Bean, 也可能是普通的操作物件, 比如普通的引數傳遞
        // 普通引數, 即是 @Param 包裝或者原始 Map 物件, 普通引數會被 Mybatis 包裝成 Map 物件
        // 即是 org.apache.ibatis.binding.MapperMethod$ParamMap
        Object parameter = invocation.getArgs()[1];
        // 獲取攔截器指定的方法型別, 通常需要攔截 update
        String methodName = invocation.getMethod().getName();
        log.info("NormalPlugin, methodName; {}, commandType: {}", methodName, commandType);

        // 3. 獲取當前使用者資訊
        UserEntity userEntity = UserUtil.getCurrentUser();
        // 預設測試引數值
        int creator = 2, updater = 3;

        if (parameter instanceof BaseEntity) {
            // 4. 實體類
            BaseEntity entity = (BaseEntity) parameter;
            if (userEntity != null) {
                creator = entity.getCreator();
                updater = entity.getUpdater();
            }
            if (methodName.equals("update")) {
                if (commandType.equals(SqlCommandType.INSERT)) {
                    entity.setCreator(creator);
                    entity.setUpdater(updater);
                    entity.setCreateTime(DateUtil.getTimeStamp());
                    entity.setUpdateTime(DateUtil.getTimeStamp());
                } else if (commandType.equals(SqlCommandType.UPDATE)) {
                    entity.setUpdater(updater);
                    entity.setUpdateTime(DateUtil.getTimeStamp());
                }
            }
        } else if (parameter instanceof Map) {
            // 5. @Param 等包裝類
            // 更新時指定某些欄位的最新資料值
            if (commandType.equals(SqlCommandType.UPDATE)) {
                // 遍歷引數型別, 檢查目標引數值是否存在物件中, 該方式需要應用編寫有一些統一的規範
                // 否則均統一為實體物件, 就免去該重複操作
                Map map = (Map) parameter;
                if (map.containsKey("creator")) {
                    map.put("creator", creator);
                }
                if (map.containsKey("updateTime")) {
                    map.put("updateTime", DateUtil.getTimeStamp());
                }
            }
        }
        // 6. 均不是需要被攔截的型別, 不做操作
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

6. 感受

其它幾種型別，後面在看，尤其是分頁。

在編寫程式碼的過程中，有時候還是需要先知道物件的型別，比如 Object.class 跟 Interface 一樣，很多時候僅僅代表一種資料型別，需要明確知道後再進行操作。

@Param 標識的引數其實會被 Mybatis 封裝成 org.apache.ibatis.binding.MapperMethod$ParamMap 型別，一開始我就是使用

for (Field field:parameter.getClass().getDeclaredFields()) {

}

的方式獲取，以為這些都是物件的屬性，通過反射獲取並修改即可，實際上發現物件不存在這些屬性，但是列印出的資訊中，明確有這些欄位的，網上參考一些資訊後，才知道這是一個 Map 型別，問題才迎刃而解。

可參考MyBatis攔截器原理探究。

相關文章