《深入理解Mybatis原理》Mybatis插件機制&分頁機制原理详情 - 後端,java,mybatis 程序員Seven 日志

源碼分析

插件機制

首先我們看下MyBatis攔截器的接口定義：

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  Object plugin(Object target);

  void setProperties(Properties properties);

}

比較簡單，只有3個方法。 MyBatis默認沒有一個攔截器接口的實現類，開發者們可以實現符合自己需求的攔截器。下面的MyBatis官網的一個攔截器實例：

@Intercepts({@Signature(type= Executor.class, method = "update", args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  public Object intercept(Invocation invocation) throws Throwable {
    return invocation.proceed();
  }
  public Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }
  public void setProperties(Properties properties) {
  }
}

全局xml配置：

<plugins>
    <plugin interceptor="org.format.mybatis.cache.interceptor.ExamplePlugin"></plugin>
</plugins>

這個攔截器攔截Executor接口的update方法（其實也就是SqlSession的新增，刪除，修改操作），所有執行executor的update方法都會被該攔截器攔截到。

首先從源頭->配置文件開始分析：

XMLConfigBuilder解析MyBatis全局配置文件的pluginElement私有方法：

private void pluginElement(XNode parent) throws Exception {
    if (parent != null) {
        for (XNode child : parent.getChildren()) {
            String interceptor = child.getStringAttribute("interceptor");
            Properties properties = child.getChildrenAsProperties();
            Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();
            interceptorInstance.setProperties(properties);
            configuration.addInterceptor(interceptorInstance);
        }
    }
}

具體的解析代碼其實比較簡單，就不貼了，主要就是通過反射實例化plugin節點中的interceptor屬性表示的類。然後調用全局配置類Configuration的addInterceptor方法。

public void addInterceptor(Interceptor interceptor) {
    interceptorChain.addInterceptor(interceptor);
}

這個interceptorChain是Configuration的內部屬性，類型為InterceptorChain，也就是一個攔截器鏈，我們來看下它的定義：

public class InterceptorChain {

    private final List<Interceptor> interceptors = new ArrayList<Interceptor>();

    public Object pluginAll(Object target) {
        for (Interceptor interceptor : interceptors) {
            target = interceptor.plugin(target);
        }
        return target;
    }

    public void addInterceptor(Interceptor interceptor) {
        interceptors.add(interceptor);
    }

    public List<Interceptor> getInterceptors() {
        return Collections.unmodifiableList(interceptors);
    }

}

現在我們理解了攔截器配置的解析以及攔截器的歸屬，現在我們回過頭看下為何攔截器會攔截這些方法（Executor，ParameterHandler，ResultSetHandler，StatementHandler的部分方法）：

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
    ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
    parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
    return parameterHandler;
}

public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler, ResultHandler resultHandler, BoundSql boundSql) {
    ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
    resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
    return resultSetHandler;
}

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
    statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
    return statementHandler;
}

public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {
    executorType = executorType == null ? defaultExecutorType : executorType;
    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
    Executor executor;
    if (ExecutorType.BATCH == executorType) {
        executor = new BatchExecutor(this, transaction);
    } else if (ExecutorType.REUSE == executorType) {
        executor = new ReuseExecutor(this, transaction);
    } else {
        executor = new SimpleExecutor(this, transaction);
    }
    if (cacheEnabled) {
        executor = new CachingExecutor(executor, autoCommit);
    }
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
}

以上4個方法都是Configuration的方法。這些方法在MyBatis的一個操作(新增，刪除，修改，查詢)中都會被執行到，執行的先後順序是Executor，ParameterHandler，ResultSetHandler，StatementHandler(其中ParameterHandler和ResultSetHandler的創建是在創建StatementHandler[3個可用的實現類CallableStatementHandler,PreparedStatementHandler,SimpleStatementHandler]的時候，其構造函數調用的[這3個實現類的構造函數其實都調用了父類BaseStatementHandler的構造函數])。

這4個方法實例化了對應的對象之後，都會調用interceptorChain的pluginAll方法，InterceptorChain的pluginAll剛才已經介紹過了，就是遍歷所有的攔截器，然後調用各個攔截器的plugin方法。注意：攔截器的plugin方法的返回值會直接被賦值給原先的對象。

