皮皮网

1.mybatis插件机制源码解析
2.深入浅出 MyBatis 的一级、二级缓存机制
3.源码分析Mybatis MapperProxy初始化图文并茂
4.为什么 MyBatis 源码中，没有我那种 if···else
5.MyBatis源码之MyBatis中SQL语句执行过程

mybatis插件机制源码解析

       引言

       本篇源码解析基于MyBatis3.5.8版本。

       首先需要说明的是，本篇文章不是mybatis插件开发的教程，而是在线笔记源码注册从源码层面分析mybatis是如何支持用户自定义插件开发的。

       mybatis的插件机制，让其扩展能力大大增加。比如我们项目中经常用到的PageHelper，这就是一款基于mybatis插件能力开发的产品，它的功能是让基于mybatis的数据库分页查询更容易使用。

       当然基于插件我们还可以开发其它功能，比如在执行sql前打印日志、做权限控制等。

正文

       mybatis插件也叫mybatis拦截器，它支持从方法级别对mybatis进行拦截。整体架构图如下：

       解释下几个相关概念：

       Interceptor拦截器接口，用户自定义的拦截器就是实现该接口。

       InterceptorChain拦截器链，其内部维护一个interceptorslist,表示拦截器链中所有的拦截器，并提供增加或获取拦截器链的方法。比如有个核心的方法是pluginAll。该方法用来生成代理对象。

       Invocation拦截器执行时的上下文环境，其实就是目标方法的调用信息，包含目标对象、调用的方法信息、参数信息。导航站源码安装核心方法是proceed。该方法的主要目的就是进行处理链的传播，执行完拦截器的方法后，最终需要调用目标方法的invoke方法。

       mybatis支持在哪些地方进行拦截呢？你只需要在代码里搜索interceptorChain.pluginAll的使用位置就可以获取答案，一共有四处：

parameterHandler=(ParameterHandler)interceptorChain.pluginAll(parameterHandler);resultSetHandler=(ResultSetHandler)interceptorChain.pluginAll(resultSetHandler);statementHandler=(StatementHandler)interceptorChain.pluginAll(statementHandler);executor=(Executor)interceptorChain.pluginAll(executor);

       这四处实现的原理都是一样的，我们只需要选择一个进行分析就可以了。

       我们先来看下自定义的插件是如何加载进来的，比如我们使用PageHelper插件，通常会在mybatis-config.xml中加入如下的配置：

<plugins><plugininterceptor="com.github.pagehelper.PageInterceptor"><!--configparamsasthefollowing--><propertyname="param1"value="value1"/></plugin></plugins>

       mybatis在创建SqlSessionFactory的时候会加载配置文件，

publicConfigurationparse(){ if(parsed){ thrownewBuilderException("EachXMLConfigBuildercanonlybeusedonce.");}parsed=true;parseConfiguration(parser.evalNode("/configuration"));returnconfiguration;}

       parseConfiguration方法会加载包括plugins在内的很多配置，

privatevoidparseConfiguration(XNoderoot){ try{ ...pluginElement(root.evalNode("plugins"));...}catch(Exceptione){ thrownewBuilderException("ErrorparsingSQLMapperConfiguration.Cause:"+e,e);}}privatevoidpluginElement(XNodeparent)throwsException{ if(parent!=null){ for(XNodechild:parent.getChildren()){ Stringinterceptor=child.getStringAttribute("interceptor");Propertiesproperties=child.getChildrenAsProperties();InterceptorinterceptorInstance=(Interceptor)resolveClass(interceptor).getDeclaredConstructor().newInstance();interceptorInstance.setProperties(properties);configuration.addInterceptor(interceptorInstance);}}}

       pluginElement干了几件事情：

       创建Interceptor实例

       设置实例的属性变量

       添加到Configuration的interceptorChain拦截器链中

       mybatis的插件是通过动态代理实现的，那肯定要生成代理对象，生成的逻辑就是前面提到的pluginAll方法，比如对于Executor生成代理对象就是，

