ToB企服应用市场:ToB评测及商务社交产业平台

标题: mybatis 拦截器 [打印本页]
作者: 魏晓东    时间: 2022-8-27 10:35
标题: mybatis 拦截器
1.mybatis拦截器介绍

拦截器可在mybatis进行sql底层处理的时候执行额外的逻辑，最常见的就是分页逻辑、对结果集进行处理过滤敏感信息等。
  1.   public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  2. <plugins>
  3.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  4.   </plugin>
  5. </plugins>ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
  6. <plugins>
  7.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  8.   </plugin>
  9. </plugins>parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
  10. <plugins>
  11.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  12.   </plugin>
  13. </plugins>return parameterHandler;
  14.   }
  16.   public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
  17. <plugins>
  18.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  19.   </plugin>
  20. </plugins>  ResultHandler resultHandler, BoundSql boundSql) {
  21. <plugins>
  22.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  23.   </plugin>
  24. </plugins>ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
  25. <plugins>
  26.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  27.   </plugin>
  28. </plugins>resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
  29. <plugins>
  30.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  31.   </plugin>
  32. </plugins>return resultSetHandler;
  33.   }
  35.   public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
  36. <plugins>
  37.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  38.   </plugin>
  39. </plugins>StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
  40. <plugins>
  41.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  42.   </plugin>
  43. </plugins>statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
  44. <plugins>
  45.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  46.   </plugin>
  47. </plugins>return statementHandler;
  48.   }
  50.   public Executor newExecutor(Transaction transaction) {
  51. <plugins>
  52.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  53.   </plugin>
  54. </plugins>return newExecutor(transaction, defaultExecutorType);
  55.   }
  57.   public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
  58. <plugins>
  59.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  60.   </plugin>
  61. </plugins>executorType = executorType == null ? defaultExecutorType : executorType;
  62. <plugins>
  63.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  64.   </plugin>
  65. </plugins>executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
  66. <plugins>
  67.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  68.   </plugin>
  69. </plugins>Executor executor;
  70. <plugins>
  71.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  72.   </plugin>
  73. </plugins>if (ExecutorType.BATCH == executorType) {
  74. <plugins>
  75.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  76.   </plugin>
  77. </plugins>  executor = new BatchExecutor(this, transaction);
  78. <plugins>
  79.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  80.   </plugin>
  81. </plugins>} else if (ExecutorType.REUSE == executorType) {
  82. <plugins>
  83.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  84.   </plugin>
  85. </plugins>  executor = new ReuseExecutor(this, transaction);
  86. <plugins>
  87.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  88.   </plugin>
  89. </plugins>} else {
  90. <plugins>
  91.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  92.   </plugin>
  93. </plugins>  executor = new SimpleExecutor(this, transaction);
  94. <plugins>
  95.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  96.   </plugin>
  97. </plugins>}
  98. <plugins>
  99.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  100.   </plugin>
  101. </plugins>if (cacheEnabled) {
  102. <plugins>
  103.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  104.   </plugin>
  105. </plugins>  executor = new CachingExecutor(executor);
  106. <plugins>
  107.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  108.   </plugin>
  109. </plugins>}
  110. <plugins>
  111.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  112.   </plugin>
  113. </plugins>executor = (Executor) interceptorChain.pluginAll(executor);
  114. <plugins>
  115.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  116.   </plugin>
  117. </plugins>return executor;
  118.   }
复制代码
从上面的代码可以看到mybatis支持的拦截类型只有四种（按拦截顺序）
1.Executor 执行器接口
2.StatementHandler sql构建处理器
3.ParameterHandler 参数处理器
4.ResultSetHandler 结果集处理器
 
2.拦截器原理
  1. public class InterceptorChain {
  3.   private final List<Interceptor> interceptors = new ArrayList<>();
  5.   // 遍历定义的拦截器，对拦截的对象进行包装
  6.   public Object pluginAll(Object target) {
  7. <plugins>
  8.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  9.   </plugin>
  10. </plugins>for (Interceptor interceptor : interceptors) {
  11. <plugins>
  12.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  13.   </plugin>
  14. </plugins>  target = interceptor.plugin(target);
  15. <plugins>
  16.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  17.   </plugin>
  18. </plugins>}
  19. <plugins>
  20.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  21.   </plugin>
  22. </plugins>return target;
  23.   }
  25.   public void addInterceptor(Interceptor interceptor) {
  26. <plugins>
  27.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  28.   </plugin>
  29. </plugins>interceptors.add(interceptor);
  30.   }
  32.   public List<Interceptor> getInterceptors() {
  33. <plugins>
  34.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  35.   </plugin>
  36. </plugins>return Collections.unmodifiableList(interceptors);
  37.   }
  39. }
  42. #Interceptor
  43. public interface Interceptor {
  45.   Object intercept(Invocation invocation) throws Throwable;
  47.   default Object plugin(Object target) {
  48. <plugins>
  49.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  50.   </plugin>
  51. </plugins>return Plugin.wrap(target, this);
  52.   }
  54.   default void setProperties(Properties properties) {
  55. <plugins>
  56.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  57.   </plugin>
  58. </plugins>// NOP
  59.   }
  61. }