由於可以攔截StatementHandler，這個接口主要處理sql語法的構建，因此比如分頁的功能，可以用攔截器實現，只需要在攔截器的plugin方法中處理StatementHandler接口實現類中的sql即可，可使用反射實現。

MyBatis還提供了@Intercepts和 @Signature關於攔截器的註解。官網的例子就是使用了這2個註解，還包括了Plugin類的使用：

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

代理鏈的生成

Mybatis支持對Executor、StatementHandler、ParameterHandler和ResultSetHandler進行攔截，也就是説會對這4種對象進行代理。通過查看Configuration類的源代碼我們可以看到，每次都對目標對象進行代理鏈的生成。

下面以Executor為例。Mybatis在創建Executor對象時會執行下面一行代碼：

executor =(Executor) interceptorChain.pluginAll(executor);

InterceptorChain裏保存了所有的攔截器，它在mybatis初始化的時候創建。上面這句代碼的含義是調用攔截器鏈裏的每個攔截器依次對executor進行plugin（插入？）代碼如下：

 /** 
  * 每一個攔截器對目標類都進行一次代理 
  * @param target 
  * @return 層層代理後的對象 
  */  
 public Object pluginAll(Object target) {  
     for(Interceptor interceptor : interceptors) {  
         target= interceptor.plugin(target);  
     }  
     return target;  
 }

下面以一個簡單的例子來看看這個plugin方法裏到底發生了什麼：

@Intercepts({@Signature(type = Executor.class, method ="update", args = {MappedStatement.class, Object.class})})  
public class ExamplePlugin implements Interceptor {  
    @Override  
    public Object intercept(Invocation invocation) throws Throwable {  
        return invocation.proceed();  
    }  
  
    @Override  
    public Object plugin(Object target) {  
        return Plugin.wrap(target, this);  
    }  
  
    @Override  
    public void setProperties(Properties properties) {  
    }
}

每一個攔截器都必須實現上面的三個方法，其中：

Object intercept(Invocation invocation)是實現攔截邏輯的地方，內部要通過invocation.proceed()顯式地推進責任鏈前進，也就是調用下一個攔截器攔截目標方法。
Object plugin(Object target) 就是用當前這個攔截器生成對目標target的代理，實際是通過Plugin.wrap(target,this)來完成的，把目標target和攔截器this傳給了包裝函數。
setProperties(Properties properties)用於設置額外的參數，參數配置在攔截器的Properties節點裏。

註解裏描述的是指定攔截方法的簽名 [type,method,args] （即對哪種對象的哪種方法進行攔截），它在攔截前用於決斷。

定義自己的Interceptor最重要的是要實現plugin方法和intercept方法，在plugin方法中我們可以決定是否要進行攔截進而決定要返回一個什麼樣的目標對象。而intercept方法就是要進行攔截的時候要執行的方法。

對於plugin方法而言，其實Mybatis已經為我們提供了一個實現。Mybatis中有一個叫做Plugin的類，裏面有一個靜態方法wrap(Object target,Interceptor interceptor)，通過該方法可以決定要返回的對象是目標對象還是對應的代理。這裏我們先來看一下Plugin的源碼：

package org.apache.ibatis.plugin;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import org.apache.ibatis.reflection.ExceptionUtil;

//這個類是Mybatis攔截器的核心,大家可以看到該類繼承了InvocationHandler
//又是JDK動態代理機制
public class Plugin implements InvocationHandler {

  //目標對象
  private Object target;
  //攔截器
  private Interceptor interceptor;
  //記錄需要被攔截的類與方法
  private Map<Class<?>, Set<Method>> signatureMap;

