MyBatis阻拦器详情

MyBatis提供了一种插件(plugin)的功能，尽管叫做插件，但其实这是阻拦器功能。那么阻拦器阻拦MyBatis中的哪些内容呢？

我们进入官网看一看：

MyBatis阻拦器详情

MyBatis提供了一种插件(plugin)的功能，尽管叫做插件，但其实这是阻拦器功能。那么阻拦器阻拦MyBatis中的哪些内容呢？

我们进入官网看一看：

MyBatis 允许你在已映射语句执行过程中的某一点进行阻拦调用。默认情况下，MyBatis 允许使用插件来阻拦的方法调用包括：Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)ParameterHandler (getParameterObject, setParameters)ResultSetHandler (handleResultSets, handleOutputParameters)StatementHandler (prepare, parameterize, batch, update, query)

我们看到了可以阻拦Executor接口的部分方法，比方update，query，commit，rollback等方法，还有其余接口的少量方法等。

总体概括为：

阻拦执行器的方法

阻拦参数的解决

阻拦结果集的解决

阻拦Sql语法构建的解决

阻拦器的使用

阻拦器详情及配置

首先我们看下MyBatis阻拦器的接口定义：

public interface Interceptor {

Object intercept(Invocation invocation) throws Throwable;

Object plugin(Object target);

void setProperties(Properties properties);

}

比较简单，只有3个方法。 MyBatis默认没有一个阻拦器接口的实现类，开发者们可以实现符合自己需求的阻拦器。

下面的MyBatis官网的一个阻拦器实例：

@Intercepts({@Signature(

type= Executor.class,

method = “update”,

args = {MappedStatement.class,Object.class})})

public class ExamplePlugin implements Interceptor {

public Object intercept(Invocation invocation) throws Throwable {

return invocation.proceed();

}

public Object plugin(Object target) {

return Plugin.wrap(target, this);

}

public void setProperties(Properties properties) {

}

}

全局xml配置：

这个阻拦器阻拦Executor接口的update方法（其实也就是SqlSession的新添加，删除，修改操作），所有执行executor的update方法都会被该阻拦器阻拦到。

源码分析

下面我们分析一下这段代码背后的源码。

首先从源头->配置文件开始分析：

XMLConfigBuilder解析MyBatis全局配置文件的pluginElement私有方法：

private void pluginElement(XNode parent) throws Exception {

if (parent != null) {

for (XNode child : parent.getChildren()) {

String interceptor = child.getStringAttribute(“interceptor”);

Properties properties = child.getChildrenAsProperties();

Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();

interceptorInstance.setProperties(properties);

configuration.addInterceptor(interceptorInstance);

}

}

}

具体的解析代码其实比较简单，就不贴了，主要就是通过反射实例化plugin节点中的interceptor属性表示的类。而后调用全局配置类Configuration的addInterceptor方法。

public void addInterceptor(Interceptor interceptor) {

interceptorChain.addInterceptor(interceptor);

}

这个interceptorChain是Configuration的内部属性，类型为InterceptorChain，也就是一个阻拦器链，我们来看下它的定义：

public class InterceptorChain {

private final List interceptors = new ArrayList();

public Object pluginAll(Object target) {

for (Interceptor interceptor : interceptors) {

target = interceptor.plugin(target);

}

return target;

}

public void addInterceptor(Interceptor interceptor) {

interceptors.add(interceptor);

}

public List getInterceptors() {

return Collections.unmodifiableList(interceptors);

}

}

现在我们了解了阻拦器配置的解析以及阻拦器的归属，现在我们回过头看下为何阻拦器会阻拦这些方法（Executor，ParameterHandler，ResultSetHandler，StatementHandler的部分方法）：

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {

ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);

parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);

return parameterHandler;

}

public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,

ResultHandler resultHandler, BoundSql boundSql) {

ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);

resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);

return resultSetHandler;

}

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {

StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);

statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);

return statementHandler;

}

public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {

executorType = executorType == null ? defaultExecutorType : executorType;

executorType = executorType == null ? ExecutorType.SIMPLE : executorType;

Executor executor;

if (ExecutorType.BATCH == executorType) {

executor = new BatchExecutor(this, transaction);

} else if (ExecutorType.REUSE == executorType) {

executor = new ReuseExecutor(this, transaction);

} else {

executor = new SimpleExecutor(this, transaction);

}

if (cacheEnabled) {

executor = new CachingExecutor(executor, autoCommit);

}

executor = (Executor) interceptorChain.pluginAll(executor);

return executor;

}

以上4个方法都是Configuration的方法。这些方法在MyBatis的一个操作(新添加，删除，修改，查询)中都会被执行到，执行的先后顺序是Executor，ParameterHandler，ResultSetHandler，StatementHandler(其中ParameterHandler和ResultSetHandler的创立是在创立StatementHandler[3个可用的实现类CallableStatementHandler,PreparedStatementHandler,SimpleStatementHandler]的时候，其构造函数调用的[这3个实现类的构造函数其实都调用了父类BaseStatementHandler的构造函数])。

这4个方法实例化了对应的对象之后，都会调用interceptorChain的pluginAll方法，InterceptorChain的pluginAll刚才已经详情过了，就是遍历所有的阻拦器，而后调用各个阻拦器的plugin方法。注意：阻拦器的plugin方法的返回值会直接被赋值给原价的对象

因为可以阻拦StatementHandler，这个接口主要解决sql语法的构建，因而比方分页的功能，可以用阻拦器实现，只要要在阻拦器的plugin方法中解决StatementHandler接口实现类中的sql就可，可使用反射实现。

