MyBatis(七) 插件开发

MyBatis允许在已映射语句执行过程中的某一点进行拦截调用，可以在这些被拦截的方法执行前后加上某些逻辑，也可以在执行这些被拦截的方法时执行自由的逻辑而不再执行被拦截的方法，我们前面定义的mapper方法最终是由excutor来执行，因此，我们可以拦截执行器，我们可以使用插件来拦截的接口(org.apacha.ibatis.excutor)有如下几个：

- Excutor

- ParameterHandler

- ResultSetHandler

- SatementHandler

要进行插件开发，主要实现接口Interceptor进行处理:

MyBatis(七) 插件开发

源码中给了一个插件实现的示例:

MyBatis(七) 插件开发

可以看到Interceptor接口的几个方法的作用:

- setProperties: 用来传递插件的参数，参数在mybatis-config.xml配置

- plugin: 参数target是拦截器要拦截的对象，该方法会在创建被拦截的接口实现类时被调用

- intercept: MyBatis运行时要执行的拦截方法

另外注意到ExamplePlugin类还有一个注解@Intercepts，它有一个签名注解@Signature的属性，它们是用来配置拦截器要拦截的接口的方法。

MyBatis(七) 插件开发

现在来写一个最简单的拦截器，主要在方法执行的前后打印一个日志，代码如下：

package cn.linjk.mybatistest.plugin;

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;

import java.util.Properties;

@Intercepts(
        @Signature(
                type = Executor.class,
                method = "query",
                args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}
        )
)
public class SimpleInteceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("进入拦截器: " + this.getClass().getSimpleName());
        Object result = invocation.proceed();
        System.out.println("退出拦截器: " + this.getClass().getSimpleName());
        
        return result;
    }

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

    @Override
    public void setProperties(Properties properties) {

    }
}

编辑mybatis-config.xml文件，增加插件配置：

MyBatis(七) 插件开发

然后执行原来的一级缓存的单元测试，看看日志输出，最简单的拦截器实现完成： MyBatis(七) 插件开发