  private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
    this.target = target;
    this.interceptor = interceptor;
    this.signatureMap = signatureMap;
  }

  //一個靜態方法,對一個目標對象進行包裝，生成代理類。
  public static Object wrap(Object target, Interceptor interceptor) {
    //首先根據interceptor上面定義的註解 獲取需要攔截的信息
    Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
    //目標對象的Class
    Class<?> type = target.getClass();
    //返回需要攔截的接口信息
    Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
    //如果長度為>0 則返回代理類 否則不做處理
    if (interfaces.length > 0) {
      return Proxy.newProxyInstance(
          type.getClassLoader(),
          interfaces,
          new Plugin(target, interceptor, signatureMap));
    }
    return target;
  }

  //代理對象每次調用的方法
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      //通過method參數定義的類 去signatureMap當中查詢需要攔截的方法集合
      Set<Method> methods = signatureMap.get(method.getDeclaringClass());
      //判斷是否需要攔截
      if (methods != null && methods.contains(method)) {
        return interceptor.intercept(new Invocation(target, method, args));
      }
      //不攔截 直接通過目標對象調用方法
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
  }

  //根據攔截器接口（Interceptor）實現類上面的註解獲取相關信息
  private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    //獲取註解信息
    Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
    //為空則拋出異常
    if (interceptsAnnotation == null) { // issue #251
      throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());      
    }
    //獲得Signature註解信息
    Signature[] sigs = interceptsAnnotation.value();
    Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
    //循環註解信息
    for (Signature sig : sigs) {
      //根據Signature註解定義的type信息去signatureMap當中查詢需要攔截方法的集合
      Set<Method> methods = signatureMap.get(sig.type());
      //第一次肯定為null 就創建一個並放入signatureMap
      if (methods == null) {
        methods = new HashSet<Method>();
        signatureMap.put(sig.type(), methods);
      }
      try {
        //找到sig.type當中定義的方法 並加入到集合
        Method method = sig.type().getMethod(sig.method(), sig.args());
        methods.add(method);
      } catch (NoSuchMethodException e) {
        throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
      }
    }
    return signatureMap;
  }

  //根據對象類型與signatureMap獲取接口信息
  private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
    Set<Class<?>> interfaces = new HashSet<Class<?>>();
    //循環type類型的接口信息 如果該類型存在與signatureMap當中則加入到set當中去
    while (type != null) {
      for (Class<?> c : type.getInterfaces()) {
        if (signatureMap.containsKey(c)) {
          interfaces.add(c);
        }
      }
      type = type.getSuperclass();
    }
    //轉換為數組返回
    return interfaces.toArray(new Class<?>[interfaces.size()]);
  }

}

下面是倆個註解類的定義源碼：

package org.apache.ibatis.plugin;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Intercepts {
  Signature[] value();
}
package org.apache.ibatis.plugin;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Signature {
  Class<?> type();

  String method();

  Class<?>[] args();
}

Plugin.wrap方法

從前面可以看出，每個攔截器的plugin方法是通過調用Plugin.wrap方法來實現的。代碼如下：

public static Object wrap(Object target, Interceptor interceptor) {  
   // 從攔截器的註解中獲取攔截的類名和方法信息  
   Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);  
   Class<?> type = target.getClass();  
   // 解析被攔截對象的所有接口（注意是接口）  
   Class<?>[] interfaces = getAllInterfaces(type, signatureMap);  
   if(interfaces.length > 0) {  
        // 生成代理對象， Plugin對象為該代理對象的InvocationHandler  （InvocationHandler屬於java代理的一個重要概念，不熟悉的請參考相關概念）  
        return Proxy.newProxyInstance(type.getClassLoader(), interfaces, new Plugin(target,interceptor,signatureMap));  
    }  
    return target;  
}

這個Plugin類有三個屬性：

private Object target;// 被代理的目標類

private Interceptor interceptor;// 對應的攔截器

private Map<Class<?>, Set<Method>> signatureMap;// 攔截器攔截的方法緩存

getSignatureMap方法：

private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
    if (interceptsAnnotation == null) { // issue #251
      throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());      
    }
    Signature[] sigs = interceptsAnnotation.value();
    Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
    for (Signature sig : sigs) {
      Set<Method> methods = signatureMap.get(sig.type());
      if (methods == null) {
        methods = new HashSet<Method>();
        signatureMap.put(sig.type(), methods);
      }
      try {
        Method method = sig.type().getMethod(sig.method(), sig.args());
        methods.add(method);
      } catch (NoSuchMethodException e) {
        throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
      }
    }
    return signatureMap;
}

getSignatureMap方法解釋：首先會拿到攔截器這個類的 @Interceptors註解，然後拿到這個註解的屬性 @Signature註解集合，然後遍歷這個集合，遍歷的時候拿出 @Signature註解的type屬性(Class類型)，然後根據這個type得到帶有method屬性和args屬性的Method。由於 @Interceptors註解的 @Signature屬性是一個屬性，所以最終會返回一個以type為key，value為Set<Method>的Map。

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

