MyBatis原理(六)——插件
2022-01-04 本文已影响0人
Lnstark
MyBatis的插件可以通过修改sql语,修改执行过程或者结果集解析,实现分页、数据的加密解密等。
插件就是一个拦截器Interceptor,例如分页插件PageInterceptor,实现Interceptor的intercept方法,然后在类上加上注解
@Intercepts(
{
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
}
)
表名要对执行器的2个query方法进行拦截,搞点事情。
Interceptor可以对Executor 、StatementHandler 、PameterHandler 和ResultSetHandler 进行拦截,具体可以看Configuration的这四个组件的创建方法,里面有interceptorChain.pluginAll代码,将插件对这些组件进行拦截,即代理。
我们配置一个Interceptor的实现类注入到spring容器,mybatis-spring-boot-starter会自动将它加载到interceptorChain里。然后在创建上面4个组件的时候执行interceptorChain.pluginAll:
public Object pluginAll(Object target) {
for (Interceptor interceptor : interceptors) {
target = interceptor.plugin(target);
}
return target;
}
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
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) {
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
new Plugin(target, interceptor, signatureMap));
}
return target;
}
// plugin的invoke方法
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
// 拿到需要代理的方法
Set<Method> 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);
}
}
就是多重的动态代理。
分页插件实际上就是拦截了执行器的查询方法后,对SQL进行修改,然后执行查询total,再对SQL修改(加上limit offset等)查询该页的数据,最后返回。
分页插件的Page参数是在PageHelper.startPage()的时候将Page放到一个ThreadLocal里,在修改SQL的时候将它拿出来。