复制代码
mybatis拦截器本质上使用了jdk动态代理，interceptorChain拦截器链中存储了用户定义的拦截器，会遍历进行对目标对象代理包装。
用户自定义拦截器类需要实现Interceptor接口，以及实现intercept方法，plugin和setProperties方法可重写，plugin方法一般不会改动，该方法调用了Plugin的静态方法wrap实现了对目标对象的代理
  1. public class Plugin implements InvocationHandler {
  3.   // 拦截目标对象
  4.   private final Object target;
  6.   // 拦截器对象-执行逻辑
  7.   private final Interceptor interceptor;
  9.   // 拦截接口和拦截方法的映射
  10.   private final Map<Class<?>, Set<Method>> signatureMap;
  12.   private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
  13. <plugins>
  14.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  15.   </plugin>
  16. </plugins>this.target = target;
  17. <plugins>
  18.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  19.   </plugin>
  20. </plugins>this.interceptor = interceptor;
  21. <plugins>
  22.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  23.   </plugin>
  24. </plugins>this.signatureMap = signatureMap;
  25.   }
  27.   // 获取jdk代理对象
  28.   public static Object wrap(Object target, Interceptor interceptor) {
  29. <plugins>
  30.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  31.   </plugin>
  32. </plugins>// 存储拦截接口和拦截方法的映射
  33. <plugins>
  34.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  35.   </plugin>
  36. </plugins>Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
  37. <plugins>
  38.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  39.   </plugin>
  40. </plugins>Class<?> type = target.getClass();
  41. <plugins>
  42.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  43.   </plugin>
  44. </plugins>// 获取拦截目标对象实现的接口，若为空则不代理
  45. <plugins>
  46.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  47.   </plugin>
  48. </plugins>Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
  49. <plugins>
  50.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  51.   </plugin>
  52. </plugins>if (interfaces.length > 0) {
  53. <plugins>
  54.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  55.   </plugin>
  56. </plugins>  return Proxy.newProxyInstance(
  57. <plugins>
  58.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  59.   </plugin>
  60. </plugins><plugins>
  61.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  62.   </plugin>
  63. </plugins>  type.getClassLoader(),
  64. <plugins>
  65.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  66.   </plugin>
  67. </plugins><plugins>
  68.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  69.   </plugin>
  70. </plugins>  interfaces,
  71. <plugins>
  72.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  73.   </plugin>
  74. </plugins><plugins>
  75.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  76.   </plugin>
  77. </plugins>  new Plugin(target, interceptor, signatureMap));
  78. <plugins>
  79.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  80.   </plugin>
  81. </plugins>}
  82. <plugins>
  83.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  84.   </plugin>
  85. </plugins>return target;
  86.   }
  88.   @Override
  89.   public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  90. <plugins>
  91.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  92.   </plugin>
  93. </plugins>try {
  94. <plugins>
  95.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  96.   </plugin>
  97. </plugins>  // 获取需要拦截的方法集合，若不存在则使用目标对象执行
  98. <plugins>
  99.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  100.   </plugin>
  101. </plugins>  Set<Method> methods = signatureMap.get(method.getDeclaringClass());
  102. <plugins>
  103.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  104.   </plugin>
  105. </plugins>  if (methods != null && methods.contains(method)) {
  106. <plugins>
  107.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  108.   </plugin>
  109. </plugins><plugins>
  110.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  111.   </plugin>
  112. </plugins>// Invocation存储了目标对象、拦截方法以及方法参数
  113. <plugins>
  114.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  115.   </plugin>
  116. </plugins><plugins>
  117.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  118.   </plugin>
  119. </plugins>return interceptor.intercept(new Invocation(target, method, args));
  120. <plugins>
  121.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  122.   </plugin>
  123. </plugins>  }
  124. <plugins>
  125.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  126.   </plugin>
  127. </plugins>  return method.invoke(target, args);
  128. <plugins>
  129.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  130.   </plugin>
  131. </plugins>} catch (Exception e) {
  132. <plugins>
  133.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  134.   </plugin>
  135. </plugins>  throw ExceptionUtil.unwrapThrowable(e);
  136. <plugins>
  137.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  138.   </plugin>
  139. </plugins>}
  140.   }
  142.   private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
  143. <plugins>
  144.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  145.   </plugin>
  146. </plugins>// 获取Intercepts注解值不能为空
  147. <plugins>
  148.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  149.   </plugin>
  150. </plugins>Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
  151. <plugins>
  152.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  153.   </plugin>
  154. </plugins>// issue #251
  155. <plugins>
  156.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  157.   </plugin>
  158. </plugins>if (interceptsAnnotation == null) {
  159. <plugins>
  160.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  161.   </plugin>
  162. </plugins>  throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
  163. <plugins>
  164.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  165.   </plugin>
  166. </plugins>}
  167. <plugins>
  168.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  169.   </plugin>
  170. </plugins>Signature[] sigs = interceptsAnnotation.value();
  171. <plugins>
  172.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  173.   </plugin>
  174. </plugins>// key 拦截的类型
  175. <plugins>
  176.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  177.   </plugin>
  178. </plugins>Map<Class<?>, Set<Method>> signatureMap = new HashMap<>();
  179. <plugins>
  180.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  181.   </plugin>
  182. </plugins>for (Signature sig : sigs) {
  183. <plugins>
  184.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  185.   </plugin>
  186. </plugins>  Set<Method> methods = signatureMap.computeIfAbsent(sig.type(), k -> new HashSet<>());
  187. <plugins>
  188.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  189.   </plugin>
  190. </plugins>  try {
  191. <plugins>
  192.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  193.   </plugin>
  194. </plugins><plugins>
  195.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  196.   </plugin>
  197. </plugins>// 获取拦截的方法
  198. <plugins>
  199.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  200.   </plugin>
  201. </plugins><plugins>
  202.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  203.   </plugin>
  204. </plugins>Method method = sig.type().getMethod(sig.method(), sig.args());
  205. <plugins>
  206.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  207.   </plugin>
  208. </plugins><plugins>
  209.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  210.   </plugin>
  211. </plugins>methods.add(method);
  212. <plugins>
  213.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  214.   </plugin>
  215. </plugins>  } catch (NoSuchMethodException e) {
  216. <plugins>
  217.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  218.   </plugin>
  219. </plugins><plugins>
  220.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  221.   </plugin>
  222. </plugins>throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
  223. <plugins>
  224.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  225.   </plugin>
  226. </plugins>  }
  227. <plugins>
  228.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  229.   </plugin>
  230. </plugins>}
  231. <plugins>
  232.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  233.   </plugin>
  234. </plugins>return signatureMap;
  235.   }
  237.   private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
  238. <plugins>
  239.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  240.   </plugin>
  241. </plugins>Set<Class<?>> interfaces = new HashSet<>();
  242. <plugins>
  243.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  244.   </plugin>
  245. </plugins>while (type != null) {
  246. <plugins>
  247.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  248.   </plugin>
  249. </plugins>  for (Class<?> c : type.getInterfaces()) {
  250. <plugins>
  251.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  252.   </plugin>
  253. </plugins><plugins>
  254.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  255.   </plugin>
  256. </plugins>if (signatureMap.containsKey(c)) {
  257. <plugins>
  258.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  259.   </plugin>
  260. </plugins><plugins>
  261.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  262.   </plugin>
  263. </plugins>  interfaces.add(c);
  264. <plugins>
  265.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  266.   </plugin>
  267. </plugins><plugins>
  268.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  269.   </plugin>
  270. </plugins>}
  271. <plugins>
  272.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  273.   </plugin>
  274. </plugins>  }
  275. <plugins>
  276.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  277.   </plugin>
  278. </plugins>  type = type.getSuperclass();
  279. <plugins>
  280.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  281.   </plugin>
  282. </plugins>}
  283. <plugins>
  284.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  285.   </plugin>
  286. </plugins>return interfaces.toArray(new Class<?>[interfaces.size()]);
  287.   }
  289. }