比如這個 @Interceptors註解會返回一個key為Executor，value為集合(這個集合只有一個元素，也就是Method實例，這個Method實例就是Executor接口的update方法，且這個方法帶有MappedStatement和Object類型的參數)。這個Method實例是根據 @Signature的method和args屬性得到的。如果args參數跟type類型的method方法對應不上，那麼將會拋出異常。

getAllInterfaces方法：

private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
    Set<Class<?>> interfaces = new HashSet<Class<?>>();
    while (type != null) {
      for (Class<?> c : type.getInterfaces()) {
        if (signatureMap.containsKey(c)) {
          interfaces.add(c);
        }
      }
      type = type.getSuperclass();
    }
    return interfaces.toArray(new Class<?>[interfaces.size()]);
}

getAllInterfaces方法解釋：根據目標實例target(這個target就是之前所説的MyBatis攔截器可以攔截的類，Executor,ParameterHandler,ResultSetHandler,StatementHandler)和它的父類們，返回signatureMap中含有target實現的接口數組。

所以Plugin這個類的作用就是根據 @Interceptors註解，得到這個註解的屬性 @Signature數組，然後根據每個 @Signature註解的type，method，args屬性使用反射找到對應的Method。最終根據調用的target對象實現的接口決定是否返回一個代理對象替代原先的target對象。

我們再次結合(Executor)interceptorChain.pluginAll(executor)這個語句來看，這個語句內部對executor執行了多次plugin,第一次plugin後通過Plugin.wrap方法生成了第一個代理類，姑且就叫executorProxy1，這個代理類的target屬性是該executor對象。第二次plugin後通過Plugin.wrap方法生成了第二個代理類，姑且叫executorProxy2，這個代理類的target屬性是executorProxy1...這樣通過每個代理類的target屬性就構成了一個代理鏈（從最後一個executorProxyN往前查找，通過target屬性可以找到最原始的executor類）。

代理鏈上的攔截

代理鏈生成後，對原始目標的方法調用都轉移到代理者的invoke方法上來了。Plugin作為InvocationHandler的實現類，他的invoke方法是怎麼樣的呢？

比如MyBatis官網的例子，當Configuration調用newExecutor方法的時候，由於Executor接口的update(MappedStatement ms, Object parameter)方法被攔截器被截獲。因此最終返回的是一個代理類Plugin，而不是Executor。這樣調用方法的時候，如果是個代理類，那麼會執行：

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {  
    try {  
       Set<Method> methods = signatureMap.get(method.getDeclaringClass());  
        if(methods != null && methods.contains(method)) {  
           // 調用代理類所屬攔截器的intercept方法，  
           return interceptor.intercept(new Invocation(target, method, args));  
        }  
        return method.invoke(target, args);  
    } catch(Exception e) {  
        throw ExceptionUtil.unwrapThrowable(e);  
    }  
}

沒錯，如果找到對應的方法被代理之後，那麼會執行Interceptor接口的interceptor方法。

在invoke裏，如果方法簽名和攔截中的簽名一致，就調用攔截器的攔截方法。我們看到傳遞給攔截器的是一個Invocation對象，這個對象是什麼樣子的，他的功能又是什麼呢？

public class Invocation {  
  
    private Object target;  
    private Method method;  
    private Object[] args;  
   
    public Invocation(Object target, Method method, Object[] args) {  
        this.target =target;  
        this.method =method;  
        this.args =args;  
    }  
    ...  
  
    public Object proceed() throws InvocationTargetException, IllegalAccessException {  
        return method.invoke(target, args);  
    }  
}

可以看到，Invocation類保存了代理對象的目標類，執行的目標類方法以及傳遞給它的參數。

在每個攔截器的intercept方法內，最後一個語句一定是return invocation.proceed()（不這麼做的話攔截器鏈就斷了，你的mybatis基本上就不能正常工作了）。invocation.proceed()只是簡單的調用了下target的對應方法，如果target還是個代理，就又回到了上面的Plugin.invoke方法了。這樣就形成了攔截器的調用鏈推進。

public Object intercept(Invocation invocation) throws Throwable {  
    //完成代理類本身的邏輯  
    ...
    //通過invocation.proceed()方法完成調用鏈的推進
    return invocation.proceed();
}

小結

MyBatis攔截器接口提供的3個方法中，plugin方法用於某些處理器(Handler)的構建過程。interceptor方法用於處理代理類的執行。setProperties方法用於攔截器屬性的設置。