MyBatis还提供了 @Intercepts和 @Signature关于阻拦器的注解。官网的例子就是使用了这2个注解，还包括了Plugin类的使用：

@Override

public Object plugin(Object target) {

return Plugin.wrap(target, this);

}

下面我们就分析这3个 “新组合” 的源码，首先先看Plugin类的wrap方法：

public static Object wrap(Object target, Interceptor interceptor) {

Map, Set> 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));

}

return target;

}

Plugin类实现了InvocationHandler接口，很显著，我们看到这里返回了一个JDK自身提供的动态代理商类。我们解剖一下这个方法调用的其余方法：

getSignatureMap方法：

private static Map, Set> getSignatureMap(Interceptor interceptor) {

Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);

if (interceptsAnnotation == null) { // issue #251

throw new PluginException(“No @Intercepts annotation was found in interceptor ” + interceptor.getClass().getName());

}

Signature[] sigs = interceptsAnnotation.value();

Map, Set> signatureMap = new HashMap, Set>();

for (Signature sig : sigs) {

Set methods = signatureMap.get(sig.type());

if (methods == null) {

methods = new HashSet();

signatureMap.put(sig.type(), methods);

}

try {

Method method = sig.type().getMethod(sig.method(), sig.args());

methods.add(method);

} catch (NoSuchMethodException e) {

throw new PluginException(“Could not find method on ” + sig.type() + ” named ” + sig.method() + “. Cause: ” + e, e);

}

}

return signatureMap;

}

getSignatureMap方法解释：首先会拿到阻拦器这个类的 @Interceptors注解，而后拿到这个注解的属性 @Signature注解集合，而后遍历这个集合，遍历的时候拿出 @Signature注解的type属性(Class类型)，而后根据这个type得到带有method属性和args属性的Method。因为 @Interceptors注解的 @Signature属性是一个属性，所以最终会返回一个以type为key，value为Set的Map。

@Intercepts({@Signature(

type= Executor.class,

method = “update”,

args = {MappedStatement.class,Object.class})})

比方这个 @Interceptors注解会返回一个key为Executor，value为集合(这个集合只有一个元素，也就是Method实例，这个Method实例就是Executor接口的update方法，且这个方法带有MappedStatement和Object类型的参数)。这个Method实例是根据 @Signature的method和args属性得到的。假如args参数跟type类型的method方法对应不上，那么将会抛出异常。

getAllInterfaces方法：

private static Class[] getAllInterfaces(Class type, Map, Set> signatureMap) {

Set> interfaces = new HashSet>();

while (type != null) {

for (Class c : type.getInterfaces()) {

if (signatureMap.containsKey(c)) {

interfaces.add(c);

}

}

type = type.getSuperclass();

}

return interfaces.toArray(new Class[interfaces.size()]);

}

getAllInterfaces方法解释：根据目标实例target(这个target就是之前所说的MyBatis阻拦器可以阻拦的类，Executor,ParameterHandler,ResultSetHandler,StatementHandler)和它的父类们，返回signatureMap中含有target实现的接口数组。

所以Plugin这个类的作用就是根据 @Interceptors注解，得到这个注解的属性 @Signature数组，而后根据每个 @Signature注解的type，method，args属性使用反射找到对应的Method。最终根据调用的target对象实现的接口决定能否返回一个代理商对象替代原价的target对象。

比方MyBatis官网的例子，当Configuration调用newExecutor方法的时候，因为Executor接口的update(MappedStatement ms, Object parameter)方法被阻拦器被截获。因而最终返回的是一个代理商类Plugin，而不是Executor。这样调用方法的时候，假如是个代理商类，那么会执行：

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

try {

Set methods = signatureMap.get(method.getDeclaringClass());

if (methods != null && methods.contains(method)) {

return interceptor.intercept(new Invocation(target, method, args));

}

return method.invoke(target, args);

} catch (Exception e) {

throw ExceptionUtil.unwrapThrowable(e);

}

}

没错，假如找到对应的方法被代理商之后，那么会执行Interceptor接口的interceptor方法。

这个Invocation类如下：

public class Invocation {

private Object target;

private Method method;

private Object[] args;

public Invocation(Object target, Method method, Object[] args) {

this.target = target;

this.method = method;

this.args = args;

}

public Object getTarget() {

return target;

}

public Method getMethod() {

return method;

}

public Object[] getArgs() {

return args;

}

public Object proceed() throws InvocationTargetException, IllegalAccessException {

return method.invoke(target, args);

}

}

它的proceed方法也就是调用原价方法(不走代理商)。

总结

MyBatis阻拦器接口提供的3个方法中，plugin方法用于某些解决器(Handler)的构建过程。interceptor方法用于解决代理商类的执行。setProperties方法用于阻拦器属性的设置。

其实MyBatis官网提供的使用 @Interceptors和 @Signature注解以及Plugin类这样解决阻拦器的方法，我们不肯定要直接这样使用。我们也可以抛弃这3个类，直接在plugin方法内部根据target实例的类型做相应的操作。

总体来说MyBatis阻拦器还是很简单的，阻拦器本身不需要太多的知识点，但是学习阻拦器需要对MyBatis中的各个接口很熟习，由于阻拦器涉及到了各个接口的知识点。

欢迎工作一到五年想成为Java工程师的朋友们加入Java架构开发：744677563

群内提供免费的Java架构学习资料（里面有高可用、高并发、高性能及分布式、Jvm性能调优、Spring源码，MyBatis，Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多个知识点的架构资料）正当利用自己每一分每一秒的时间来学习提升自己，不要再用”没有时间“来掩饰自己思想上的懒惰！趁年轻，使劲拼，给未来的自己一个交代！