mybatis 拦截器

打印 上一主题 下一主题

主题 835|帖子 835|积分 2505

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

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

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
回复

使用道具 举报

0 个回复

正序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

魏晓东

金牌会员
这个人很懒什么都没写!
快速回复 返回顶部 返回列表