其實MyBatis官網提供的使用 @Interceptors和 @Signature註解以及Plugin類這樣處理攔截器的方法，我們不一定要直接這樣使用。我們也可以拋棄這3個類，直接在plugin方法內部根據target實例的類型做相應的操作。

總體來説MyBatis攔截器還是很簡單的，攔截器本身不需要太多的知識點，但是學習攔截器需要對MyBatis中的各個接口很熟悉，因為攔截器涉及到了各個接口的知識點。

我們假設在MyBatis配置了一個插件，在運行時會發生什麼？

所有可能被攔截的處理類都會生成一個代理
處理類代理在執行對應方法時，判斷要不要執行插件中的攔截方法
執行插接中的攔截方法後，推進目標的執行
如果有N個插件，就有N個代理，每個代理都要執行上面的邏輯。這裏面的層層代理要多次生成動態代理，是比較影響性能的。雖然能指定插件攔截的位置，但這個是在執行方法時動態判斷，初始化的時候就是簡單的把插件包裝到了所有可以攔截的地方。

因此，在編寫插件時需注意以下幾個原則：

不編寫不必要的插件；
實現plugin方法時判斷一下目標類型，是本插件要攔截的對象才執行Plugin.wrap方法，否者直接返回目標本省，這樣可以減少目標被代理的次數。

分頁機制

為什麼在StatementHandler攔截

在前面章節介紹了一次sqlsession的完整執行過程，從中可以知道sql的解析是在StatementHandler裏完成的，所以為了重寫sql需要攔截StatementHandler。

MetaObject簡介

在實現裏大量使用了MetaObject這個對象，因此有必要先介紹下它。MetaObject是Mybatis提供的一個的工具類，通過它包裝一個對象後可以獲取或設置該對象的原本不可訪問的屬性（比如那些私有屬性）。它有個三個重要方法經常用到：

MetaObject forObject(Object object,ObjectFactory objectFactory, ObjectWrapperFactory objectWrapperFactory) 用於包裝對象；
Object getValue(String name) 用於獲取屬性的值（支持OGNL的方法）；
void setValue(String name, Object value) 用於設置屬性的值（支持OGNL的方法）；

攔截器簽名

@Intercepts({@Signature(type =StatementHandler.class, method = "prepare", args ={Connection.class})})  
public class PageInterceptor implements Interceptor {  
    ...  
}

從簽名裏可以看出，要攔截的目標類型是StatementHandler（注意：type只能配置成接口類型），攔截的方法是名稱為prepare參數為Connection類型的方法。

intercept實現

public Object intercept(Invocation invocation) throws Throwable {  
     StatementHandler statementHandler = (StatementHandler) invocation.getTarget();  
     MetaObject metaStatementHandler = MetaObject.forObject(statementHandler,  
     DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
     // 分離代理對象鏈(由於目標類可能被多個攔截器攔截，從而形成多次代理，通過下面的兩次循環  
     // 可以分離出最原始的的目標類)  
     while (metaStatementHandler.hasGetter("h")) {  
         Object object = metaStatementHandler.getValue("h");  
         metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY,   
         DEFAULT_OBJECT_WRAPPER_FACTORY);  
     }  
     // 分離最後一個代理對象的目標類  
     while (metaStatementHandler.hasGetter("target")) {  
         Object object = metaStatementHandler.getValue("target");  
         metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY,   
         DEFAULT_OBJECT_WRAPPER_FACTORY);  
     }  
     Configuration configuration = (Configuration) metaStatementHandler.  
     getValue("delegate.configuration");  
     dialect = configuration.getVariables().getProperty("dialect");  
     if (null == dialect || "".equals(dialect)) {  
         logger.warn("Property dialect is not setted,use default 'mysql' ");  
         dialect = defaultDialect;  
     }  
     pageSqlId = configuration.getVariables().getProperty("pageSqlId");  
     if (null == pageSqlId || "".equals(pageSqlId)) {  
         logger.warn("Property pageSqlId is not setted,use default '.*Page$' ");  
         pageSqlId = defaultPageSqlId;  
     }  
     MappedStatement mappedStatement = (MappedStatement)   
     metaStatementHandler.getValue("delegate.mappedStatement");  
     // 只重寫需要分頁的sql語句。通過MappedStatement的ID匹配，默認重寫以Page結尾的  
     //  MappedStatement的sql  
     if (mappedStatement.getId().matches(pageSqlId)) {  
         BoundSql boundSql = (BoundSql) metaStatementHandler.getValue("delegate.boundSql");  
         Object parameterObject = boundSql.getParameterObject();  
         if (parameterObject == null) {  
             throw new NullPointerException("parameterObject is null!");  
         } else {  
             // 分頁參數作為參數對象parameterObject的一個屬性  
             PageParameter page = (PageParameter) metaStatementHandler  
                     .getValue("delegate.boundSql.parameterObject.page");  
             String sql = boundSql.getSql();  
             // 重寫sql  
             String pageSql = buildPageSql(sql, page);  
             metaStatementHandler.setValue("delegate.boundSql.sql", pageSql);  
             // 採用物理分頁後，就不需要mybatis的內存分頁了，所以重置下面的兩個參數  
             metaStatementHandler.setValue("delegate.rowBounds.offset",   
             RowBounds.NO_ROW_OFFSET);  
             metaStatementHandler.setValue("delegate.rowBounds.limit", RowBounds.NO_ROW_LIMIT);  
             Connection connection = (Connection) invocation.getArgs()[0];  
             // 重設分頁參數裏的總頁數等  
             setPageParameter(sql, connection, mappedStatement, boundSql, page);  
         }  
     }  
     // 將執行權交給下一個攔截器  
     return invocation.proceed();  
}

