啃了一周tkmybatis源码,留篇文章记录下,阅读时间30分钟-1个小时
纯mybatis每个持久化操作都要写sql,会显得有些繁琐。现在市面上也有很多的插件,比如mybatis逆向工程,mybatisCodeHelperPro等,可以在xml文件中生成一些常用的sql和对应的mapper接口方法。也有一些mybatis的第三方工具框架,帮我们免去单表操作的sql编写,比如通用mapper,mybatis-plus。接下来我们来研究一下我个人常用的通用mapper的使用极其原理。
tkmybatis源码版本:
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.1.5</version>
</dependency>
目录
e、使用processBeanDefinitions对扫描出来的mapper的BeanDefinition进行一些修改
c、为每个方法对应的MappedStatement更新SqlSource
一、使用案例:
参考《tkmybatis-02-SpringBoot整合TkMybatis》
二、整体流程:
tkmybatis流程大概分为以下几步:
-
根据properties文件中配置的xml位置,为每个mapper接口生成一个MappedStatement对象(此时对象的SQLSource为不可执行的Provider)
-
根据ScanMapper接口, 将接口加入到Spring 容器中,创建对应的BeanDefinition,然后修改BeanDefinition中的Bean类型为MapperFactoryBean
-
Spring容器实例化MapperFactoryBean实例,在初始化方法中,获取第一步每个接口生成的MappedStatement对象,并将MappedStatement对象的SQLSource修改为可执行的SqlSource(Provider生成xml格式的SQL,根据该SQL利用languageDriver创建新的sqlSource)
-
将mapper的bean实例注入到需要依赖该实例的service中,此时会Spring容器调用MapperFactoryBean的getObject方法,该方法创建了一个mapper的代理类(使用jdk的动态代理方法),并注入到service里面去
-
执行SQL时,对mapper的SQL操作,都由mapper的代理类mapperProxy来实现,实现过程跟原生mybatis用sqlsession创建的代理类一样的,只是这里没有显示的使用sqlsession来创建代理类,而是放到了MapperFactoryBean的getObject里面,将生成的代理类注入给service
三、源码解析:
1、Mapper接口扫描:
a、接口扫描入口位置
入口@MapperScan

这个注解会@Import进来一个tk.mapper的扫描器(将MapperScannerRegistrar导入到到Spring容器中,并将其声明成一个bean,该类的功能是处理注解MapperScan,具体过程见后面)

MapperScannerRegistrar实现了spring的ImportBeanDefinitionRegistrar接口, 并实现了registerBeanDefinitions方法。【注:如下图Spring容器在初始化的时候,会先扫描基本注解如controller等,然后扫描第三方jar包中的组件,扫描完成后再找到实现了ImportBeanDefinitionRegistrar接口的Bean,并将当前的AnnotationMetadata和BeanDefinitionRegistry作为参数传入,通过该Bean扫描自定义注解的组件进来】

该bean在实例化的时候,会调用registerBeanDefinitions方法来扫描并导入mapper接口,接着来看下扫描过程。

b、创建扫描器并利用MapperScan参数初始化该扫描器
该步骤创建一个扫描器, 利用MapperScan参数初始化该扫描器,各参数意义后面说,默认为空也没关系。同时还会根据MapperScan参数确定扫描package的范围。