复制代码
  1. @Documented
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Target(ElementType.TYPE)
  4. public @interface Intercepts {
  5.   /**
  6.    * Returns method signatures to intercept.
  7.    *
  8.    * @return method signatures
  9.    */
  10.   Signature[] value();
  11. }
  13. @Documented
  14. @Retention(RetentionPolicy.RUNTIME)
  15. @Target({})
  16. public @interface Signature {
  17.   /**
  18.    * Returns the java type.
  19.    *
  20.    * @return the java type
  21.    */
  22.   Class<?> type();
  24.   /**
  25.    * Returns the method name.
  26.    *
  27.    * @return the method name
  28.    */
  29.   String method();
  31.   /**
  32.    * Returns java types for method argument.
  33.    * @return java types for method argument
  34.    */
  35.   Class<?>[] args();
  36. }
复制代码
可以看到，当被拦截的方法被执行时主要调用自定义拦截器的intercept方法，把拦截对象、方法以及方法参数封装成Invocation对象传递过去。
在getSignatureMap方法中可以看到，自定义的拦截器类上需要添加Intercepts注解并且Signature需要有值，Signature注解中的type为需要拦截对象的接口（Executor.class/StatementHandler/ParameterHandler/ResultSetHandler），method为需要拦截的方法的方法名，args为拦截方法的方法参数类型。
3.参考例子