StatementHandler的默認實現類是RoutingStatementHandler，因此攔截的實際對象是它。RoutingStatementHandler的主要功能是分發，它根據配置Statement類型創建真正執行數據庫操作的StatementHandler，並將其保存到delegate屬性裏。由於delegate是一個私有屬性並且沒有提供訪問它的方法，因此需要藉助MetaObject的幫忙。通過MetaObject的封裝後我們可以輕易的獲得想要的屬性。

在上面的方法裏有個兩個循環，通過他們可以分離出原始的RoutingStatementHandler（而不是代理對象）。

前面提到，簽名裏配置的要攔截的目標類型是StatementHandler攔截的方法是名稱為prepare參數為Connection類型的方法，而這個方法是每次數據庫訪問都要執行的。因為我是通過重寫sql的方式實現分頁，為了不影響其他sql（update或不需要分頁的query），我採用了通過ID匹配的方式過濾。默認的過濾方式只對id以Page結尾的進行攔截（注意區分大小寫），如下：

<select id="queryUserByPage" parameterType="UserDto" resultType="UserDto">  
    <![CDATA[ 
    select * from t_user t where t.username = #{username} 
    ]]>  
</select>

當然，也可以自定義攔截模式，在mybatis的配置文件里加入以下配置項：

<properties>  
    <property name="dialect" value="mysql" />  
    <property name="pageSqlId" value=".*Page$" />  
</properties>

其中，屬性dialect指示數據庫類型，目前只支持mysql和oracle兩種數據庫。其中，屬性pageSqlId指示攔截的規則，以正則方式匹配。

sql重寫

sql重寫其實在原始的sql語句上加入分頁的參數，目前支持mysql和oracle兩種數據庫的分頁。

private String buildPageSql(String sql, PageParameter page) {  
    if (page != null) {  
        StringBuilder pageSql = new StringBuilder();  
        if ("mysql".equals(dialect)) {  
            pageSql = buildPageSqlForMysql(sql, page);  
        } else if ("oracle".equals(dialect)) {  
            pageSql = buildPageSqlForOracle(sql, page);  
        } else {  
            return sql;  
        }  
        return pageSql.toString();  
    } else {  
        return sql;  
    }  
}

mysql的分頁實現：

public StringBuilder buildPageSqlForMysql(String sql, PageParameter page) {  
    StringBuilder pageSql = new StringBuilder(100);  
    String beginrow = String.valueOf((page.getCurrentPage() - 1) * page.getPageSize());  
    pageSql.append(sql);  
    pageSql.append(" limit " + beginrow + "," + page.getPageSize());  
    return pageSql;  
}

oracle的分頁實現：

public StringBuilder buildPageSqlForOracle(String sql, PageParameter page) {  
    StringBuilder pageSql = new StringBuilder(100);  
    String beginrow = String.valueOf((page.getCurrentPage() - 1) * page.getPageSize());  
    String endrow = String.valueOf(page.getCurrentPage() * page.getPageSize());  
    pageSql.append("select * from ( select temp.*, rownum row_id from ( ");  
    pageSql.append(sql);  
    pageSql.append(" ) temp where rownum <= ").append(endrow);  
    pageSql.append(") where row_id > ").append(beginrow);  
    return pageSql;  
}

