MyBatis的SQL执行流程，逻辑超清晰，总结得也太全了吧！

时间  2021-04-08 标签 java sql 数据库 apache 编程 缓存 session mybatis app 框架

前言

MyBatis可能不少人都一直在用，可是MyBatis的SQL执行流程可能并非全部人都清楚了，那么既然进来了，通读本文你将收获以下：java

  • 一、Mapper接口和映射文件是如何进行绑定的sql

  • 二、MyBatis中SQL语句的执行流程数据库

  • 三、自定义MyBatis中的参数设置处理器typeHandlerapache

  • 四、自定义MyBatis中结果集处理器typeHandler编程

福利：MyBatis学习笔记与源码分析

PS：本文基于MyBatis3.5.5版本源码缓存

概要

在MyBatis中，利用编程式进行数据查询，主要就是下面几行代码：session

SqlSession session = sqlSessionFactory.openSession();UserMapper 
userMapper = session.getMapper(UserMapper.class);List<LwUser> user
List = userMapper.listUserByUserName("孤狼1号");复制代码

第一行是获取一个SqlSession对象在上一篇文章分析过了，第二行就是获取UserMapper接口，第三行一行代码就实现了整个查询语句的流程，接下来咱们就来仔细分析一下第二和第三步。mybatis

获取Mapper接口(getMapper)

第二步是经过SqlSession对象是获取一个Mapper接口，这个流程仍是相对简单的，下面就是咱们调用session.getMapper方法以后的运行时序图：app

图片

  • 一、在调用getMapper以后，会去Configuration对象中获取Mapper对象，由于在项目启动的时候就会把Mapper接口加载并解析存储到Configuration对象

图片

  • 二、经过Configuration对象中的MapperRegistry对象属性，继续调用getMapper方法

图片

  • 三、根据type类型，从MapperRegistry对象中的knownMappers获取到当前类型对应的代理工厂类，而后经过代理工厂类生成对应Mapper的代理类

图片

  • 四、最终获取到咱们接口对应的代理类MapperProxy对象

图片

而MapperProxy能够看到实现了InvocationHandler，使用的就是JDK动态代理。框架

图片

至此获取Mapper流程结束了，那么就有一个问题了MapperRegistry对象内的HashMap属性knownMappers中的数据是何时存进去的呢？

Mapper接口和映射文件是什么时候关联的

Mapper接口及其映射文件是在加载mybatis-config配置文件的时候存储进去的，下面就是时序图：

图片

  • 一、首先咱们会手动调用SqlSessionFactoryBuilder方法中的build()方法：

图片

  • 二、而后会构造一个XMLConfigBuilder对象，并调用其parse方法：

图片

  • 三、而后会继续调用本身的parseConfiguration来解析配置文件，这里面就会分别去解析全局配置文件的顶级节点，其余的咱们先不看，咱们直接看最后解析mappers节点

图片

  • 四、继续调用本身的mapperElement来解析mappers文件（这个方法比较长，为了方便截图完整，因此把字体缩小了1号），能够看到，这里面分了四种方式来解析mappers节点的配置，对应了4种mapper配置方式，而其中红框内的两种方式是直接配置的xml映射文件，蓝框内的两种方式是解析直接配置Mapper接口的方式，从这里也能够说明，不论配置哪一种方式，最终MyBatis都会将xml映射文件和Mapper接口进行关联。

图片

  • 五、咱们先看第2种和第3中（直接配置xml映射文件的解析方式），会构建一个XMLMapperBuilder对象并调用其parse方法。

图片

固然，这个仍是会被解析的，后面执行查询的时候会再次经过不断遍历去所有解析完毕，不过有一点须要注意的是，互相引用这种是会致使解析失败报错的，因此在开发过程当中咱们应该避免循环依赖的产生。

  • 六、解析完映射文件以后，调用自身方法bindMapperForNamespace，开始绑定Mapper接口和映射文件：

图片

  • 七、调用Configuration对象的addMapper

图片

  • 八、调用Configuration对象的属性MapperRegistry内的addMapper方法，这个方法就是正式将Mapper接口添加到knownMappers，因此上面getMapper能够直接获取：

