Mybatis分頁插件

Mybatis插件介紹

為了提高M(jìn)ybatis的可擴(kuò)展能力，Mybatis引入的插件機(jī)制，允許開發(fā)人員通過責(zé)任鏈編程的方式對目標(biāo)類進(jìn)行代理。通過閱讀源碼可知，Mybatis允許開發(fā)人員對Mybatis中的Executor、ParameterHandler、StatementHandler、ResultHandler進(jìn)行代理。有一點AOP的味道。

Interceptor（攔截器）

Mybatis通過Interceptor來定義一個攔截器，Interceptor在Mybatis中是一個很重要的接口，通過這個接口我們可以對前面提高的四個類進(jìn)行攔截，從而可以在這些類方法執(zhí)行前后加入我們寫的攔截邏輯。下面我們來看看Interceptor是如何定義的：

public interface Interceptor { 
 Object intercept(Invocation invocation) throws Throwable; 
 Object plugin(Object target); 
 void setProperties(Properties properties);
}

這個類定義的三個方法：

intercept：這個方法用于實現(xiàn)主要的攔截邏輯。方法的入?yún)⑹且粋€Invocation類的實例，Invocation代表目標(biāo)類的一次調(diào)用，通過它我們可以獲得被攔截的目標(biāo)類，被攔截的方法以及方法的入?yún)ⅰntercept方法放回一個Object實例。
plugin：這個方法用來判定是否要對目標(biāo)類進(jìn)行攔截，也就是說是否返回被攔截類本身還是返回被攔截類的一個代理。這個方法可以與Mybatis中的Plugin類配合使用，有關(guān)Plugin類的用法后面會講到。
setProperties：這個方法主要用來獲取在Mybatis中配置的系統(tǒng)屬性。

Plugin

我們在描述Interceptor中的plugin方法時，我們提到過該類，這個類主要的作用是通過在目標(biāo)類上使用注解的方式來決定是否要對目標(biāo)類進(jìn)行代理。'Talk is cheep, show me the code.'，下面我們就來看看Plugin的實現(xiàn)：
通過Plugin類的簽名我們可以看到這個類實現(xiàn)了InvocationHandler接口，并且定義了target、interceptor、signatureMap三個實例變量。

Interceptor.png

wrap方法傳入一個目標(biāo)對象和一個攔截器對象，首先通過getAllInterfaces這個方法獲取目標(biāo)類所時間的接口，然后根據(jù)接口的數(shù)量來決定是否要目標(biāo)的一個代理。

Interceptor.wrap.png

Plugin中invoke方法首先獲取目標(biāo)類被攔截的方法，如果是被攔截的方法則調(diào)用攔截器的intercept方法，所以要使攔截器鏈繼續(xù)沿著鏈路調(diào)用下去，則在攔截器中需要調(diào)用Invocation.proceed的方法。

Interceptor.invoke.png

getSignatureMap主要用來獲取攔截器上的Intercepts注解，根據(jù)注解的值來獲取攔截器想攔截的目標(biāo)對象。我們可以看一下Intercepts的定義：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Intercepts {  Signature[] value();}

Signature的定義：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Signature {  
    Class<?> type();  String method();  Class<?>[] args();
}

Interceptor.getSignatureMap.png

說了這么多有關(guān)Mybatis插件的實現(xiàn)，那我們應(yīng)該如何使用Mybatis的插件呢？

Interceptor的使用

下面我們實現(xiàn)一個簡單攔截器HelloWorldIntercetor：

/** * 對StatementHandler的prepare方法進(jìn)行攔截 */
@Intercepts(        
@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}))
public class HelloWorldInterceptor implements Interceptor {    
    @Override    
    public Object intercept(Invocation invocation) throws Throwable { 
      System.out.println("I'm HelloWorld Interceptor");                          
      return invocation.proceed();   
 }    
    @Override    
    public Object plugin(Object target) {        
      return Plugin.wrap(target, this);   
   }    
    @Override    
    public void setProperties(Properties properties) {  
      System.out.println(properties.get("prop1"));              
    }
}

然后在Mybatis的的配置文件中配置：

<properties>
    <property name="prop1" value="prop1"/>
</properties>
<plugins>   
     <plugin interceptor="mybatis.interceptor.HelloWorldInterceptor" /
</plugins>

如與Spring集成的話則在配置SqlSessionFactoryBean時進(jìn)行配置如下：

<property name="plugins">
    <array>        
      <bean class="mybatis.interceptor.HelloWorldInterceptor" />    
    </array>
</property>
    <property name="configurationProperties">    
      <props>        
        <prop key="prop1">prop1</prop>    
    </props>
</property>

通過前面的講解我們大致了解了Mybatis插件的配置使用和原理。下面我們就來看看如何寫一個Mybatis的分頁插件呢?