Mybatis 插件使用及源码分析

Mybatis 插件

Mybatis插件主要是通过JDK动态代理实现的，插件可以针对接口中的方法进行代理增强，在Mybatis中比较重要的接口如下：

• Executor ：sql执行器，包含多个实现类，比如SimpleExecutor
  
• StatementHander： sql语句处理器，用于将sql语句与Statement的映射，实现类有：PrepareStatementHandler、SimpleStatementHandler、CallBackStatementHandler
  
• ParameterHandler：用于参数处理，将传入的参数一一的解析并将类型解析出来，会用到TypeHandler,最终这些数据会用于StatementHandler进行数据的映射，比如？对应的值的映射
  
• ResultSetHandler：结果值的处理器，用于数据在查询出来之后，将数据通过ResultSet把数据映射给返回值类型的类上，通过反射（内省）处理映射数据
  

Mybatis插件的使用

Mybatis插件使用通过@Intercepts注解进行接口的绑定，如下定义一个插件类

1. /**
2. * @author <a target="_blank" href="https://www.cnblogs.com/2360564660@qq.com">redwinter</a>
3. * @since 1.0
4. **/
5. @Intercepts({@Signature(
6.         type = StatementHandler.class,
7.         method = "prepare",
8.         args = {Connection.class, Integer.class}
9. )})
10. @Slf4j
11. public class MyPlugin implements Interceptor {
13.     @Override
14.     public Object intercept(Invocation invocation) throws Throwable {
15.         log.info("对方法进行增强....");
16.         return invocation.proceed();
17.     }
19.     @Override
20.     public Object plugin(Object target) {
21.         return Plugin.wrap(target, this);
22.     }
24.     @Override
25.     public void setProperties(Properties properties) {
26.         log.info("获取属性值：{}", properties);
27.     }
28. }

复制代码

然后需要将定义的插件配置mybatis的配置文件中：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
3. <configuration>
5.    
6.     <properties resource="db.properties"/>
7.    
8.     <settings>
9.         
10.         <setting name="logImpl" value="STDOUT_LOGGING" />
11.         
12.         <setting name="cacheEnabled" value="true"/>
13.     </settings>
15.     <typeAliases>
16.         <package name="com.redwinter.study.mybatis.model"/>
17.     </typeAliases>
18.        
19.     <plugins>
20.         <plugin interceptor="mybatis.plugins.MyPlugin">
21.             <property name="redwinter" value="冬玲"/>
22.         </plugin>
23.         <plugin interceptor="com.github.pagehelper.PageInterceptor">
24.             
26.         </plugin>
27.     </plugins>
29.    
30.     <environments default="development">
31.         <environment id="development">
32.             <transactionManager type="JDBC" />
33.             
34.             <dataSource type="POOLED">
35.                
36.                 <property name="driver" value="${driver}" />
37.                 <property name="url" value="${url}" />
38.                 <property name="username" value="${name}" />
39.                 <property name="password" value="${password}" />
40.             </dataSource>
41.         </environment>
42.     </environments>
43.     <mappers>
45.         <package name="mybatis.mapper"/>
46.     </mappers>
48. </configuration>

复制代码

这样就可以生效了，当我们执行数据查询的时候，只要是执行了StatementHandler#prepare方法，那么都会执行到自定的逻辑增强
日志如下：

1. Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@1386958]
2. 16:02:38.260 [main] INFO mybatis.plugins.MyPlugin - 对方法进行增强....
3. ==>  Preparing: update user set name = ?, age = ? where id = ?
4. ==> Parameters: 李四(String), 19(Integer), 1(Integer)
5. <==    Updates: 1
6. Committing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@1386958]
7. Cache Hit Ratio [mybatis.mapper.UserMapper]: 0.5
8. 16:02:38.303 [main] INFO mybatis.plugins.MyPlugin - 对方法进行增强....
9. ==>  Preparing: select * from user where id = ?
10. ==> Parameters: 1(Integer)
11. <==    Columns: id, age, name
12. <==        Row: 1, 19, 李四
13. <==      Total: 1
14. false

复制代码

这样的话就完成了拦截器插件的代理对象的创建，这里创建出来的代理对象就是StatementHandler，在前面自定义的插件，配置的是拦截StatementHandler#prepare方法，那么在哪里执行的呢？
回到Executor接口实现类SimpleExecutor了中doQuery方法，这个方法中会去创建一个预编译SQL处理器，执行prepareStatement方法：