executor=(Executor)interceptorChain.pluginAll(executor);

       接着看pluginAll方法，

/***该方法会遍历用户定义的插件实现类（Interceptor），并调用Interceptor的plugin方法，对target进行插件化处理，*即我们在实现自定义的Interceptor方法时，在plugin中需要根据自己的逻辑，对目标对象进行包装（代理），创建代理对象，*那我们就可以在该方法中使用Plugin#wrap来创建代理类。*/publicObjectpluginAll(Objecttarget){ for(Interceptorinterceptor:interceptors){ target=interceptor.plugin(target);}returntarget;}

       这里遍历所有我们定义的拦截器，调用拦截器的plugin方法生成代理对象。有人可能有疑问：如果有多个拦截器，仿小草影视源码target不是被覆盖了吗？

       其实不会，所以如果有多个拦截器的话，生成的代理对象会被另一个代理对象代理，从而形成一个代理链条，执行的时候，依次执行所有拦截器的拦截逻辑代码。

       plugin方法是接口Interceptor的默认实现类，

defaultObjectplugin(Objecttarget){ returnPlugin.wrap(target,this);}

       然后进入org.apache.ibatis.plugin.Plugin#wrap，

publicstaticObjectwrap(Objecttarget,Interceptorinterceptor){ Map<Class<?>,Set<Method>>signatureMap=getSignatureMap(interceptor);Class<?>type=target.getClass();Class<?>[]interfaces=getAllInterfaces(type,signatureMap);if(interfaces.length>0){ returnProxy.newProxyInstance(type.getClassLoader(),interfaces,newPlugin(target,interceptor,signatureMap));}returntarget;}

       首先是获取我们自己实现的Interceptor的方法签名映射表。然后获取需要代理的对象的Class上声明的所有接口。比如如果我们wrap的是Executor，就是Executor的所有接口。然后就是最关键的一步，用Proxy类创建一个代理对象（newProxyInstance）。

       注意，newProxyInstance方法的第三个参数，接收的是一个InvocationHandler对象，表示的是当动态代理对象调用方法的时候会关联到哪一个InvocationHandler对象上，并最终由其调用。

       我们这里传入的是Plugin类，故在动态运行过程中会执行Plugin的invoker方法。

       如果对这一段不是很理解，建议先了解下java动态代理的原理。java动态代理机制中有两个重要的角色：InvocationHandler（接口）和Proxy（类），这个是背景知识需要掌握的。

       我们在深入看下上面的getSignatureMap方法，