图片

到这里咱们就完成了Mapper接口和xml映射文件的绑定

  • 九、注意上面红框里面的代码，又调用了一次parse方法，这个parse方法主要是解析注解，好比下面的语句：
@Select("select * from lw_user")    List<LwUser> listAllUser();复制代码

因此这个方法里面会去解析@Select等注解，须要注意的是，parse方法里面会同时再解析一次xml映射文件，由于上面咱们提到了mappers节点有4种配置方式，其中两种配置的是Mapper接口，而配置Mapper接口会直接先调用addMapper接口，并无解析映射文件，因此进入注解解析方法parse之中会须要再尝试解析一次XML映射文件。

图片

图片

解析完成以后，还会对Mapper接口中的方法进行解析，并将每一个方法的全限定类名做为key存入存入Configuration中的mappedStatements属性。

须要指出的是，这里存储的时候，同一个value会存储2次，一个全限定名做为key，另外一个就是只用方法名(sql语句的id)来做为key：

图片

因此最终mappedStatements会是下面的状况：

图片

事实上若是咱们经过接口的方式来编程的话，最后来getStatement的时候，都是根据全限定名来取的，因此即便有重名对咱们也没有影响，而之因此要这么作的缘由其实仍是为了兼容早期版本的用法，那就是不经过接口，而是直接经过方法名的方式来进行查询：

session.selectList("com.lonelyWolf.mybatis.mapper.UserMapper.listAllUser");复制代码

这里若是shortName没有重复的话，是能够直接经过简写来查询的：

session.selectList("listAllUser");复制代码

可是经过简写来查询一旦shortName重复了就会抛出如下异常：

图片

这里的异常其实就是StrickMap的get方法抛出来的：

图片

sql执行流程分析

上面咱们讲到了，获取到的Mapper接口实际上被包装成为了代理对象，因此咱们执行查询语句确定是执行的代理对象方法，接下来咱们就以Mapper接口的代理对象MapperProxy来分析一下查询流程。

整个sql执行流程能够分为两大步骤：

  • 1、寻找sql

  • 2、执行sql语句

寻找sql

首先仍是来看一下寻找sql语句的时序图：

图片

  • 一、了解代理模式的应该都知道，调用被代理对象的方法以后实际上执行的就是代理对象的invoke方法

图片

  • 二、由于咱们这里并无调用Object类中的方法，因此确定走的else。else中会继续调用MapperProxy内部类MapperMethodInvoker中的方法cachedInvoker，这里面会有一个判断，判断一下咱们是否是default方法，由于Jdk1.8中接口中能够新增default方法，而default方法是并非一个抽象方法，因此也须要特殊处理（刚开始会从缓存里面取，缓存相关知识咱们这里先不讲，后面会单独写一篇来分析一下缓存)）。

图片

  • 三、接下来，是构造一个MapperMethod对象,这个对象封装了Mapper接口中对应的方法信息以及对应的sql语句信息：

图片

这里面就会把要执行的sql语句，请求参数，方法返回值所有解析封装成MapperMethod对象，而后后面就能够开始准备执行sql语句了

执行sql语句

仍是先来看一下执行Sql语句的时序图：

图片

  • 一、咱们继续上面的流程进入execute方法：

图片

  • 二、这里面会根据语句类型以及返回值类型来决定如何执行，本人这里返回的是一个集合，故而咱们进入executeForMany方法：

图片

  • 三、这里面首先会将前面存好的参数进行一次转换，而后绕了这么一圈，回到了起点SqlSession对象，继续调用selectList方法：

图片

  • 三、接下来又讲流程委派给了Execute去执行query方法，最终又会去调用queryFromDatabase方法：

图片

  • 四、到这里以后，终于要进入正题了，通常带了这种do开头的方法就是真正作事的，Spring中不少地方也是采用的这种命名方式：

图片

