Mybatis Interceptor 攔截器的實(shí)現(xiàn)

更新時(shí)間：2018年12月17日 14:19:07 作者：廣訓(xùn)

這篇文章主要介紹了Mybatis Interceptor 攔截器的實(shí)現(xiàn)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

Mybatis采用責(zé)任鏈模式，通過(guò)動(dòng)態(tài)代理組織多個(gè)攔截器（插件），通過(guò)這些攔截器可以改變Mybatis的默認(rèn)行為（諸如SQL重寫(xiě)之類(lèi)的），由于插件會(huì)深入到Mybatis的核心，因此在編寫(xiě)自己的插件前最好了解下它的原理，以便寫(xiě)出安全高效的插件。

攔截器（Interceptor）在 Mybatis 中被當(dāng)做插件（plugin）對(duì)待，官方文檔提供了 Executor，ParameterHandler，ResultSetHandler，StatementHandler 共4種，并且提示“這些類(lèi)中方法的細(xì)節(jié)可以通過(guò)查看每個(gè)方法的簽名來(lái)發(fā)現(xiàn)，或者直接查看 MyBatis 發(fā)行包中的源代碼”。

攔截器的使用場(chǎng)景主要是更新數(shù)據(jù)庫(kù)的通用字段，分庫(kù)分表，加解密等的處理。

1. Interceptor

攔截器均需要實(shí)現(xiàn)該 org.apache.ibatis.plugin.Interceptor 接口。

2. Intercepts 攔截器

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

攔截器的使用需要查看每一個(gè)type所提供的方法參數(shù)。

Signature 對(duì)應(yīng) Invocation 構(gòu)造器，type 為 Invocation.Object，method 為 Invocation.Method，args 為 Invocation.Object[]。

method 對(duì)應(yīng)的 update 包括了最常用的 insert/update/delete 三種操作，因此 update 本身無(wú)法直接判斷sql為何種執(zhí)行過(guò)程。

args 包含了其余所有的操作信息, 按數(shù)組進(jìn)行存儲(chǔ), 不同的攔截方式有不同的參數(shù)順序, 具體看type接口的方法簽名, 然后根據(jù)簽名解析。

3. Object 對(duì)象類(lèi)型

args 參數(shù)列表中，Object.class 是特殊的對(duì)象類(lèi)型。如果有數(shù)據(jù)庫(kù)統(tǒng)一的實(shí)體 Entity 類(lèi)，即包含表公共字段，比如創(chuàng)建、更新操作對(duì)象和時(shí)間的基類(lèi)等，在編寫(xiě)代碼時(shí)盡量依據(jù)該對(duì)象來(lái)操作，會(huì)簡(jiǎn)單很多。該對(duì)象的判斷使用

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

即可，根據(jù)語(yǔ)句執(zhí)行類(lèi)型選擇對(duì)應(yīng)字段的賦值。

如果參數(shù)不是實(shí)體，而且具體的參數(shù)，那么 Mybatis 也做了一些處理，比如 @Param("name") String name 類(lèi)型的參數(shù)，會(huì)被包裝成 Map 接口的實(shí)現(xiàn)來(lái)處理，即使是原始的 Map 也是如此。使用

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

即可，對(duì)具體統(tǒng)一的參數(shù)進(jìn)行賦值。

4. SqlCommandType 命令類(lèi)型

Executor 提供的方法中，update 包含了新增，修改和刪除類(lèi)型，無(wú)法直接區(qū)分，需要借助 MappedStatement 類(lèi)的屬性 SqlCommandType 來(lái)進(jìn)行判斷，該類(lèi)包含了所有的操作類(lèi)型

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

畢竟新增和修改的場(chǎng)景，有些參數(shù)是有區(qū)別的，比如創(chuàng)建時(shí)間和更新時(shí)間，update 時(shí)是無(wú)需兼顧創(chuàng)建時(shí)間字段的。

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

5. 實(shí)例

自己編寫(xiě)的小項(xiàng)目中，需要統(tǒng)一給數(shù)據(jù)庫(kù)字段屬性賦值：

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