分頁參數重寫

有時候會有這種需求，就是不但要查出指定頁的結果，還需要知道總的記錄數和頁數。我通過重寫分頁參數的方式提供了一種解決方案：

/** 
 * 從數據庫裏查詢總的記錄數並計算總頁數，回寫進分頁參數<code>PageParameter</code>,這樣調用  
 * 者就可用通過 分頁參數<code>PageParameter</code>獲得相關信息。 
 *  
 * @param sql 
 * @param connection 
 * @param mappedStatement 
 * @param boundSql 
 * @param page 
 */  
private void setPageParameter(String sql, Connection connection, MappedStatement mappedStatement,  
        BoundSql boundSql, PageParameter page) {  
    // 記錄總記錄數  
    String countSql = "select count(0) from (" + sql + ") as total";  
    PreparedStatement countStmt = null;  
    ResultSet rs = null;  
    try {  
        countStmt = connection.prepareStatement(countSql);  
        BoundSql countBS = new BoundSql(mappedStatement.getConfiguration(), countSql,  
                boundSql.getParameterMappings(), boundSql.getParameterObject());  
        setParameters(countStmt, mappedStatement, countBS, boundSql.getParameterObject());  
        rs = countStmt.executeQuery();  
        int totalCount = 0;  
        if (rs.next()) {  
            totalCount = rs.getInt(1);  
        }  
        page.setTotalCount(totalCount);  
        int totalPage = totalCount / page.getPageSize() + ((totalCount % page.getPageSize() == 0) ? 0 : 1);  
        page.setTotalPage(totalPage);  
    } catch (SQLException e) {  
        logger.error("Ignore this exception", e);  
    } finally {  
        try {  
            rs.close();  
        } catch (SQLException e) {  
            logger.error("Ignore this exception", e);  
        }  
        try {  
            countStmt.close();  
        } catch (SQLException e) {  
            logger.error("Ignore this exception", e);  
        }  
    }  
}  
  
/** 
 * 對SQL參數(?)設值 
 *  
 * @param ps 
 * @param mappedStatement 
 * @param boundSql 
 * @param parameterObject 
 * @throws SQLException 
 */  
private void setParameters(PreparedStatement ps, MappedStatement mappedStatement, BoundSql boundSql,  
        Object parameterObject) throws SQLException {  
    ParameterHandler parameterHandler = new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);  
    parameterHandler.setParameters(ps);  
}

plugin實現

public Object plugin(Object target) {  
    // 當目標類是StatementHandler類型時，才包裝目標類，否者直接返回目標本身,減少目標被代理的  
    // 次數  
    if (target instanceof StatementHandler) {  
        return Plugin.wrap(target, this);  
    } else {  
        return target;  
    }  
}

程序員Seven 日志

@seven97_top

标签

後端 (618)

JAVA (556)

MySQL (192)

springboot (120)

redis (93)

設計模式 (50)

netty (33)

leetcode (32)

Mybatis (27)

rabbitmq (20)

maven (18)

动态

《深入理解Mybatis原理》Mybatis插件機制&分頁機制原理 - 动态详情

源碼分析

插件機制

代理鏈的生成

Plugin.wrap方法

代理鏈上的攔截

小結

分頁機制

為什麼在StatementHandler攔截

MetaObject簡介

攔截器簽名

intercept實現

sql重寫

分頁參數重寫

plugin實現

Add a new 评论

程序員Seven 日志

@seven97_top

标签

後端 (618)

JAVA (556)

MySQL (192)

springboot (120)

redis (93)

設計模式 (50)

netty (33)

leetcode (32)

Mybatis (27)

rabbitmq (20)

maven (18)

动态

《深入理解Mybatis原理》Mybatis插件機制&分頁機制原理 - 动态 详情

源碼分析

插件機制

代理鏈的生成

Plugin.wrap方法

代理鏈上的攔截

小結

分頁機制

為什麼在StatementHandler攔截

MetaObject簡介

攔截器簽名

intercept實現

sql重寫

分頁參數重寫

plugin實現

Add a new 评论

《深入理解Mybatis原理》Mybatis插件機制&分頁機制原理 - 动态详情