mybatis 拦截器

1.mybatis拦截器介绍

拦截器可在mybatis进行sql底层处理的时候执行额外的逻辑,最常见的就是分页逻辑、对结果集进行处理过滤敏感信息等。

  public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
    ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
    parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
    return parameterHandler;
  }

  public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
      ResultHandler resultHandler, BoundSql boundSql) {
    ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
    resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
    return resultSetHandler;
  }

  public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
    statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
    return statementHandler;
  }

  public Executor newExecutor(Transaction transaction) {
    return newExecutor(transaction, defaultExecutorType);
  }

  public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    executorType = executorType == null ? defaultExecutorType : executorType;
    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
    Executor executor;
    if (ExecutorType.BATCH == executorType) {
      executor = new BatchExecutor(this, transaction);
    } else if (ExecutorType.REUSE == executorType) {
      executor = new ReuseExecutor(this, transaction);
    } else {
      executor = new SimpleExecutor(this, transaction);
    }
    if (cacheEnabled) {
      executor = new CachingExecutor(executor);
    }
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
  }

从上面的代码可以看到mybatis支持的拦截类型只有四种(按拦截顺序)

1.Executor 执行器接口

2.StatementHandler sql构建处理器

3.ParameterHandler 参数处理器

4.ResultSetHandler 结果集处理器

2.拦截器原理

public class InterceptorChain {

  private final List<interceptor> interceptors = new ArrayList<>();

  // &#x904D;&#x5386;&#x5B9A;&#x4E49;&#x7684;&#x62E6;&#x622A;&#x5668;&#xFF0C;&#x5BF9;&#x62E6;&#x622A;&#x7684;&#x5BF9;&#x8C61;&#x8FDB;&#x884C;&#x5305;&#x88C5;
  public Object pluginAll(Object target) {
    for (Interceptor interceptor : interceptors) {
      target = interceptor.plugin(target);
    }
    return target;
  }

  public void addInterceptor(Interceptor interceptor) {
    interceptors.add(interceptor);
  }

  public List<interceptor> getInterceptors() {
    return Collections.unmodifiableList(interceptors);
  }

}

#Interceptor
public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  default Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }

  default void setProperties(Properties properties) {
    // NOP
  }

}</interceptor></interceptor>

mybatis拦截器本质上使用了jdk动态代理,interceptorChain拦截器链中存储了用户定义的拦截器,会遍历进行对目标对象代理包装。

用户自定义拦截器类需要实现Interceptor接口,以及实现intercept方法,plugin和setProperties方法可重写,plugin方法一般不会改动,该方法调用了Plugin的静态方法wrap实现了对目标对象的代理

public class Plugin implements InvocationHandler {

  // &#x62E6;&#x622A;&#x76EE;&#x6807;&#x5BF9;&#x8C61;
  private final Object target;

  // &#x62E6;&#x622A;&#x5668;&#x5BF9;&#x8C61;-&#x6267;&#x884C;&#x903B;&#x8F91;
  private final Interceptor interceptor;

  // &#x62E6;&#x622A;&#x63A5;&#x53E3;&#x548C;&#x62E6;&#x622A;&#x65B9;&#x6CD5;&#x7684;&#x6620;&#x5C04;
  private final 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;
  }

  // &#x83B7;&#x53D6;jdk&#x4EE3;&#x7406;&#x5BF9;&#x8C61;
  public static Object wrap(Object target, Interceptor interceptor) {
    // &#x5B58;&#x50A8;&#x62E6;&#x622A;&#x63A5;&#x53E3;&#x548C;&#x62E6;&#x622A;&#x65B9;&#x6CD5;&#x7684;&#x6620;&#x5C04;
    Map<class<?>, Set<method>> signatureMap = getSignatureMap(interceptor);
    Class<?> type = target.getClass();
    // &#x83B7;&#x53D6;&#x62E6;&#x622A;&#x76EE;&#x6807;&#x5BF9;&#x8C61;&#x5B9E;&#x73B0;&#x7684;&#x63A5;&#x53E3;&#xFF0C;&#x82E5;&#x4E3A;&#x7A7A;&#x5219;&#x4E0D;&#x4EE3;&#x7406;
    Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
    if (interfaces.length > 0) {
      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 {
      // &#x83B7;&#x53D6;&#x9700;&#x8981;&#x62E6;&#x622A;&#x7684;&#x65B9;&#x6CD5;&#x96C6;&#x5408;&#xFF0C;&#x82E5;&#x4E0D;&#x5B58;&#x5728;&#x5219;&#x4F7F;&#x7528;&#x76EE;&#x6807;&#x5BF9;&#x8C61;&#x6267;&#x884C;
      Set<method> methods = signatureMap.get(method.getDeclaringClass());
      if (methods != null && methods.contains(method)) {
        // Invocation&#x5B58;&#x50A8;&#x4E86;&#x76EE;&#x6807;&#x5BF9;&#x8C61;&#x3001;&#x62E6;&#x622A;&#x65B9;&#x6CD5;&#x4EE5;&#x53CA;&#x65B9;&#x6CD5;&#x53C2;&#x6570;
        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) {
    // &#x83B7;&#x53D6;Intercepts&#x6CE8;&#x89E3;&#x503C;&#x4E0D;&#x80FD;&#x4E3A;&#x7A7A;
    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());
    }
    Signature[] sigs = interceptsAnnotation.value();
    // key &#x62E6;&#x622A;&#x7684;&#x7C7B;&#x578B;
    Map<class<?>, Set<method>> signatureMap = new HashMap<>();
    for (Signature sig : sigs) {
      Set<method> methods = signatureMap.computeIfAbsent(sig.type(), k -> new HashSet<>());
      try {
        // &#x83B7;&#x53D6;&#x62E6;&#x622A;&#x7684;&#x65B9;&#x6CD5;
        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<class<?>, Set<method>> signatureMap) {
    Set<class<?>> 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()]);
  }

}</class<?></method></class<?></method></method></class<?></method></class<?></method></method></class<?></method></class<?></method></class<?>
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Intercepts {
  /**
   * Returns method signatures to intercept.

   *
   * @return method signatures
   */
  Signature[] value();
}

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({})
public @interface Signature {
  /**
   * Returns the java type.

   *
   * @return the java type
   */
  Class<?> type();

