经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 数据库/运维 » MyBatis » 查看文章
mybatis plugin源码解析
来源：cnblogs　　作者：睦月初雨　　时间：2024/4/10 15:38:11　　对本文有异议

概述

Plugin，意为插件，是mybatis为开发者提供的，对方法进行自定义编程的手段。其中用到了动态代理、反射方法，通过指定需要增强的对象与方法，进行程序编写。

核心类

主要涉及几个核心类：Interceptor、Plugin、Intercepts

该增强功能的大致执行顺序为：

  1. 项目启动时，查询实现了Interceptor接口并且注册为Bean（或在xml文件中指定）的类，放入SqlSessionFactoryBean的Interceptor[]参数中，再由SqlSessionFactoryBean创建SqlSessionFactory的时候，将其放入Configuration参数中，留作后续调用

    1. // **注意interceptorsProvider，此为SpringBoot的configuration，会自动查询注册为Bean的Interceptor**
    2. public MybatisAutoConfiguration(MybatisProperties properties, ObjectProvider<Interceptor[]> interceptorsProvider,
    3.       ObjectProvider<TypeHandler[]> typeHandlersProvider, ObjectProvider<LanguageDriver[]> languageDriversProvider,
    4.       ResourceLoader resourceLoader, ObjectProvider<DatabaseIdProvider> databaseIdProvider,
    5.       ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider,
    6.       ObjectProvider<List<SqlSessionFactoryBeanCustomizer>> sqlSessionFactoryBeanCustomizers) {
    7.     this.properties = properties;
    8.     this.interceptors = interceptorsProvider.getIfAvailable();
    9.     this.typeHandlers = typeHandlersProvider.getIfAvailable();
    10.     this.languageDrivers = languageDriversProvider.getIfAvailable();
    11.     this.resourceLoader = resourceLoader;
    12.     this.databaseIdProvider = databaseIdProvider.getIfAvailable();
    13.     this.configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
    14.     this.sqlSessionFactoryBeanCustomizers = sqlSessionFactoryBeanCustomizers.getIfAvailable();
    15.  }
    16.  
    17.  
    18. @Bean
    19. @ConditionalOnMissingBean
    20. public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    21.   SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
    22.   factory.setDataSource(dataSource);
    23.   .....
    24.   // **注意此处，将interceptors放入factory中**
    25.   if (!ObjectUtils.isEmpty(this.interceptors)) {
    26.     factory.setPlugins(this.interceptors);
    27.   }
    28. 	.....
    29. }
    31. public class SqlSessionFactoryBean
    32. 		protected SqlSessionFactory buildSqlSessionFactory() throws Exception {
    33. 		....... 
    34. 	    if (!isEmpty(this.typeAliases)) {
    35. 	      Stream.of(this.typeAliases).forEach(typeAlias -> {
    36. 	        targetConfiguration.getTypeAliasRegistry().registerAlias(typeAlias);
    37. 	        LOGGER.debug(() -> "Registered type alias: '" + typeAlias + "'");
    38. 	      });
    39. 	    }
    40. 	
    41. 	    if (!isEmpty(this.plugins)) {
    42. 	      Stream.of(this.plugins).forEach(plugin -> {
    43. 	        targetConfiguration.addInterceptor(plugin);
    44. 	        LOGGER.debug(() -> "Registered plugin: '" + plugin + "'");
    45. 	      });
    46. 	    }
    47. 			.......
    48. 	
    49. 	    return this.sqlSessionFactoryBuilder.build(targetConfiguration);
    50. 	  }
    51. }

  2. Configuration类在初始化ParameterHandler、ResultSetHandler、StatementHandler、Executor四个类时，会对它们进行一次封装，封装内容即为用Interceptors注册插件功能，达到增强效果

    1. public class Configuration {
    3. 	public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
    4.     ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
    5.     parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
    6.     return parameterHandler;
    7.   }
    9.   public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
    10.       ResultHandler resultHandler, BoundSql boundSql) {
    11.     ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
    12.     resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
    13.     return resultSetHandler;
    14.   }
    16.   public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    17.     StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
    18.     statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
    19.     return statementHandler;
    20.   }
    21.   
    22.   public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    23.     executorType = executorType == null ? defaultExecutorType : executorType;
    24.     executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
    25.     Executor executor;
    26.     if (ExecutorType.BATCH == executorType) {
    27.       executor = new BatchExecutor(this, transaction);
    28.     } else if (ExecutorType.REUSE == executorType) {
    29.       executor = new ReuseExecutor(this, transaction);
    30.     } else {
    31.       executor = new SimpleExecutor(this, transaction);
    32.     }
    33.     if (cacheEnabled) {
    34.       executor = new CachingExecutor(executor);
    35.     }
    36.     executor = (Executor) interceptorChain.pluginAll(executor);
    37.     return executor;
    38.   }
    40. }

  3. Configuration执行的pluginAll方法，内部是通过遍历Interceptor数组的plugin方法实现的。该方法入参和出参都是Object类型，所以可以认为它能为所有类型对象都进行增强封装。Interceptor内部调用了Plugin的wrap方法，对Object对象进行了封装。

    1. public class InterceptorChain {
    3.   private final List<Interceptor> interceptors = new ArrayList<>();
    5.   public Object pluginAll(Object target) {
    6.     for (Interceptor interceptor : interceptors) {
    7.       target = interceptor.plugin(target);
    8.     }
    9.     return target;
    10.   }
    12.   public void addInterceptor(Interceptor interceptor) {
    13.     interceptors.add(interceptor);
    14.   }
    16.   public List<Interceptor> getInterceptors() {
    17.     return Collections.unmodifiableList(interceptors);
    18.   }
    20. }
    22. public interface Interceptor {
    24.   Object intercept(Invocation invocation) throws Throwable;
    26.   default Object plugin(Object target) {
    27.     return Plugin.wrap(target, this);
    28.   }
    30.   default void setProperties(Properties properties) {
    31.     // NOP
    32.   }
    34. }

  4. Plugin方法实现了InvocationHandler动态代理类，并且wrap方法本身便是创建动态代理类。故Plugin类的职责有两项：

    1. 创建动态代理类，指定需要被代理（增强）的对象。此处为Executor、Handler等。
    2. 指定被动态代理的对象，需要执行何种程序。重点关注invoke方法。
    1. public class Plugin implements InvocationHandler {
    3.   private final Object target;
    4.   private final Interceptor interceptor;
    5.   private final Map<Class<?>, Set<Method>> signatureMap;
    7.   private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
    8.     this.target = target;
    9.     this.interceptor = interceptor;
    10.     this.signatureMap = signatureMap;
    11.   }
    13. 	// **创建动态代理对象**
    14.   public static Object wrap(Object target, Interceptor interceptor) {
    15.     Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
    16.     Class<?> type = target.getClass();
    17.     Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
    18.     if (interfaces.length > 0) {
    19.       return Proxy.newProxyInstance(
    20.           type.getClassLoader(),
    21.           interfaces,
    22.           new Plugin(target, interceptor, signatureMap));
    23.     }
    24.     return target;
    25.   }
    27. 	// **动态代理增强**
    28.   @Override
    29.   public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    30.     try {
    31.       Set<Method> methods = signatureMap.get(method.getDeclaringClass());
    32.       if (methods != null && methods.contains(method)) {
    33.         return interceptor.intercept(new Invocation(target, method, args));
    34.       }
    35.       return method.invoke(target, args);
    36.     } catch (Exception e) {
    37.       throw ExceptionUtil.unwrapThrowable(e);
    38.     }
    39.   }
    40. 	
    41. 	// 省略getSignatureMap,getAllInterfaces方法
    42. 	...
    43. }

  5. wrap方法执行时需要先通过interceptor获取signatureMap。Signature是Intercepts注解中的value值注解，由于此value的返回值是数组，所以Signature会多个存在，最后解析出的结果便为signatureMap。

    Signature注解的作用为标注被动态代理的对象，具体的类型（class），具体的方法，方法具体的参数。只有特定类型和方法才会执行Interceptor方法。

    1. public class Plugin implements InvocationHandler {
    3.   private final Object target;
    4.   private final Interceptor interceptor;
    5.   private final Map<Class<?>, Set<Method>> signatureMap;
    7.   private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
    8.     this.target = target;
    9.     this.interceptor = interceptor;
    10.     this.signatureMap = signatureMap;
    11.   }
    13.   private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    14.     Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
    15.     **// 通过此代码可发现，实现Interceptor的类必须添加Intercepts注解**
    16.     if (interceptsAnnotation == null) {
    17.       throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
    18.     }
    19.     Signature[] sigs = interceptsAnnotation.value();
    20.     Map<Class<?>, Set<Method>> signatureMap = new HashMap<>();
    21.     for (Signature sig : sigs) {
    22.       Set<Method> methods = MapUtil.computeIfAbsent(signatureMap, sig.type(), k -> new HashSet<>());
    23.       try {
    24. 	      **// 通过Siganture的method与args，反射出Method对象，将其添加到map中
    25. 	      // 作用是在执行动态代理invoke方法时，判断当前方法是否需要被interceptor执行**
    26.         Method method = sig.type().getMethod(sig.method(), sig.args());
    27.         methods.add(method);
    28.       } catch (NoSuchMethodException e) {
    29.         throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
    30.       }
    31.     }
    32.     return signatureMap;
    33.   }
    35. }

  6. 通过阅读源码可知，开发者需要自己实现Interceptor，标记Intercepts注解，指定需要拦截的类、方法名，方法上的参数类型。并将Interceptor注册为Spring Bean。即可在interceptor方法中编写具体拦截代码。