1. public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
2.     try {
3.       // 创建一个解析xml的构建器，构造函数中会创建一个Configuration类
4.       XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
5.       // 解析xml配置
6.       return build(parser.parse());
7.     } catch (Exception e) {
8.       throw ExceptionFactory.wrapException("Error building SqlSession.", e);
9.     } finally {
10.       ErrorContext.instance().reset();
11.       try {
12.               if (inputStream != null) {
13.                 inputStream.close();
14.               }
15.       } catch (IOException e) {
16.         // Intentionally ignore. Prefer previous error.
17.       }
18.     }
19.   }

复制代码

这里的话就会调用prepare方法，这个方法就是自定义插件配置需要拦截的方法，由于这个handler是一个代理对象，我们都知道只要是代理对象，只要执行代理对象的任何方法都会去执行InvoketionHandler接口的invoke方法，当执行到这个方法的时候就会调用到我们自定义的插件类中intercept方法：

1. private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
2.     super(new Configuration());
3.     ErrorContext.instance().resource("SQL Mapper Configuration");
4.     this.configuration.setVariables(props);
5.     this.parsed = false;
6.     this.environment = environment;
7.     this.parser = parser;
8.   }

复制代码

所以只要我们执行了sql查询，那么都会通过JDK动态代理创建的代理对象去执行到这个增强方法。
插件的扩展

在Mybatis中有个分页的插件叫PageHelper，这个插件就是使用了Mybatis插件机制完成的，当然还有比如早期的TkMapper插件。接下来分析一下PageHelper是如何实现分页机制的。
引入依赖：

1. public Configuration() {
2.     // 添加别名
3.     typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);
4.     typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);
6.     typeAliasRegistry.registerAlias("JNDI", JndiDataSourceFactory.class);
7.     typeAliasRegistry.registerAlias("POOLED", PooledDataSourceFactory.class);
8.     typeAliasRegistry.registerAlias("UNPOOLED", UnpooledDataSourceFactory.class);
10.     typeAliasRegistry.registerAlias("PERPETUAL", PerpetualCache.class);
11.     typeAliasRegistry.registerAlias("FIFO", FifoCache.class);
12.     typeAliasRegistry.registerAlias("LRU", LruCache.class);
13.     typeAliasRegistry.registerAlias("SOFT", SoftCache.class);
14.     typeAliasRegistry.registerAlias("WEAK", WeakCache.class);
16.     typeAliasRegistry.registerAlias("DB_VENDOR", VendorDatabaseIdProvider.class);
18.     typeAliasRegistry.registerAlias("XML", XMLLanguageDriver.class);
19.     typeAliasRegistry.registerAlias("RAW", RawLanguageDriver.class);
21.     typeAliasRegistry.registerAlias("SLF4J", Slf4jImpl.class);
22.     typeAliasRegistry.registerAlias("COMMONS_LOGGING", JakartaCommonsLoggingImpl.class);
23.     typeAliasRegistry.registerAlias("LOG4J", Log4jImpl.class);
24.     typeAliasRegistry.registerAlias("LOG4J2", Log4j2Impl.class);
25.     typeAliasRegistry.registerAlias("JDK_LOGGING", Jdk14LoggingImpl.class);
26.     typeAliasRegistry.registerAlias("STDOUT_LOGGING", StdOutImpl.class);
27.     typeAliasRegistry.registerAlias("NO_LOGGING", NoLoggingImpl.class);
29.     typeAliasRegistry.registerAlias("CGLIB", CglibProxyFactory.class);
30.     typeAliasRegistry.registerAlias("JAVASSIST", JavassistProxyFactory.class);
32.     languageRegistry.setDefaultDriverClass(XMLLanguageDriver.class);
33.     languageRegistry.register(RawLanguageDriver.class);
34.   }

复制代码

然后在mybatis-config.xml配置文件中配置插件让分页插件生效：