  /**
   * Returns the method name.

   *
   * @return the method name
   */
  String method();

  /**
   * Returns java types for method argument.

   * @return java types for method argument
   */
  Class<?>[] args();
}

可以看到,当被拦截的方法被执行时主要调用自定义拦截器的intercept方法,把拦截对象、方法以及方法参数封装成Invocation对象传递过去。

在getSignatureMap方法中可以看到,自定义的拦截器类上需要添加Intercepts注解并且Signature需要有值,Signature注解中的type为需要拦截对象的接口(Executor.class/StatementHandler/ParameterHandler/ResultSetHandler),method为需要拦截的方法的方法名,args为拦截方法的方法参数类型。

3.参考例子

接下来举一个拦截器实现对结果集下划线转驼峰的例子来简要说明

/**
 * @author dxu2
 * @date 2022/7/14
 * map&#x7ED3;&#x679C;&#x8F6C;&#x9A7C;&#x5CF0;
 */
@Intercepts(value = {@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})})
public class MyInterceptor implements Interceptor {

  @SuppressWarnings("unchecked")
  @Override
  public Object intercept(Invocation invocation) throws Throwable {
    // &#x8C03;&#x7528;&#x76EE;&#x6807;&#x65B9;&#x6CD5;
    List<object> result = (List<object>) invocation.proceed();
    for (Object o : result) {
      if (o instanceof Map) {
        processMap((Map<string, object>) o);
      } else {
        break;
      }
    }
    return result;
  }

  @Override
  public Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }

  @Override
  public void setProperties(Properties properties) {

  }

  private void processMap(Map<string, object> map) {
    Set<string> keySet = new HashSet<>(map.keySet());
    for (String key : keySet) {
      if ((key.charAt(0) >= 'A' && key.charAt(0) <= 'z') || key.indexof("_")> 0) {
        Object value = map.get(key);
        map.remove(key);
        map.put(camel(key), value);
      }
    }
  }

  // &#x4E0B;&#x5212;&#x7EBF;&#x8F6C;&#x9A7C;&#x5CF0;
  private String camel(String fieldName) {
    StringBuffer stringBuffer = new StringBuffer();
    boolean flag = false;
    for (int i = 0; i < fieldName.length(); i++) {
      if (fieldName.charAt(i) == '_') {
        if (stringBuffer.length() > 0) {
          flag = true;
        }
      } else {
        if (flag) {
          stringBuffer.append(Character.toUpperCase(fieldName.charAt(i)));
          flag = false;
        } else {
          stringBuffer.append(Character.toLowerCase(fieldName.charAt(i)));
        }
      }
    }
    return stringBuffer.toString();
  }
}</=></string></string,></string,></object></object>

这个例子拦截的是ResultSetHandler的handleResultSets方法,这个方法是用来对结果集处理的,看intercept方法首先调用了目标对象的方法接着强转为List

最后不要忘了把自定义的拦截器添加到配置中,这边是使用xml配置的,添加完后接着运行测试代码,可以看到列user_id已经转换成驼峰形式了。

<plugins>
  <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  </plugin>
</plugins>
#mapper&#x63A5;&#x53E3;
List<map> selectAllUsers();

#mapper.xml
<select id="selectAllUsers" resulttype="map">
    select user_id, username, password, nickname
    from user
</select>

#java&#x6D4B;&#x8BD5;&#x7C7B;
public class Test {

  public static void main(String[] args) throws IOException {

    try (InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml")) {
      // &#x6784;&#x5EFA;session&#x5DE5;&#x5382; DefaultSqlSessionFactory
      SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
      SqlSession sqlSession = sqlSessionFactory.openSession();
      UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
      System.out.println(userMapper.selectAllUsers());
    }
  }

}</map>

