MyBatis3教程 - MyBatis插件（Plugins）开发

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

• Executor (update, query, flushStatements, commit, rollback,
  getTransaction, close, isClosed)
• ParameterHandler (getParameterObject, setParameters)
• ResultSetHandler (handleResultSets, handleOutputParameters)
• StatementHandler (prepare, parameterize, batch, update, query)

这些类中方法的细节可以通过查看每个方法的签名来发现，或者直接查看 MyBatis 的发行包中的源代码。 假设你想做的不仅仅是监控方法的调用，那么你应该很好的了解正在重写的方法的行为。 因为如果在试图修改或重写已有方法的行为的时候，你很可能在破坏 MyBatis 的核心模块。 这些都是更低层的类和方法，所以使用插件的时候要特别当心。

通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定了想要拦截的方法签名即可。

自定义插件

需求：

把Mybatis所有执行的sql都记录下来。

代码实现

通过对 MyBatis org.apache.ibatis.executor.statement.StatementHandler 中的prepare 方法进行拦截即可。

prepare 方法签名如下：

Statement prepare(Connection connection, Integer transactionTimeout)
      throws SQLException;

自定义一个类，实现 org.apache.ibatis.pluginInterceptor 接口，代码如下：

package com.bytebeats.mybatis3.interceptor;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.plugin.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.sql.Connection;
import java.util.Properties;

/**
 * ${DESCRIPTION}
 *
 * @author Ricky Fung
 * @date 2017-02-17 11:52
 */
@Intercepts({ @Signature(type = StatementHandler.class, method = "prepare", args = { Connection.class, Integer.class}) })
public class SQLStatsInterceptor implements Interceptor {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        BoundSql boundSql = statementHandler.getBoundSql();
        String sql = boundSql.getSql();
        logger.info("mybatis intercept sql:{}", sql);
        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Properties properties) {
        String dialect = properties.getProperty("dialect");
        logger.info("mybatis intercept dialect:{}", dialect);
    }
}

这样一个插件就开发完成了，接下来需要在 mybatis-config.xml 文件中增加 plugins节点，完整配置如下：

spring-mybatis.xml

maven依赖

    
        1.7
        4.2.7.RELEASE
        UTF-8
    
    
    
        
        
            org.springframework
            spring-core
            ${spring.version}
            
                
                    commons-logging
                    commons-logging
                
            
        
        
            org.springframework
            spring-beans
            ${spring.version}
        
        
            org.springframework
            spring-context
            ${spring.version}
        
        
            org.springframework
            spring-context-support
            ${spring.version}
        
        
            org.springframework
            spring-webmvc
            ${spring.version}
        
        
            org.springframework
            spring-tx
            ${spring.version}
        
        
            org.springframework
            spring-jdbc
            ${spring.version}
        
        
            org.springframework
            spring-test
            ${spring.version}
        

        
            javax.servlet
            javax.servlet-api
            3.1.0
        

        
        
            mysql
            mysql-connector-java
            5.1.26
        

        
            com.alibaba
            druid
            1.0.25
        

        
        
            org.mybatis
            mybatis
            3.4.1
        
        
            org.mybatis
            mybatis-spring
            1.3.0
        

        
        
            org.slf4j
            slf4j-api
            1.7.21
        

        
            org.slf4j
            log4j-over-slf4j
            1.7.21
        
        
            org.slf4j
            jcl-over-slf4j
            1.7.21
        

        
            ch.qos.logback
            logback-core
            1.1.7
        
        
            ch.qos.logback
            logback-classic
            1.1.7
        

        
            junit
            junit
            ${junit.version}
            test
        
    

参考资料

MyBatis 插件（plugins）教程：http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins

源代码下载

mybatis3-tutorials