dao 操作使用了實(shí)體和參數(shù)的方式，個(gè)人建議還是統(tǒng)一使用實(shí)體比較簡(jiǎn)單，易讀。

使用實(shí)體：

int add(BookEntity entity);

使用參數(shù)：

復(fù)制代碼代碼如下:

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;

/**
 * 全局?jǐn)r截?cái)?shù)據(jù)庫(kù)創(chuàng)建和更新
 * <p>
 * Signature 對(duì)應(yīng) Invocation 構(gòu)造器, type 為 Invocation.Object, method 為 Invocation.Method, args 為 Invocation.Object[]
 * method 對(duì)應(yīng)的 update 包括了最常用的 insert/update/delete 三種操作, 因此 update 本身無(wú)法直接判斷sql為何種執(zhí)行過(guò)程
 * args 包含了其余多有的操作信息, 按數(shù)組進(jìn)行存儲(chǔ), 不同的攔截方式有不同的參數(shù)順序, 具體看type接口的方法簽名, 然后根據(jù)簽名解析, 參見(jiàn)官網(wǎng)
 *
 * @link http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins 插件
 * <p>
 * MappedStatement 包括了SQL具體操作類(lèi)型, 需要通過(guò)該類(lèi)型判斷當(dāng)前sql執(zhí)行過(guò)程
 */
@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 {
    // 根據(jù)簽名指定的args順序獲取具體的實(shí)現(xiàn)類(lèi)
    // 1. 獲取MappedStatement實(shí)例, 并獲取當(dāng)前SQL命令類(lèi)型
    MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
    SqlCommandType commandType = ms.getSqlCommandType();

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

    // 3. 獲取當(dāng)前用戶信息
    UserEntity userEntity = UserUtil.getCurrentUser();
    // 默認(rèn)測(cè)試參數(shù)值
    int creator = 2, updater = 3;

    if (parameter instanceof BaseEntity) {
      // 4. 實(shí)體類(lèi)
      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 等包裝類(lèi)
      // 更新時(shí)指定某些字段的最新數(shù)據(jù)值
      if (commandType.equals(SqlCommandType.UPDATE)) {
        // 遍歷參數(shù)類(lèi)型, 檢查目標(biāo)參數(shù)值是否存在對(duì)象中, 該方式需要應(yīng)用編寫(xiě)有一些統(tǒng)一的規(guī)范
        // 否則均統(tǒng)一為實(shí)體對(duì)象, 就免去該重復(fù)操作
        Map map = (Map) parameter;
        if (map.containsKey("creator")) {
          map.put("creator", creator);
        }
        if (map.containsKey("updateTime")) {
          map.put("updateTime", DateUtil.getTimeStamp());
        }
      }
    }
    // 6. 均不是需要被攔截的類(lèi)型, 不做操作
    return invocation.proceed();
  }

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

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

6. 感受

其它幾種類(lèi)型，后面在看，尤其是分頁(yè)。

在編寫(xiě)代碼的過(guò)程中，有時(shí)候還是需要先知道對(duì)象的類(lèi)型，比如 Object.class 跟 Interface 一樣，很多時(shí)候僅僅代表一種數(shù)據(jù)類(lèi)型，需要明確知道后再進(jìn)行操作。

@Param 標(biāo)識(shí)的參數(shù)其實(shí)會(huì)被 Mybatis 封裝成 org.apache.ibatis.binding.MapperMethod$ParamMap 類(lèi)型，一開(kāi)始我就是使用

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

}

的方式獲取，以為這些都是對(duì)象的屬性，通過(guò)反射獲取并修改即可，實(shí)際上發(fā)現(xiàn)對(duì)象不存在這些屬性，但是打印出的信息中，明確有這些字段的，網(wǎng)上參考一些信息后，才知道這是一個(gè) Map 類(lèi)型，問(wèn)題才迎刃而解。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

Mybatis Interceptor 攔截器的實(shí)現(xiàn)

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具