privatestaticMap<Class<?亚洲AV源码天堂>,Set<Method>>getSignatureMap(Interceptorinterceptor){ //从Interceptor的类上获取Intercepts注解，说明我们自定义拦截器需要带注解InterceptsinterceptsAnnotation=interceptor.getClass().getAnnotation(Intercepts.class);//issue#if(interceptsAnnotation==null){ thrownewPluginException("No@Interceptsannotationwasfoundininterceptor"+interceptor.getClass().getName());}Signature[]sigs=interceptsAnnotation.value();Map<Class<?>,Set<Method>>signatureMap=newHashMap<>();//解析Interceptor的values属性（Signature[]）数组，存入HashMap,Set<Method>>for(Signaturesig:sigs){ Set<Method>methods=MapUtil.computeIfAbsent(signatureMap,sig.type(),k->newHashSet<>());try{ Methodmethod=sig.type().getMethod(sig.method(),sig.args());methods.add(method);}catch(NoSuchMethodExceptione){ thrownewPluginException("Couldnotfindmethodon"+sig.type()+"named"+sig.method()+".Cause:"+e,e);}}returnsignatureMap;}

       首先需要从Interceptor的类上获取Intercepts注解，说明我们自定义拦截器需要带注解，比如PageHelper插件的定义如下：

<plugins><plugininterceptor="com.github.pagehelper.PageInterceptor"><!--configparamsasthefollowing--><propertyname="param1"value="value1"/></plugin></plugins>0

       所以我们可以知道，getSignatureMap其实就是拿到我们自定义拦截器声明需要拦截的类以及类对应的方法。

       前面说过，当我们调用代理对象时，最终会执行Plugin类的invoker方法，我们看下Plugin的invoker方法，

<plugins><plugininterceptor="com.github.pagehelper.PageInterceptor"><!--configparamsasthefollowing--><propertyname="param1"value="value1"/></plugin></plugins>1

       Interceptor接口的intercept方法就是我们自定义拦截器需要实现的逻辑，其参数为Invocation，可从Invocation参数中拿到执行方法的对象，方法，方法参数，比如我们可以从statementHandler拿到SQL语句，实现自己的特殊逻辑。

       在该方法的结束需要调用invocation#proceed()方法，进行拦截器链的传播。

       参考：

       blogs.com/chenpi/p/.html

深入浅出 MyBatis 的一级、二级缓存机制

       深入浅出 MyBatis 的一级、二级缓存机制

       缓存机制是提升系统性能的关键手段之一，MyBatis 作为一款优秀的持久层框架，同样提供了缓存支持，分为一级缓存和二级缓存。一级缓存是 SqlSession 级别的缓存，而二级缓存则是 Mapper 级别的缓存。在实际应用中，画线火柴人源码理解并合理使用缓存可以显著提升系统的响应速度和性能。

       一级缓存的作用是存储 SqlSession 执行的 SQL 查询结果，当再次执行相同 SQL 时，如果缓存命中，则直接返回缓存中的数据，避免了重复查询数据库。一级缓存的内部结构通过 DefaultSqlSession 类中的 PerpetualCache 实现，当用户发起查询时，MyBatis 在 Local Cache 中进行查询，如果命中则返回结果，未命中则查询数据库并将结果写入 Cache。

       一级缓存的配置默认为 SESSION 级别，但也可以设置为 STATEMENT 级别，以更细粒度地控制缓存范围。通过实验可以直观地观察到一级缓存的效果，比如查询、修改数据库操作对缓存的影响，以及不同 SqlSession 之间的缓存隔离。

       一级缓存的工作流程涉及 SqlSession、Executor 和 Cache，其中 Executor 执行 SQL 请求并负责缓存管理，Cache 接口提供缓存的基本操作。通过源码分析，可以深入理解一级缓存的实现细节，包括缓存的创建、查询和刷新机制。

       二级缓存的引入是为了实现多个 SqlSession 之间的缓存数据共享，它基于 namespace 进行管理，使得同一个 namespace 下的操作共享缓存。二级缓存的配置需要在全局配置文件中开启，并确保实体类实现 Serializable 接口以支持缓存数据的序列化与反序列化。

       通过实验，可以验证二级缓存与一级缓存的差异，比如测试缓存与 SqlSession 的关系、执行 commit 操作对缓存的影响，以及多表查询场景下的缓存问题和解决方案。

       二级缓存的工作流程类似于一级缓存，涉及 CachingExecutor、TransactionalCache 等组件，通过装饰器模式实现缓存的管理。源码分析揭示了二级缓存的实现细节，包括缓存的创建、查询、刷新以及与事务的交互。

       总结而言，MyBatis 的一级缓存和二级缓存提供了数据缓存功能，有助于提升系统性能，但需要根据实际应用场景合理配置和使用。一级缓存在多个 SqlSession 或分布式环境下可能存在局限性，而二级缓存在多表查询场景中也可能导致脏数据问题。生产环境中通常建议关闭缓存机制，以避免潜在的问题。

源码分析Mybatis MapperProxy初始化图文并茂

       源码分析Mybatis MapperProxy初始化，本文基于Mybatis.3.x版本，展现作者阅读源码技巧。MapperScannerConfigurer作为Spring整合Mybatis的核心类，负责扫描项目中Dao类，并创建Mybatis的Maper对象即MapperProxy对象。

       在项目配置文件中，关注到与Mapper相关的配置信息。源码分析的行文思路如下，可能会比较枯燥，但先给出MapperProxy的创建序列图，有助于理解。

       MapperScannerConfigurer类图，实现Spring Bean生命周期相关功能。核心类及其作用简述如下：

       BeanDefinitionRegistryPostProcessor负责设置SqlSessionFactory，生成的Mapper最终受该SqlSessionFactory管辖。

       ClassPathMapperScanner的scan方法进行扫描动作，具体实现由ClassPathBeanDefinitionScanner的doScan方法和ClassPathMapperScanner的内部方法共同完成。

       ClassPathMapperScanner#doScan方法首先调用父类方法，接着配置文件并构建对应的BeanDefinitionHolder对象。对这些BeanDefinitions进行处理，对Bean进行加工，加入Mybatis特性。

       MapperFactoryBean作为创建Mapper的FactoryBean对象，其beanClass为MapperFactoryBean，初始化实例为MapperFactoryBean。在实例化时自动获取SqlSessionFactory或SqlSessionTemplate，用于创建具体的Mapper实例。

       MapperFactoryBean的checkDaoConfig方法实现Mapper与Mapper.xml文件的关联注册。MapperRegistry负责管理注册的Mapper，核心类图展示了其关键属性和方法。

       MapperRegistry#addMapper方法完成MapperProxy的注册，但实际的MapperProxy创建在getMapper方法中，根据接口获取MapperProxyFactory，调用newInstance创建MapperProxy对象。

       至此，Mybatis Mapper的初始化构造过程完成一半，即MapperScannerConfigurer通过包扫描，构建MapperProxy。剩余部分，即MapperProxy与*.Mapper.xml文件中SQL语句的关联流程，将在下一篇文章中详细说明。通过MapperProxy对象的创建，为后续SQL执行流程做准备。

       更多文章请关注：线报酱

为什么 MyBatis 源码中，没有我那种 if···else

       在 MyBatis 源码中，设计模式的巧妙使用是整个框架的精华，共有约种模式，包括创建型、结构型和行为型模式。

       创建型模式包括工厂模式、单例模式和建造者模式。工厂模式用于创建 SqlSessionFactory，单例模式确保 Configuration 的唯一实例，建造者模式将 XML 文件解析到对象中。

       结构型模式有适配器模式、代理模式、组合模式和装饰器模式。适配器模式使接口不兼容的对象可以协作，代理模式提供 DAO 接口的实现，组合模式用于 SQL 标签组合，装饰器模式允许在不修改结构的情况下增加行为。

       行为型模式包括模板模式、策略模式和迭代器模式。模板模式定义算法框架，策略模式允许算法的替换，迭代器模式遍历集合元素。

       总结，MyBatis 源码运用设计模式解决复杂问题，合理切割子问题，学习这些方案技术能提高对设计和实现的理解，扩展编码思维，积累经验，成为优秀工程师和架构师。

MyBatis源码之MyBatis中SQL语句执行过程

       MyBatis源码之MyBatis中SQL语句执行过程

       MyBatis编程时主要有两种方式执行SQL语句。

       方式一，通过SqlSession接口的selectList方法调用，进入DefaultSqlSession的实现，最终调用executor的query方法，使用MappedStatement封装SQL语句。

       方式二，调用SqlSession接口的getMapper(Class type)方法，通过工厂创建接口的代理对象，调用MapperProxy的invoke方法，进一步执行MappedStatement，调用sqlSession的方法。

       创建动态代理类会执行MapperProxy类中的invoke方法，判断方法是否是Object的方法，如果是直接调用，否则执行cachedInvoker()方法，获取缓存中的MapperMethodInvoker，如果没有则创建一个，内部封装了MethodHandler。当cacheInvoker返回了PalinMethodInvoker实例后，调用其invoke方法，执行execute()方法，调用sqlSession的方法。

       查询SQL执行流程：调用关系明确，主要步骤包括调用关系。

       增删改SQL执行流程：主要步骤清晰，最后执行的都是update方法，因为insert、update、delete都对数据库数据进行改变。执行流程为：

       具体的执行流程图如下所示。