接下来举一个拦截器实现对结果集下划线转驼峰的例子来简要说明
  1. /**
  2. * @author dxu2
  3. * @date 2022/7/14
  4. * map结果转驼峰
  5. */
  6. @Intercepts(value = {@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})})
  7. public class MyInterceptor implements Interceptor {
  9.   @SuppressWarnings("unchecked")
  10.   @Override
  11.   public Object intercept(Invocation invocation) throws Throwable {
  12. <plugins>
  13.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  14.   </plugin>
  15. </plugins>// 调用目标方法
  16. <plugins>
  17.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  18.   </plugin>
  19. </plugins>List<Object> result = (List<Object>) invocation.proceed();
  20. <plugins>
  21.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  22.   </plugin>
  23. </plugins>for (Object o : result) {
  24. <plugins>
  25.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  26.   </plugin>
  27. </plugins>  if (o instanceof Map) {
  28. <plugins>
  29.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  30.   </plugin>
  31. </plugins><plugins>
  32.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  33.   </plugin>
  34. </plugins>processMap((Map<String, Object>) o);
  35. <plugins>
  36.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  37.   </plugin>
  38. </plugins>  } else {
  39. <plugins>
  40.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  41.   </plugin>
  42. </plugins><plugins>
  43.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  44.   </plugin>
  45. </plugins>break;
  46. <plugins>
  47.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  48.   </plugin>
  49. </plugins>  }
  50. <plugins>
  51.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  52.   </plugin>
  53. </plugins>}
  54. <plugins>
  55.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  56.   </plugin>
  57. </plugins>return result;
  58.   }
  60.   @Override
  61.   public Object plugin(Object target) {
  62. <plugins>
  63.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  64.   </plugin>
  65. </plugins>return Plugin.wrap(target, this);
  66.   }
  68.   @Override
  69.   public void setProperties(Properties properties) {
  71.   }
  74.   private void processMap(Map<String, Object> map) {
  75. <plugins>
  76.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  77.   </plugin>
  78. </plugins>Set<String> keySet = new HashSet<>(map.keySet());
  79. <plugins>
  80.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  81.   </plugin>
  82. </plugins>for (String key : keySet) {
  83. <plugins>
  84.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  85.   </plugin>
  86. </plugins>  if ((key.charAt(0) >= 'A' && key.charAt(0) <= 'Z') || key.indexOf("_") > 0) {
  87. <plugins>
  88.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  89.   </plugin>
  90. </plugins><plugins>
  91.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  92.   </plugin>
  93. </plugins>Object value = map.get(key);
  94. <plugins>
  95.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  96.   </plugin>
  97. </plugins><plugins>
  98.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  99.   </plugin>
  100. </plugins>map.remove(key);
  101. <plugins>
  102.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  103.   </plugin>
  104. </plugins><plugins>
  105.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  106.   </plugin>
  107. </plugins>map.put(camel(key), value);
  108. <plugins>
  109.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  110.   </plugin>
  111. </plugins>  }
  112. <plugins>
  113.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  114.   </plugin>
  115. </plugins>}
  116.   }
  118.   // 下划线转驼峰
  119.   private String camel(String fieldName) {
  120. <plugins>
  121.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  122.   </plugin>
  123. </plugins>StringBuffer stringBuffer = new StringBuffer();
  124. <plugins>
  125.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  126.   </plugin>
  127. </plugins>boolean flag = false;
  128. <plugins>
  129.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  130.   </plugin>
  131. </plugins>for (int i = 0; i < fieldName.length(); i++) {
  132. <plugins>
  133.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  134.   </plugin>
  135. </plugins>  if (fieldName.charAt(i) == '_') {
  136. <plugins>
  137.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  138.   </plugin>
  139. </plugins><plugins>
  140.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  141.   </plugin>
  142. </plugins>if (stringBuffer.length() > 0) {
  143. <plugins>
  144.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  145.   </plugin>
  146. </plugins><plugins>
  147.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  148.   </plugin>
  149. </plugins>  flag = true;
  150. <plugins>
  151.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  152.   </plugin>
  153. </plugins><plugins>
  154.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  155.   </plugin>
  156. </plugins>}
  157. <plugins>
  158.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  159.   </plugin>
  160. </plugins>  } else {
  161. <plugins>
  162.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  163.   </plugin>
  164. </plugins><plugins>
  165.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  166.   </plugin>
  167. </plugins>if (flag) {
  168. <plugins>
  169.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  170.   </plugin>
  171. </plugins><plugins>
  172.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  173.   </plugin>
  174. </plugins>  stringBuffer.append(Character.toUpperCase(fieldName.charAt(i)));
  175. <plugins>
  176.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  177.   </plugin>
  178. </plugins><plugins>
  179.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  180.   </plugin>
  181. </plugins>  flag = false;
  182. <plugins>
  183.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  184.   </plugin>
  185. </plugins><plugins>
  186.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  187.   </plugin>
  188. </plugins>} else {
  189. <plugins>
  190.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  191.   </plugin>
  192. </plugins><plugins>
  193.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  194.   </plugin>
  195. </plugins>  stringBuffer.append(Character.toLowerCase(fieldName.charAt(i)));
  196. <plugins>
  197.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  198.   </plugin>
  199. </plugins><plugins>
  200.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  201.   </plugin>
  202. </plugins>}
  203. <plugins>
  204.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  205.   </plugin>
  206. </plugins>  }
  207. <plugins>
  208.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  209.   </plugin>
  210. </plugins>}
  211. <plugins>
  212.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  213.   </plugin>
  214. </plugins>return stringBuffer.toString();
  215.   }
  216. }