注意，前面咱们的sql语句仍是占位符的方式，并无将参数设置进去，因此这里在return上面一行调用prepareStatement方法建立Statement对象的时候会去设置参数，替换占位符。参数如何设置咱们先跳过，等把流程执行完了咱们在单独分析参数映射和结果集映射。

  • 五、继续进入PreparedStatementHandler对象的query方法，能够看到，这一步就是调用了jdbc操做对象PreparedStatement中的execute方法，最后一步就是转换结果集而后返回。

图片

到这里，整个SQL语句执行流程分析就结束了，中途有一些参数的存储以及转换并无深刻进去，由于参数的转换并非核心，只要清楚整个数据的流转流程，咱们本身也能够有本身的实现方式，只要存起来最后咱们能从新解析读出来就行。

参数映射

如今咱们来看一下上面在执行查询以前参数是如何进行设置的，咱们先进入prepareStatement方法：

图片

咱们发现，最终是调用了StatementHandler中的parameterize进行参数设置，接下来这里为了节省篇幅，咱们不会一步步点进去，直接进入设置参数的方法：

图片

上面的BaseTypeHandler是一个抽象类，setNonNullParameter并无实现，都是交给子类去实现，而每个子类就是对应了数据库的一种类型。下图中就是默认的一个子类StringTypeHandler，里面没什么其余逻辑，就是设置参数。

图片

能够看到String里面调用了jdbc中的setString方法，而若是是int也会调用setInt方法。 看到这些子类若是你们以前阅读过我前面讲的MyBatis参数配置，应该就很明显能够知道，这些子类就是系统默认提供的一些typeHandler。而这些默认的typeHandler会默认被注册并和Java对象进行绑定：

图片

正是由于MyBatis中默认提供了经常使用数据类型的映射，因此咱们写Sql的时候才能够省略参数映射关系，能够直接采用下面的方式，系统能够根据咱们参数的类型，自动选择合适的typeHander进行映射：

select user_id,user_name from lw_user where user_name=#{userName}复制代码

上面这条语句实际上和下面这条是等价的：

select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR}复制代码

或者说咱们能够直接指定typeHandler：

select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR,typeHandler=org.apache.ibatis.type.IntegerTypeHandler}复制代码

这里由于咱们配置了typeHandler，因此会优先以配置的typeHandler为主不会再去读取默认的映射，若是类型不匹配就会直接报错了：

图片

看到这里不少人应该就知道了，若是咱们本身自定义一个typeHandler，而后就能够配置成咱们本身的自定义类。 因此接下来就让咱们看看如何自定义一个typeHandler

自定义typeHandler

自定义typeHandler须要实现BaseTypeHandler接口，BaseTypeHandler有4个方法，包括结果集映射，为了节省篇幅，代码没有写上来：

package com.lonelyWolf.mybatis.typeHandler;import org.apache.ibatis.type.BaseTypeHandler;import org.apache.ibatis.type.JdbcType;import java.sql.CallableStatement;import java.sql.PreparedStatement;import java.sql.ResultSet;import java.sql.SQLException;public class MyTypeHandler extends BaseTypeHandler<String> {    @Override    public void setNonNullParameter(PreparedStatement preparedStatement, int index, String param, JdbcType jdbcType) throws SQLException {        System.out.println("自定义typeHandler生效了");        preparedStatement.setString(index,param);    }复制代码

而后咱们改写一下上面的查询语句：

select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR,typeHandler=com.lonelyWolf.mybatis.typeHandler.MyTypeHandler}复制代码

而后执行，能够看到，自定义的typeHandler生效了：

图片

结果集映射

接下来让咱们看看结果集的映射，回到上面执行sql流程的最后一个方法：

resultSetHandler.handleResultSets(ps)复制代码

结果集映射里面的逻辑相对来讲仍是挺复杂的，由于要考虑到很是多的状况，这里咱们就不会去深究每个细节，直接进入到正式解析结果集的代码，下面的5个代码片断就是一个简单的可是完整的解析流程：

图片

图片

图片

图片

图片