实例

背景：在项目上为每一个需要插入至数据库中的实例对象，初始化id。

代码：

  1. @Component
  2. **// 拦截Executor类的update方法，该update方法会执行insert、update、delete操作**
  3. @Intercepts(@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}))
  4. public class MybatisUpdateInterceptor implements Interceptor {
  6. 	// 雪花算法id生成器
  7. 	@Autowired
  8. 	private IdGenerator idGenerator;
  10. 	@Override
  11. 	public Object intercept(Invocation invocation) throws Throwable {
  12. 		Method method = invocation.getMethod();
  13. 		MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
  14. 		**// 判断是否为insert方法**
  15. 		if (ms.getSqlCommandType() != SqlCommandType.INSERT) {
  16. 			return invocation.proceed();
  17. 		}
  18. 		BaseEntity entity = (BaseEntity) invocation.getArgs()[1];
  19. 		if (entity.getId() == null) {
  20. 			entity.setId(idGenerator.generate());
  21. 		}
  22. 		return method.invoke(invocation.getTarget(), invocation.getArgs());
  23. 	}
  25. }

总结

项目开发者可灵活运用plugin，为数据库操作进行增强。日常开发中也可借鉴此流程，通过动态代理方式设计拦截/增强手段。

原文链接：https://www.cnblogs.com/sumray/p/18126151

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