1. private final Map<String, Class<?>> typeAliases = new HashMap<>();
3. public TypeAliasRegistry() {
4.     // 注册别名，最终全部会注册到Map中
5.     registerAlias("string", String.class);
7.     registerAlias("byte", Byte.class);
8.     registerAlias("char", Character.class);
9.     registerAlias("character", Character.class);
10.     registerAlias("long", Long.class);
11.     registerAlias("short", Short.class);
12.     registerAlias("int", Integer.class);
13.     registerAlias("integer", Integer.class);
14.     registerAlias("double", Double.class);
15.     registerAlias("float", Float.class);
16.     registerAlias("boolean", Boolean.class);
18.     registerAlias("byte[]", Byte[].class);
19.     registerAlias("char[]", Character[].class);
20.     registerAlias("character[]", Character[].class);
21.     registerAlias("long[]", Long[].class);
22.     registerAlias("short[]", Short[].class);
23.     registerAlias("int[]", Integer[].class);
24.     registerAlias("integer[]", Integer[].class);
25.     registerAlias("double[]", Double[].class);
26.     registerAlias("float[]", Float[].class);
27.     registerAlias("boolean[]", Boolean[].class);
29.     registerAlias("_byte", byte.class);
30.     registerAlias("_char", char.class);
31.     registerAlias("_character", char.class);
32.     registerAlias("_long", long.class);
33.     registerAlias("_short", short.class);
34.     registerAlias("_int", int.class);
35.     registerAlias("_integer", int.class);
36.     registerAlias("_double", double.class);
37.     registerAlias("_float", float.class);
38.     registerAlias("_boolean", boolean.class);
40.     registerAlias("_byte[]", byte[].class);
41.     registerAlias("_char[]", char[].class);
42.     registerAlias("_character[]", char[].class);
43.     registerAlias("_long[]", long[].class);
44.     registerAlias("_short[]", short[].class);
45.     registerAlias("_int[]", int[].class);
46.     registerAlias("_integer[]", int[].class);
47.     registerAlias("_double[]", double[].class);
48.     registerAlias("_float[]", float[].class);
49.     registerAlias("_boolean[]", boolean[].class);
51.     registerAlias("date", Date.class);
52.     registerAlias("decimal", BigDecimal.class);
53.     registerAlias("bigdecimal", BigDecimal.class);
54.     registerAlias("biginteger", BigInteger.class);
55.     registerAlias("object", Object.class);
57.     registerAlias("date[]", Date[].class);
58.     registerAlias("decimal[]", BigDecimal[].class);
59.     registerAlias("bigdecimal[]", BigDecimal[].class);
60.     registerAlias("biginteger[]", BigInteger[].class);
61.     registerAlias("object[]", Object[].class);
63.     registerAlias("map", Map.class);
64.     registerAlias("hashmap", HashMap.class);
65.     registerAlias("list", List.class);
66.     registerAlias("arraylist", ArrayList.class);
67.     registerAlias("collection", Collection.class);
68.     registerAlias("iterator", Iterator.class);
70.     registerAlias("ResultSet", ResultSet.class);
71.   }

复制代码

然后就可以直接使用了：

1. public Configuration parse() {
2.     if (parsed) {
3.         throw new BuilderException("Each XMLConfigBuilder can only be used once.");
4.     }
5.     parsed = true;
6.     // 解析配置，从根的configuration的标签开始
7.     parseConfiguration(parser.evalNode("/configuration"));
8.     return configuration;
9. }
10. private void parseConfiguration(XNode root) {
11.     try {
12.         // issue #117 read properties first
13.         propertiesElement(root.evalNode("properties"));
14.         Properties settings = settingsAsProperties(root.evalNode("settings"));
15.         loadCustomVfs(settings);
16.         // 加载自定义的日志打印
17.         loadCustomLogImpl(settings);
18.         // 解析别名
19.         typeAliasesElement(root.evalNode("typeAliases"));
20.         // 添加插件
21.         pluginElement(root.evalNode("plugins"));
22.         objectFactoryElement(root.evalNode("objectFactory"));
23.         objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
24.         reflectorFactoryElement(root.evalNode("reflectorFactory"));
25.         // 设置默认的配置
26.         settingsElement(settings);
27.         // read it after objectFactory and objectWrapperFactory issue #631
28.         // 解析环境信息
29.         environmentsElement(root.evalNode("environments"));
30.         databaseIdProviderElement(root.evalNode("databaseIdProvider"));
31.         // 解析类型处理器标签
32.         typeHandlerElement(root.evalNode("typeHandlers"));
33.         // 解析mappers标签
34.         mapperElement(root.evalNode("mappers"));
35.     } catch (Exception e) {
36.         throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
37.     }
38. }

复制代码

日志如下：
[code]Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@14a2528]11:06:43.511 [main] INFO mybatis.plugins.MyPlugin - 对方法进行增强....==>  Preparing: SELECT count(0) FROM user ==> Parameters: