Mybatis中mapper相关注解解析类详解
上一篇文章分析发现解读mapper关键是两个类MapperAnnotationBuilder和XMLMapperBuilder,今天先来看MapperAnnotationBuilder。
基础介绍
根据MapperAnnotationBuilder和XMLMapperBuilder两个的名字大概也可以猜出来他们的作用,MapperAnnotationBuilder应该是来处理mapper注解的,而XMLMapperBuilder是来处理mapper.xml文件的。
接着上一篇通过扫描接口添加mapper的方法会创建MapperAnnotationBuilder并执行parse方法,具体源码如下图:
MapperAnnotationBuilder关键属性说明:
statementAnnotationTypes:静态属性,存有各种sql对于在mybatis的注解;
configuration:mybatis的全局配置;
assistant:可以当成一个工具类,用来生成MappedStatement(后面讲它的作用);
type:对于的接口类型;
初始化方法比较简单不多做介绍了,接下来看parse方法;
parse方法介绍
parse方法源码如下图:
处理必要的验证外,关键步骤有4步:
第一个关键步骤是loadXmlResource方法,右侧已经把方法贴出来是,就是通过接口类找到对应的xml文件,然后生成XMLMapperBuilder对象进行解析,这个后面再来分析;
第二个是关键步骤解析二级缓存,两个方法分别去解析接口上CacheNamespace、CacheNamespaceRef注解,解析出注解中的值后保存到assistant和configuration中,比较简单这里就不详细说了;
第三步是解析结果,如果方法上有Select,SelectProvider注解,但是没有ResultMap注解,则需要通过其他信息组装返回结果,parseResultMap方法源码如下图:
如果没有指定返回值组装过程,则是根据接口类、方法、参数拼接成一个唯一id,最后调用assistant的addResultMap方法,addResultMap方法会创建一个ResultMap保存到configuration的resultMaps中,具体的后面分析;
最后关键一步是parseStatement方法,这个方法是MapperAnnotationBuilder的关键方法,接下来详细解析下。
parseStatement方法
parseStatement方法比较长,这里分成两个部分,首先是第一部分的源码如下图:
第一部分代码主要是获取了方法上面Select、Update等代表一种sql的注解,在存在这些注解的情况下再继续处理。
首先是根据方法参数、语言驱动等信息生成SqlSource对象,SqlSource是XML文件或者注解方法中对应的sql语句的实现,比如把${}替换成?这种。
然后还获取了方法上的Options注解信息,Options注解可以配置一些主键,是否使用缓存等信息。
然后如果sql是insert或者update语句则可能需要设置主键,这里也可以通过注解指定。
接下来看下半部分代码,源码如下图;
后半部分也分成三个步骤,首先是通过Options注解中配置的信息进行缓存等数据的初始化,然后如果是查询类型语句通过ResultMap注解或者方法生成结果id。最后把所有的值放到调用assistant的addMappedStatement的方法。
addMappedStatement方法
addMappedStatement方法比较简单,主要是又有几个关键类,先看源码如下图:
方法还是比较简单主要是根据上一步获取的参数创建一个类MappedStatement.Builder,最后通过这个类生成MappedStatement并保存到了全局配置configuration中。
一个MappedStatement对应一个sql,它包含了我们在代码中对这个sql或者说一个mapper方法设置的所有信息,后面使用时能够方便的执行,MappedStatement在后面详解。
总结
通过分析发现MapperAnnotationBuilder只是一个工具人,它只是把接口和接口中方法的上的注解解析出来,然后传递给MapperBuilderAssistant,而MapperBuilderAssistant执行addMappedStatement方法把从注解上面获取到的所有信息都放到了MappedStatement的对象里面,最后把MappedStatement对象放到了全局配置configuration的mappedStatements集合属性中。
然后就是静待使用时从mappedStatements中获取使用了。
Java程序员日常学习笔记,如理解有误欢迎各位交流讨论!