mybatis 实现 SQL 查询拦截修改详解

 更新时间:2019年07月16日 10:33:56   作者:coderstory  
这篇文章主要介绍了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>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • win10 下安装 mysql 5.7.14 详细图文教程

    win10 下安装 mysql 5.7.14 详细图文教程

    本文通过文字和图片相结合的形式给大家介绍了win10 下安装 mysql 5.7.14的教程的,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2016-09-09
  • sqlite迁移到mysql脚本的方法

    sqlite迁移到mysql脚本的方法

    这篇文章主要介绍了sqlite迁移到mysql脚本的方法,需要的朋友可以参考下
    2017-08-08
  • 如何区分MySQL的innodb_flush_log_at_trx_commit和sync_binlog

    如何区分MySQL的innodb_flush_log_at_trx_commit和sync_binlog

    这篇文章主要介绍了如何区分MySQL的innodb_flush_log_at_trx_commit和sync_binlog,帮助大家更好的理解和使用MySQL数据库,感兴趣的朋友可以了解下
    2021-02-02
  • MySQL 使用 SSL 连接配置详解

    MySQL 使用 SSL 连接配置详解

    本文给大家分享的是如何配置MySQL支持SSL连接方式的方法以及在docker中配置的具体案例,有需要的小伙伴可以参考下
    2016-12-12
  • 一次mysql的.ibd文件过大处理过程记录

    一次mysql的.ibd文件过大处理过程记录

    mysql数据库的每个表都有ibd和frm两种格式的文件,ibd文件是表的数据文件,存放表的数据,修改文件后缀,无法在MySQL数据库中查询表数据,这篇文章主要给大家介绍了关于一次mysql的.ibd文件过大处理过程的相关资料,需要的朋友可以参考下
    2022-06-06
  • MySQL ClickHouse常用表引擎超详细讲解

    MySQL ClickHouse常用表引擎超详细讲解

    这篇文章主要介绍了MySQL ClickHouse常用表引擎,ClickHouse表引擎中,CollapsingMergeTree和VersionedCollapsingMergeTree都能通过标记位按规则折叠数据,从而达到更新和删除的效果
    2022-11-11
  • Mysql升级到5.7后遇到的group by查询问题解决

    Mysql升级到5.7后遇到的group by查询问题解决

    这篇文章主要给大家介绍了关于Mysql升级到5.7后遇到的group by查询问题的解决方法,文中通过示例代码介绍的非常详细,对同样遇到这个问题的朋友们具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2017-09-09
  • 提高MySQL 查询效率的三个技巧

    提高MySQL 查询效率的三个技巧

    MySQL由于它本身的小巧和操作的高效, 在数据库应用中越来越多的被采用.我在开发一个P2P应用的时候曾经使用MySQL来保存P2P节点,由于P2P的应用中,结点数动辄上万个,而且节点变化频繁,因此一定要保持查询和插入的高效.以下是我在使用过程中做的提高效率的三个有效的尝试. 1. 使用statement进行绑定查询 2. 随机的获取记录 3. 使用连接池管理连接.
    2008-04-04
  • mysql中插入emoji表情失败的原因与解决

    mysql中插入emoji表情失败的原因与解决

    这篇文章主要给大家介绍了关于mysql中插入emoji表情失败的原因与解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-12-12
  • MySQL递归查找树形结构(这个方法太实用了!)

    MySQL递归查找树形结构(这个方法太实用了!)

    对于数据库中的树形结构数据,如部门表,有时候,我们需要知道某部门的所有下属部分或者某部分的所有上级部门,这时候就需要用到mysql的递归查询,下面这篇文章主要给大家介绍了关于MySQL递归查找树形结构的相关资料,需要的朋友可以参考下
    2022-11-11

最新评论