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;
     }

动态代理很重要，反射很重要。一定要反复理解领会动态代理以及反射，这对我们读懂很多框架源代码有很大帮助。这篇仅仅简单了解，不做过多的深入。