从上面的代码片断咱们也能够看到，实际上解析结果集仍是很复杂的，就如咱们上一篇介绍的复杂查询同样，一个查询能够不断嵌套其余查询，还有延迟加载等等一些复杂的特性 的处理，因此逻辑分支是有不少，可是无论怎么处理，最后的核心仍是上面的一套流程，最终仍是会调用typeHandler来获取查询到的结果。

是的，你没猜错，这个就是上面咱们映射参数的typeHandler，由于typeHandler里面不仅是一个设置参数方法，还有获取结果集方法(上面设置参数的时候省略了)。

自定义typeHandler结果集

因此说咱们仍是用上面那个MyTypeHandler 例子来重写一下取值方法(省略了设置参数方法)：

package com.lonelyWolf.mybatis.typeHandler;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class MyTypeHandler extends BaseTypeHandler<String> {  
  /**     
* 设置参数     *
/    
@Override    public void setNonNullParameter
(PreparedStatement preparedStatement, int index, String param, JdbcType jdbcType) 
throws SQLException {      
  System.out.println("设置参数->自定义typeHandler生效了");        
preparedStatement.setString(index,param);    }  
  
/**     * 根据列名获取结果     */    
@Override    public String getNullableResult(ResultSet resultSet, String columnName)
 throws SQLException {        System.out.println("根据columnName获取结果->自定义typeHandler生效了");      

  return resultSet.getString(columnName);    }   
 /**     * 根据列的下标来获取结果     
*/    
@Override    public String getNullableResult(ResultSet resultSet, int columnIndex) 
throws SQLException {        System.out.println("根据columnIndex获取结果->自定义typeHandler生效了");  

      return resultSet.getString(columnIndex);    }    
/**     * 处理存储过程的结果集     */    

@Override    public String getNullableResult(CallableStatement callableStatement, 
int columnIndex) throws SQLException {       
 return callableStatement.getString(columnIndex);    }}复制代码

改写Mapper映射文件配置：

<resultMap id="MyUserResultMap" type="lwUser">        
<result column="user_id" property="userId" jdbcType="VARCHAR" 
typeHandler="com.lonelyWolf.mybatis.typeHandler.MyTypeHandler" />        
<result column="user_name" property="userName" jdbcType="VARCHAR" />    
</resultMap><select id="listUserByUserName" parameterType="String" resultMap="MyUserResultMap">        

select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR,typeHandler=com.lonelyWolf.mybatis.
typeHandler.MyTypeHandler}    
</select>复制代码

执行以后输出以下：

由于咱们属性上面只配置了一个属性，因此只输出了一次。

工做流程图

上面介绍了代码的流转，可能绕来绕去有点晕，因此咱们来画一个主要的对象之间流程图来更加清晰的展现一下MyBatis主要工做流程：

图片

从上面的工做流程图上咱们能够看到，SqlSession下面还有4大对象，这4大对象也很重要，后面学习拦截器的时候就是针对这4大对象进行的拦截，关于这4大对象的具体详情，咱们下一篇文章再展开分析。

总结

本文主要分析了MyBatis的SQL执行流程。在分析流程的过程当中，咱们也举例论证了如何自定义typeHandler来实现自定义的参数映射和结果集映射，不过MyBatis中提供的默认映射其实能够知足大部分的需求，若是咱们对某些属性须要特殊处理，那么就能够采用自定义的typeHandle来实现，相信若是本文若是读懂了，如下几点你们应该至少会有一个清晰的认识：

  • 一、Mapper接口和映射文件是如何进行绑定的

  • 二、MyBatis中SQL语句的执行流程

  • 三、自定义MyBatis中的参数设置处理器typeHandler

  • 四、自定义MyBatis中结果集处理器typeHandler

固然，其中不少细节并无提到，而看源码咱们也并不须要追求每一行代码都能看懂，就好比咱们一个稍微复杂一点的业务系统，即便咱们是项目开发者若是某一个模块不是本人负责的，恐怕也很难搞清楚每一行代码的含义。因此对于MyBatis及其余框架的源码中也是同样，首先应该从大局入手，掌握总体流程和设计思想，而后若是对某些实现细节感兴趣，再深刻进行了解。

联系我们 沪ICP备2021010478号-7