MyBatis之簡單了解Plugin

MyBatis的Configuration配置中有一個Plugin配置，根據其名可以解釋為“插件”，這個插件實質可以理解為“攔截器”。“攔截器”這個名詞不陌生，在眾多框架中均有“攔截器”。這個Plugin有什么用呢？活着說攔截器有什么用呢？可以想想攔截器是怎么實現的。Plugin用到了Java中很重要的一個特性——動態代理。所以這個Plugin可以理解為，在調用一個方法時，我“攔截”其方法做一些我想讓它做的事。它可以攔截以下方法：

在官方文檔中有這么一句話：If you attempt to modify or override the behaviour of a given method, you’re likely to break the core of MyBatis. 謹慎使用自定義Plugin攔截器，因為它可能修改Mybatis核心的東西。實現自定義Plugin我們需要實現 Interceptor接口。並未這個類注解@Intercepts。

package day_8_mybatis.util;

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

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;

/**
 * @author turbo
 *
 * 2016年10月25日
 */
@Intercepts({
    @Signature(
        type = Map.class,
        method = "get",
        args = {Object.class}
)})
public class ExamplePlugin implements Interceptor {

    /* 此方法用於實現攔截邏輯
     * @see org.apache.ibatis.plugin.Interceptor#intercept(org.apache.ibatis.plugin.Invocation)
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        
        return "ExamplePlugin";
    }

    /* 使用當前的這個攔截器實現對目標對象的代理（內部實現時Java的動態代理）
     * @see org.apache.ibatis.plugin.Interceptor#plugin(java.lang.Object)
     */
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    /* 此方法和上一節所講的自定義對象工廠中的setProperties一樣，初始化Configuration時通過配置文件配置property傳遞參數給此方法並調用。
     * @see org.apache.ibatis.plugin.Interceptor#setProperties(java.util.Properties)
     */
    @Override
    public void setProperties(Properties properties) {　　
        Iterator iterator = properties.keySet().iterator();
        while (iterator.hasNext()){
            String keyValue = String.valueOf(iterator.next());
            System.out.println(properties.getProperty(keyValue));
        }
    }

}

別忘了在mybatis-config.xml的配置文件中注冊自定義Plugin。（下面的配置中有一些遺留代碼，是在上兩節中的配置，可以選擇性的忽略。）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration  
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
  
<configuration>
<!-- 注意configuration中各個屬性配置的順序應為：properties,settings,typeAliases,typeHandlers,objectFactory,objectWrapperFactory,reflectorFactory,plugins,environments,databaseIdProvider,mappers)-->
    <properties>
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/test"/>    
        <property name="username" value="root"/>
        <property name="password" value="0000"/>
    </properties>
    <!-- 
    <typeHandlers>
        <typeHandler handler="day_8_mybatis.util.ExampleTypeHandler" javaType="java.util.Date" jdbcType="VARCHAR"/>
    </typeHandlers>
    <objectFactory type="day_8_mybatis.util.ExampleObjectFactory">
        <property name="someProperty" value="100"/>
    </objectFactory>
     -->
    <plugins>
        <plugin interceptor="day_8_mybatis.util.ExamplePlugin">
            <property name="someProperty" value="100"/>
        </plugin>
    </plugins>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>            
        </environment>
    </environments> 
    <mappers>
        <mapper resource="day_8_mybatis/mapper/UserMapper.xml"/>
        <mapper resource="day_8_mybatis/mapper/NoteMapper.xml"/>
    </mappers>    
    
</configuration>

 

客戶端測試代碼：

package day_8_mybatis;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import org.apache.ibatis.session.SqlSession;

import day_8_mybatis.util.ExamplePlugin;
import day_8_mybatis.util.SessionFactory;

/**
 * 客戶端
 * @author turbo
 *
 * 2016年10月25日
 */
public class Main {

    /**
     * @param args
     * @throws IOException 
     */
    public static void main(String[] args) throws Exception {
        String resource = "day_8_mybatis/mybatis-config.xml";        //獲取mybatis配置文件路徑
        SqlSession sqlSession = SessionFactory.getSqlSession(resource);    //通過SessionFactory工具類（此工具類為自己構造即util包中的SessionFactory）構造SqlSession
        
        Map map = new HashMap();
        map = (Map)new ExamplePlugin().plugin(map);
        System.out.println(map.get(""));

    }

}

至此，我們就簡單的了解了MyBatis中的Plugin。有興趣的可以看看我們在客戶端測試代碼中的第29行所調用的plugin方法。即調用了Plugin類的靜態方法wrap(Object target, Interceptor intercpetor)，追蹤該方法會發現，此方法即是Java的動態代理。

public static Object wrap(Object target, Interceptor interceptor)
    {
        Map signatureMap = getSignatureMap(interceptor);
        Class type = target.getClass();
        Class interfaces[] = getAllInterfaces(type, signatureMap);
        if(interfaces.length > 0)
            return Proxy.newProxyInstance(type.getClassLoader(), interfaces, new Plugin(target, interceptor, signatureMap));　　//返回代理類實例
        else
            return target;
    }

動態代理很重要，反射很重要。一定要反復理解領會動態代理以及反射，這對我們讀懂很多框架源代碼有很大幫助。這篇僅僅簡單了解，不做過多的深入。