前言
MyBatis可能很多人都一直在用,但是MyBatis的SQL执行流程可能并不是所有人都清楚了,那么既然进来了,通读本文你将收获如下:
1、Mapper接口和映射文件是如何进行绑定的
2、MyBatis中SQL语句的执行流程
3、自定义MyBatis中的参数设置处理器typeHandler
4、自定义MyBatis中结果集处理器typeHandler
PS:本文基于MyBatis3.5.5版本源码
干货分享最近将个人学习笔记整理成册,使用PDF分享主要包含了Java基础,数据结构,jvm,多线程等等,由于篇幅有限,以下只展示小部分面试题,
需要的朋友可以点一点领取:戳这里即可领取。。。暗号:CSDN
概要
在MyBatis中,利用编程式进行数据查询,主要就是下面几行代码:
SqlSession session = sqlSessionFactory.openSession();
UserMapper userMapper = session.getMapper(UserMapper.class);
List<LwUser> userList = userMapper.listUserByUserName("孤狼1号");
第一行是获取一个SqlSession对象在上一篇文章分析过了,第二行就是获取UserMapper接口,第三行一行代码就实现了整个查询语句的流程,接下来我们就来仔细分析一下第二和第三步。
获取Mapper接口(getMapper)
第二步是通过SqlSession对象是获取一个Mapper接口,这个流程还是相对简单的,下面就是我们调用session.getMapper方法之后的运行时序图:
1、在调用getMapper之后,会去Configuration对象中获取Mapper对象,因为在项目启动的时候就会把Mapper接口加载并解析存储到Configuration对象
2、通过Configuration对象中的MapperRegistry对象属性,继续调用getMapper方法
3、根据type类型,从MapperRegistry对象中的knownMappers获取到当前类型对应的代理工厂类,然后通过代理工厂类生成对应Mapper的代理类
4、最终获取到我们接口对应的代理类MapperProxy对象
而MapperProxy可以看到实现了InvocationHandler,使用的就是JDK动态代理。
至此获取Mapper流程结束了,那么就有一个问题了MapperRegistry对象内的HashMap属性knownMappers中的数据是什么时候存进去的呢?
Mapper接口和映射文件是何时关联的
Mapper接口及其映射文件是在加载mybatis-config配置文件的时候存储进去的,下面就是时序图:
1、首先我们会手动调用SqlSessionFactoryBuilder方法中的build()方法:
2、然后会构造一个XMLConfigBuilder对象,并调用其parse方法:
3、然后会继续调用自己的parseConfiguration来解析配置文件,这里面就会分别去解析全局配置文件的顶级节点,其他的我们先不看,我们直接看最后解析mappers节点
4、继续调用自己的mapperElement来解析mappers文件(这个方法比较长,为了方便截图完整,所以把字体缩小了1号),可以看到,这里面分了四种方式来解析mappers节点的配置,对应了4种mapper配置方式,而其中红框内的两种方式是直接配置的xml映射文件,蓝框内的两种方式是解析直接配置Mapper接口的方式,从这里也可以说明,不论配置哪种方式,最终MyBatis都会将xml映射文件和Mapper接口进行关联。
5、我们先看第2种和第3中(直接配置xml映射文件的解析方式),会构建一个XMLMapperBuilder对象并调用其parse方法。
当然,这个还是会被解析的,后面执行查询的时候会再次通过不断遍历去全部解析完毕,不过有一点需要注意的是,互相引用这种是会导致解析失败报错的,所以在开发过程中我们应该避免循环依赖的产生。
6、解析完映射文件之后,调用自身方法bindMapperForNamespace,开始绑定Mapper接口和映射文件:
7、调用Configuration对象的addMapper
8、调用Configuration对象的属性MapperRegistry内的addMapper方法,这个方法就是正式将Mapper接口添加到knownMappers,所以上面getMapper可以直接获取:
到这里我们就完成了Mapper接口和xml映射文件的绑定
9、注意上面红框里面的代码,又调用了一次parse方法,这个parse方法主要是解析注解,比如下面的语句:
@Select(“select * from lw_user”)
List listAllUser();
所以这个方法里面会去解析@Select等注解,需要注意的是,parse方法里面会同时再解析一次xml映射文件,因为上面我们提到了mappers节点有4种配置方式,其中两种配置的是Mapper接口,而配置Mapper接口会直接先调用addMapper接口,并没有解析映射文件,所以进入注解解析方法parse之中会需要再尝试解析一次XML映射文件。
解析完成之后,还会对Mapper接口中的方法进行解析,并将每个方法的全限定类名作为key存入存入Configuration中的mappedStatements属性。
需要指出的是,这里存储的时候,同一个value会存储2次,一个全限定名作为key,另一个就是只用方法名(sql语句的id)来作为key:
所以最终mappedStatements会是下面的情况:
事实上如果我们通过接口的方式来编程的话,最后来getStatement的时候,都是根据全限定名来取的,所以即使有重名对我们也没有影响,而之所以要这么做的原因其实还是为了兼容早期版本的用法,那就是不通过接口,而是直接通过方法名的方式来进行查询:
这里如果shortName没有重复的话,是可以直接通过简写来查询的:
但是通过简写来查询一旦shortName重复了就会抛出以下异常:
这里的异常其实就是StrickMap的get方法抛出来的:
sql执行流程分析
上面我们讲到了,获取到的Mapper接口实际上被包装成为了代理对象,所以我们执行查询语句肯定是执行的代理对象方法,接下来我们就以Mapper接口的代理对象MapperProxy来分析一下查询流程。
整个sql执行流程可以分为两大步骤:
一、寻找sql
二、执行sql语句
寻找sql
首先还是来看一下寻找sql语句的时序图:
1、了解代理模式的应该都知道,调用被代理对象的方法之后实际上执行的就是代理对象的invoke方法
2、因为我们这里并没有调用Object类中的方法,所以肯定走的else。else中会继续调用MapperProxy内部类MapperMethodInvoker中的方法cachedInvoker,这里面会有一个判断,判断一下我们是不是default方法,因为Jdk1.8中接口中可以新增default方法,而default方法是并不是一个抽象方法,所以也需要特殊处理(刚开始会从缓存里面取,缓存相关知识我们这里先不讲,后面会单独写一篇来分析一下缓存))。
3、接下来,是构造一个MapperMethod对象,这个对象封装了Mapper接口中对应的方法信息以及对应的sql语句信息:
这里面就会把要执行的sql语句,请求参数,方法返回值全部解析封装成MapperMethod对象,然后后面就可以开始准备执行sql语句了
执行sql语句
还是先来看一下执行Sql语句的时序图:
1、我们继续上面的流程进入execute方法:
2、这里面会根据语句类型以及返回值类型来决定如何执行,本人这里返回的是一个集合,故而我们进入executeForMany方法:
3、这里面首先会将前面存好的参数进行一次转换,然后绕了这么一圈,回到了起点SqlSession对象,继续调用selectList方法:
接下来又讲流程委派给了Execute去执行query方法,最终又会去调用queryFromDatabase方法:
4、到这里之后,终于要进入正题了,一般带了这种do开头的方法就是真正做事的,Spring中很多地方也是采用的这种命名方式:
注意,前面我们的sql语句还是占位符的方式,并没有将参数设置进去,所以这里在return上面一行调用prepareStatement方法创建Statement对象的时候会去设置参数,替换占位符。参数如何设置我们先跳过,等把流程执行完了我们在单独分析参数映射和结果集映射。
5、继续进入PreparedStatementHandler对象的query方法,可以看到,这一步就是调用了jdbc操作对象PreparedStatement中的execute方法,最后一步就是转换结果集然后返回。
到这里,整个SQL语句执行流程分析就结束了,中途有一些参数的存储以及转换并没有深入进去,因为参数的转换并不是核心,只要清楚整个数据的流转流程,我们自己也可以有自己的实现方式,只要存起来最后我们能重新解析读出来就行。