复制代码
这个例子拦截的是ResultSetHandler的handleResultSets方法，这个方法是用来对结果集处理的，看intercept方法首先调用了目标对象的方法接着强转为List类型，这里为什么可以强转呢，因为我们可以看到handleResultSets方法定义 List handleResultSets(Statement stmt) throws SQLException; 返回的是List类型，然后遍历列表，若元素是map类型的再进行处理把key值转化为驼峰形式重新put到map中。
最后不要忘了把自定义的拦截器添加到配置中，这边是使用xml配置的，添加完后接着运行测试代码，可以看到列user_id已经转换成驼峰形式了。
  1. <plugins>
  2.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  3.   </plugin>
  4. </plugins>
复制代码
  1. #mapper接口List selectAllUsers();#mapper.xml<plugins>
  2.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  3.   </plugin>
  4. </plugins>select user_id, username, password, nickname<plugins>
  5.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  6.   </plugin>
  7. </plugins>from user<plugins>
  8.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  9.   </plugin>
  10. </plugins><plugins>
  11.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  12.   </plugin>
  13. </plugins>#java测试类public class Test {  public static void main(String[] args) throws IOException {<plugins>
  14.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  15.   </plugin>
  16. </plugins>try (InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml")) {<plugins>
  17.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  18.   </plugin>
  19. </plugins>  // 构建session工厂 DefaultSqlSessionFactory<plugins>
  20.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  21.   </plugin>
  22. </plugins>  SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);<plugins>
  23.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  24.   </plugin>
  25. </plugins>  SqlSession sqlSession = sqlSessionFactory.openSession();<plugins>
  26.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  27.   </plugin>
  28. </plugins>  UserMapper userMapper = sqlSession.getMapper(UserMapper.class);<plugins>
  29.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  30.   </plugin>
  31. </plugins>  System.out.println(userMapper.selectAllUsers());<plugins>
  32.   <plugin interceptor="org.apache.ibatis.study.interceptor.MyInterceptor">
  33.   </plugin>
  34. </plugins>}  }}
复制代码
 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4