mybatis 拦截器

Original: https://www.cnblogs.com/monianxd/p/16480643.html
Author: 默念x
Title: mybatis 拦截器

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/620890/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

  • django中的模板层简介

    1.什么是模板层 模板层可以根据视图中传递的字典数据动态生产相应的HTML页面 2.模板层的配置 1.&#x5728;&#x9879;&#x76EE;&am…

    数据库 2023年6月14日
    0119
  • 得体的注释,让我总能想起TA

    作为一个技术TL,在排查生产问题时,我经常要周转于各个工程里。系统和服务多起来后,要我了解每一段代码具体的来龙去脉逐渐几乎不可能了。 例如,今天,我要查一下调用某个三方接口所配置的…

    数据库 2023年6月9日
    0216
  • HackerRank第一趴–Basic Select

    ID number NAME VARCHAR2(17) COUNTRYCODE VARCHAR2(3) DISTRICT VARCHAR2(20) POPULATION numbe…

    数据库 2023年6月16日
    0132
  • 从零搭建云原生技术kubernetes(K8S)环境-通过kubesPhere的AllInOne方式

    前言 k8s云原生搭建,步骤有点多,但通过kubesphere,可以快速搭建k8s环境,同时有一个以 Kubernetes 为内核的云原生分布式操作系统-kubesphere,本文…

    数据库 2023年6月16日
    0137
  • MySQL45讲之主备数据一致性

    本文主要介绍 MySQL 主备数据同步的重要日志 binlog 的三种格式,和双 M 结构的循环复制问题。 binlog三种格式 1. statement格式 直接存储了执行的 S…

    数据库 2023年5月24日
    0131
  • JVM详解

    一、JVM的位置及体系结构 JVM作用在操作系统之上,而Java程序作用在jvm之上,其他的程序则与jvm并列 二、类加载器,及双亲委派机制 1.类加载器 作用:加载Class文件…

    数据库 2023年6月16日
    098
  • springboot使用Redis,监听Redis键过期的事件设置与使用代码

    我使用的是Windows下的Redis服务,所以一下Redis设置都是在Windows平台进行。 1、修改Redis配置文件 1.1:Windows下的Redis存在两个配置文件 …

    数据库 2023年6月16日
    0130
  • 事务的7种传播行为

    转载:https://blog.csdn.net/soonfly/article/details/70305683 事务传播行为 事务传播行为指的是当一个事务方法被另一个事务方法调…

    数据库 2023年6月6日
    0146
  • NO.3 Linux-笔记

    404. 抱歉,您访问的资源不存在。 可能是网址有误,或者对应的内容被删除,或者处于私有状态。 代码改变世界,联系邮箱 contact@cnblogs.com 园子的商业化努力-困…

    数据库 2023年6月14日
    0138
  • git拉项目出现的小问题

    问题描述 在IDEA中拉代码事报错。 点击查看报错信息 error: unable to read askpass response from ‘C:\Users\&#x9…

    数据库 2023年6月11日
    0137
  • MySQL select语句中where条件的提取过程

    select语句中where条件的提取过程 孔个个依然,在整理where条件提取过程时,发现中文互联网上关于这一块的知识要么是存在错误自相矛盾的,要么是版本过老,遂自己整理了一版。…

    数据库 2023年6月16日
    0130
  • Consul 入门-gRPC 服务注册与发现

    前言 &#x5047;&#x5982;&#x6211;&#x6709;&#x94B1;&#xFF0C;&#x6211;&am…

    数据库 2023年6月6日
    0133
  • asp.net(C#)接MYSQL8.0版本报错的处理方法

    由于新的操作系统没有安装mysql,项目中需要使用到,于是安装了最新版本的mysql8.0.28(我安装的是社区版),如果你的项目是老项目,使用的mysql插件是比较老的版本,安装…

    数据库 2023年5月24日
    0234
  • SQL的多表查询

    显示内连接: select 字段列表 from 表1 [inner] join 表2 on 连接条件; (PS:方括号(“[]”)内的为可选项;) (注意:…

    数据库 2023年6月16日
    0156
  • 强烈推荐一款优秀且通用的后台管理系统

    最近看到一款优秀的通用管理后台——likeadmin,推荐给大家。likeadmin的部署方式简单,界面美观,基于MIT协议,完全免费,非常值得一用。 likeadmin快速开发通…

    数据库 2023年6月14日
    0135
  • mysql约束

    一、表约束 PK主键约束(索引)唯一约束 非空 默认值 在关系数据库,一个表中,只能有一个主键(Primary Key),有些数据库没有pk,系统报出错误。 在myql数据库,建立…

    数据库 2023年6月9日
    0108
亲爱的 Coder【最近整理,可免费获取】👉 最新必读书单  | 👏 面试题下载  | 🌎 免费的AI知识星球