共计 3865 个字符，预计需要花费 10 分钟才能阅读完成。
自动写代码机器人，免费开通
这篇文章将为大家详细讲解有关 mybatis 如何实现 SQL 查询拦截修改，丸趣 TV 小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。
前言
截器的一个作用就是我们可以拦截某些方法的调用，我们可以选择在这些被拦截的方法执行前后加上某些逻辑，也可以在执行这些被拦截的方法时执行自己的逻辑而不再执行被拦截的方法。
Mybatis 拦截器设计的一个初衷就是为了供用户在某些时候可以实现自己的逻辑而不必去动 Mybatis 固有的逻辑。比如我想针对所有的 SQL 执行某个固定的操作，针对 SQL 查询执行安全检查，或者记录相关 SQL 查询日志等等。
Mybatis 为我们提供了一个 Interceptor 接口，可以实现自定义的拦截器。
public interface Interceptor { Object intercept(Invocation invocation) throws Throwable;
Object plugin(Object target);
void setProperties(Properties properties);
}接口中包含了三个方法定义
intercept 方法为具体的拦截对象的处理方法，传入的 Invocation 包含了拦截目标类的实力，拦截的方法和方法的入参数组。使用 Invocation 的 procced 执行原函数。
plugin 中执行判断是否要进行拦截进，如果不需要拦截，直接返回 target，如果需要拦截则调用 Plugin 类中的 wrap 静态方法，如果当前拦截器实现了任意接口，则返回一个代理对象，否则直接返回（回忆代理模式的设计）。代理对象实际是一个 Plugin 类实例，它实现了 InvocationHandler 接口，InvocationHandler 接口仅包含 invoke 方法用于回调方法。
当执行代理对象的接口方法时，会调用 Plugin 的 invoke 方法，它会把要执行的对象，方法和参数打包成 Invocation 对象传给拦截器的 intercept 方法。Invocation 定义了一个 procced 方法，用于执行被拦截的原方法。
Plugin 类定义
public class Plugin implements InvocationHandler {
private Object target;
private Interceptor interceptor;
private Map, Set signatureMap;
private Plugin(Object target, Interceptor interceptor, Map, Set signatureMap) {
this.target = target;
this.interceptor = interceptor;
this.signatureMap = signatureMap;
}
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;
}
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);
}
}
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;
}
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()]);
}
}setProperties 方法顾名思义，用于设置属性的。bean 的属性初始化方法有很多，这是其中的一种。
mybatis 提供了 @Intercepts 注解用于声明当前类是拦截器，其值为 @Signature 数组，表明要拦截的接口、方法以及对应的参数类型
@Intercepts({@Signature(method = prepare , type = StatementHandler.class, args = {Connection.class}),
@Signature(method = query , type = StatementHandler.class, args = {java.sql.Statement.class, ResultHandler.class})})
public class TenantInterceptor implements Interceptor {.....例如上面的类声明，第一个 Signature 标注拦截了 StatementHandler 类下的入参是一个 Connection 的名为 prepare 的方法。
第二个 Signature 标注拦截 StatementHandler 类中包含 2 个入参（分别为 Statement 和 ResultHandler 类型）的名为 query 的方法。
最后，声明的 Interceptor 需要注册到 mybatis 的 plug 中才能生效。
!-- 配置 mybatis --
bean id= sqlSessionFactory >关于“mybatis 如何实现 SQL 查询拦截修改”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，使各位可以学到更多知识，如果觉得文章不错，请把它分享出去让更多的人看到。
向 AI 问一下细节
