一、mybatis拦截器的介绍和简单使用
要使用mybatis的拦截器需要先对mybatis的执行流程有比较全面的认识，可以参考下我的另两篇文章
mybatis执行sql的过程中涉及到这几个核心对象
Executor:执行器,StatementHandler ,ParameterHandler, ResultSetHandler,
mybatis提供了自定义拦截器机制可以拦截上述四个对象中的方法，在方法的执行前后插入自己想要的逻辑。
自定义拦截器通过实现org.apache.ibatis.plugin.Interceptor 接口并指定需要拦截的对象和方法来实现。
下面举一个例子，拦截StatementHandler中的query方法。
先看下StatementHnalder中的方法,使用mybatis时最终都是通过这些方法来执行sql的
public interface StatementHandler {
Statement prepare(Connection connection, Integer transactionTimeout)
throws SQLException;
void parameterize(Statement statement)
throws SQLException;
void batch(Statement statement)
throws SQLException;
int update(Statement statement)
throws SQLException;
<E> List<E> query(Statement statement, ResultHandler resultHandler)
throws SQLException;
<E> Cursor<E> queryCursor(Statement statement)
throws SQLException;
BoundSql getBoundSql();
ParameterHandler getParameterHandler();
}
下面就来演示下在query方法执行前输出一句话。
package com.lyy.mybatis;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.springframework.stereotype.Component;
import java.sql.Statement;
import java.util.Properties;
/*
@Intercepts注解表名当前类是一个mybatis拦截器
用Signature注解声明当前拦截器会拦截哪个对象的那个方法
* type:要拦截的对象
* method:对象中的方法名
* args:要拦截的方法的参数列表 (方法可能重载,仅凭方法名并不能唯一确定一个方法)
* */
@Component //注入spring容器,mybatis会自己应用
@Intercepts(@Signature(type = StatementHandler.class,method = "query",args = {Statement.class, ResultHandler.class}))
public class PrintInterceptor implements Interceptor {
//这个方法中写具体的拦截逻辑
@Override
public Object intercept(Invocation invocation) throws Throwable {
System.out.println("拦截器执行了");
//执行目标方法
return invocation.getMethod().invoke(invocation.getTarget(),invocation.getArgs());
}
@Override
public Object plugin(Object target) {
//Plugin是mybatis提供的工具类,wrap方法会解析上边的注解，并创建目标对象target的代理对象返回,
//后边具体分析
return Plugin.wrap(target,this);
}
@Override
public void setProperties(Properties properties) {
}
}
将这个类配置在spring容器中,mybatis就会自动使用此拦截器( springboot工程中是样的，未使用springboot时需要手动把这个类的对象添加到SqlSessionFactoryBean中)
二、mybatis拦截器的执行原理分析
mybatis运行过程中使用的上述四个对象均是被代理过的对象，拦截器就是通过代理实现的。
mybatis中用到的上述四个对象的创建都是通过Configuration 统一创建的，只有这样才能根据配置的拦截器创建出代理对象。
下面就分析下newStatementHandler方法来看下代理对象是如何创建的。
// Configuration类部分源码
public class Configuration {
protected final InterceptorChain interceptorChain = new InterceptorChain();
//此方法返回一个被代理过的StatementHandler对象
public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
//创建StatementHandler对象
StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
//对statementHandler对象进行代理,通过InterceptorChain对象进行代理
statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
return statementHandler;
}
}
所以根据拦截器生成代理对象的逻辑在InterceptorChain 中
public class InterceptorChain {
private final List<Interceptor> interceptors = new ArrayList<Interceptor>();
//这个方法就是Configuration中调用的进行代理的方法
public Object pluginAll(Object target) {
// 遍历所有的拦截器，依次调用plugin方法进行代理，最终会得到一个被多次代理的对象,
// mybatis运行时使用的4个核心对象都是这里返回的代理对象
for (Interceptor interceptor : interceptors) {
//所以具体的代理逻辑就在Interceptor.plugin方法中。
target = interceptor.plugin(target);
}
return target;
}
// 我们配置的拦截器最终都会通过这个方法添加到成员变量interceptors中
public void addInterceptor(Interceptor interceptor) {
interceptors.add(interceptor);
}
public List<Interceptor> getInterceptors() {
return Collections.unmodifiableList(interceptors);
}
}
所以具体的代理逻辑就在我们自己实现的Interceptor的plugin方法中,像一中的代码一样。
再具体看下Plugin.wrap方法
public class Plugin implements InvocationHandler {
private Object target;
private Interceptor interceptor;
private Map<Class<?>, Set<Method>> signatureMap;//这里存储存储拦截器对象要拦截的方法信息
private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
this.target = target;
this.interceptor = interceptor;
this.signatureMap = signatureMap;
}
/*
target:目标对象，被代理的对象
interceptor: 当前待使用的拦截器对象
*/
public static Object wrap(Object target, Interceptor interceptor) {
//获取拦截器类上的注解信息,根据注解信息决定当前对象是否需要被代理
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
Class<?> type = target.getClass();
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
if (interfaces.length > 0) {
//需要代理就使用JDK的动态代理进行代理,当前类实现了InvocationHandler接口,
// 具体的代理逻辑在invoke方法中
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
new Plugin(target, interceptor, signatureMap));
}
//当前对象不需要代理，直接返回原始对象
return target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
//根据注解信息判断当前的方法是否需要被代理,
//signatureMap存储了wrap方法执行时对拦截器实现类上的注解解析后的结果
//method.getDeclaringClass()获取到当前待执行方法所在的类的Class对象
//从signatureMap中查找此class对象是否有需要拦截的方法,
//再看需要拦截的方法中是否包含了当前方法
Set<Method> methods = signatureMap.get(method.getDeclaringClass());
if (methods != null && methods.contains(method)) {
//需要代理就执行interceptor.intercept方法，(参考第一节中的自定义拦截器)
return interceptor.intercept(new Invocation(target, method, args));
}
//方法不需要被代理，执行原本方法
return method.invoke(target, args);
} catch (Exception e) {
throw ExceptionUtil.unwrapThrowable(e);
}
}
//这个方法就是在对拦截器实现类上的注解进行解析
private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
//获取Intercepts注解
Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
// issue #251
if (interceptsAnnotation == null) {
throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
}
//拿到注解的value值,是一个数组,存的是另一个注解Signature
Signature[] sigs = interceptsAnnotation.value();
Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
//这个循环解析Signature对象放入signatureMap中
/*
Signature属性含义
type: 表示拦截器要拦截的对象
method:要拦截的方法名
args:要拦截的方法参数列表
*/
for (Signature sig : sigs) {
Set<Method> methods = signatureMap.get(sig.type());
if (methods == null) {
// Signature的配置有可能重复,走到这里是第一次遍历到
// methods存储要拦截哪些方法
methods = new HashSet<Method>();
signatureMap.put(sig.type(), methods);
}
try {
//sig.type():获取到要拦截对象的Class对象
// 再根据方法名和参数列表获取到方法对象并存起来
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;
}
//获取需要被代理的目标对象实现的所有接口,type本身应该是一个实现类，例如是StatementHandler的实现类
private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
Set<Class<?>> interfaces = new HashSet<Class<?>>();
while (type != null) {
for (Class<?> c : type.getInterfaces()) {
//看目标对象实现的接口中是否有当前拦截器实现类声明的拦截对象
// 可以这么理解，假设现在是通过Configuration.newResultSetHandler方法执行到这里的,而我们配置的
// PrintInterceptor 声明了拦截StatementHandler,所以这时的signatureMap中肯定不含有
//ResultSetHandler,最后返回的会是一个空数组
if (signatureMap.containsKey(c)) {
interfaces.add(c);
}
}
type = type.getSuperclass();
}
return interfaces.toArray(new Class<?>[interfaces.size()]);
}
}
到这里mybatis拦截器的执行原理就分析完了，拦截器是通过mybaits利用Configuration.newXXX方法生成的代理对象来对四个核心对象进行拦截的。
