mybatis 实现 SQL 查询拦截修改

拦截器的一个作用就是我们可以拦截某些方法的调用,我们可以选择在这些被拦截的方法执行前后加上某些逻辑,也可以在执行这些被拦截的方法时执行自己的逻辑而不再执行被拦截的方法。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" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
       <property name="configLocation" value="classpath:mybatis/mybatis-config.xml"/>
        <!-- mapper扫描 -->
        <property name="mapperLocations" value="classpath:mybatis/*/*.xml"/>
       <property name="plugins">
           <array>
                <!-- 注册自己的拦截器 -->
               <bean id="paginationInterceptor" class="xxx.xxx.TenantInterceptor">
                </bean>
            </array>
        </property>
    </bean>

接下来我会写个完整的例子,实现mybatis的拦截器用户实现系统的多租户功能。

暂无评论

发表评论

电子邮件地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据