MyBatis热门文章

  • Mybatis使用连表查询的操作代码
  • Mybatis-plus如何查询表中指定字段(不查询全部字段)
  • mybatis/mybatis-plus模糊查询语句特殊字符转义拦截器的实现
  • MyBatis注解开发-@Insert和@InsertProvider的使用
  • springboot+mybatis报错找不到实体类的问题
  • mybatis 忽略实体对象的某个属性(2种方式)
  • mybatis update set 多个字段实例
  • 如何通过一个注解实现MyBatis字段加解密
  • oracle+mybatis-plus+springboot实现分页查询的实例
  • MybatisPlus中的insert操作详解

    • MyBatis推荐文章

  • Mybatis-Plus最优化持久层开发
  • MyBatis 的在使用上的注意事项及其辨析 - Rainbow-Sea
  • 在 Wed 中应用 MyBatis（同时使用MVC架构模式，以及ThreadLocal 事务控制） - Rainbow-Sea
  • MyBatis源码之前言—JDBC编码存在的问题和Mybatis的介绍
  • mybatis plugin源码解析
  • Spring Boot + MyBatis-Plus 实现 MySQL 主从复制动态数据源切换
  • 一种轻量分表方案-MyBatis拦截器分表实践
  • 使用Mybatis自定义插件实现不侵入业务的公共参数自动追加
  • MyBatis-Plus雪花算法实现源码解析
  • Mybatis和其他主流框架的整合使用

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号