我对 MyBatis 原理上瘾了

向右看齐 2021-09-07 06:09 241阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

--------------------

MyBatis可能很多人都一直在用，但是 MyBatis 的 SQL 执行流程可能并不是所有人都清楚了，那么既然进来了，通读本文你将收获如下，保证看完就上瘾，妙啊：

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

2、MyBatis中SQL语句的执行流程

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

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

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

# **00** #

# **概要** #

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

SqlSession session = sqlSessionFactory.openSession();
    UserMapper userMapper = session.getMapper(UserMapper.class);
    List<LwUser> userList = userMapper.listUserByUserName("孤狼1号");

第一行是获取一个SqlSession对象在上一篇文章分析过了，想要详细了解的可以点击这里，第二行就是获取UserMapper接口，第三行一行代码就实现了整个查询语句的流程，接下来我们就来仔细分析一下第二和第三步。

我把 MyBatis 相关的文章整理成了 PDF，关注微信公众号 Java后端，回复「666」下载即可。

# **01** #

# **获取Mapper接口(getMapper)** #

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

![format_png][]

1、在调用getMapper之后，会去Configuration对象中获取Mapper对象，因为在项目启动的时候就会把Mapper接口加载并解析存储到Configuration对象

![format_png 1][]

## **02** ##

## **Mapper接口和映射文件是何时关联的** ##

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

![format_png 2][]

@Select("select * from lw_user")
        List<LwUser> listAllUser();

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

![format_png 3][]

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

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

![format_png 4][]

所以最终mappedStatements会是下面的情况：

![format_png 5][]

事实上如果我们通过接口的方式来编程的话，最后来getStatement的时候，都是根据全限定名来取的，所以即使有重名对我们也没有影响，而之所以要这么做的原因其实还是为了兼容早期版本的用法，那就是不通过接口，而是直接通过方法名的方式来进行查询：

session.selectList("com.lonelyWolf.mybatis.mapper.UserMapper.listAllUser");

这里如果shortName没有重复的话，是可以直接通过简写来查询的：

session.selectList("listAllUser");

但是通过简写来查询一旦shortName重复了就会抛出以下异常：

![format_png 6][]

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

![format_png 7][]

# **03** #

# **sql执行流程分析** #

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

整个sql执行流程可以分为两大步骤：

一、寻找sql

二、执行sql语句

## **寻找sql** ##

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

![format_png 8][]

**执行sql语句**

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

![format_png 9][]

1. 我们继续上面的流程进入execute方法：

![format_png 10][]

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

![format_png 11][]

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

![format_png 12][]

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

![format_png 13][]

5. 到这里之后，终于要进入正题了，一般带了这种do开头的方法就是真正做事的，Spring中很多地方也是采用的这种命名方式：

![format_png 14][]

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

6. 继续进入PreparedStatementHandler对象的query方法，可以看到，这一步就是调用了jdbc操作对象PreparedStatement中的execute方法，最后一步就是转换结果集然后返回。

![format_png 15][]

到这里，整个SQL语句执行流程分析就结束了，中途有一些参数的存储以及转换并没有深入进去，因为参数的转换并不是核心，只要清楚整个数据的流转流程，我们自己也可以有自己的实现方式，只要存起来最后我们能重新解析读出来就行。

**04**

**参数映射**

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

![format_png 16][]

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

![format_png 17][]

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

![format_png 18][]

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

![format_png 19][]

正是因为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为主**不会再去读取默认的映射，如果类型不匹配就会直接报错了：

![format_png 20][]

看到这里很多人应该就知道了，如果我们自己自定义一个typeHandler，然后就可以配置成我们自己的自定义类。

所以接下来就让我们看看如何自定义一个typeHandler

## **自定义typeHandler** ##

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

然后我们改写一下上面的查询语句：

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

然后执行，可以看到，自定义的typeHandler生效了：

![format_png 21][]

**05**

**结果映射集**

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

resultSetHandler.handleResultSets(ps)

结果集映射里面的逻辑相对来说还是挺复杂的，因为要考虑到非常多的情况，这里我们就不会去深究每一个细节，直接进入到正式解析结果集的代码，下面的5个代码片段就是一个简单的但是完整的解析流程：

![format_png 22][]

![format_png 23][]

![format_png 24][]

![format_png 25][]

![format_png 26][]

从上面的代码片段我们也可以看到，实际上解析结果集还是很复杂的，就如我们上一篇介绍的复杂查询一样，一个查询可以不断嵌套其他查询，还有延迟加载等等一些复杂的特性的处理，所以逻辑分支是有很多，但是不管怎么处理，最后的核心还是上面的一套流程，最终还是会调用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>

执行之后输出如下：

![format_png 27][]

因为我们属性上面只配置了一个属性，所以只输出了一次。

# **06** #

# **工作流程图** #

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

![format_png 28][]

从上面的工作流程图上我们可以看到，SqlSession下面还有4大对象，这4大对象也很重要，后面学习拦截器的时候就是针对这4大对象进行的拦截，关于这4大对象的具体详情，我们后面展开分析。

PS 我把 MyBatis 相关的文章整理成了 PDF，关注微信公众号 Java后端，回复「666」下载即可。

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

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

2、MyBatis中SQL语句的执行流程

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

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

当然，其中很多细节并没有提到，而看源码我们也并不需要追求每一行代码都能看懂，就比如我们一个稍微复杂一点的业务系统，即使我们是项目开发者如果某一个模块不是本人负责的，恐怕也很难搞清楚每一行代码的含义。所以对于MyBatis及其他框架的源码中也是一样，首先应该从大局入手，掌握整体流程和设计思想，然后如果对某些实现细节感兴趣，再深入进行了解。

Java后端交流群已成立
    公众号运营至今，离不开小伙伴们的支持。为了给小伙伴们提供一个互相交流的平台，特地开通了官方交流群。扫描下方二维码备注 进群 或者关注公众号 Java后端 后获取进群通道。

推荐阅读 
    1. GitHub 上有哪些好玩的项目
    2. 通过 Docker 部署 Redis 集群
    3. 搞定 Linux 这一篇就他妈够了！
    4. 连夜撸了一个简易聊天室
    5. 推荐一款 Java 对象映射神器

[Java]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da17bf97a286df119047a25b7de51621fe542816673bb4aa3ebd8ab97b09a86ed7db2e2ee&idx=3&mid=2247489272&scene=21&sn=ce74938072fc73a808d83ccb474db46d#wechat_redirect
[format_png]: /images/20210730/9b01cafd5e014934a603980fd022e531.png
[format_png 1]: /images/20210730/de6252e98d3c465885ef717c47fc4014.png
[format_png 2]: /images/20210730/885453f8a4924663bd4520114a4c9281.png
[format_png 3]: /images/20210730/1c583d51c72747fb8be7c10b7fa7a2bc.png
[format_png 4]: /images/20210730/30411ec27c0b421abb1bdbf78f7d7e4c.png
[format_png 5]: /images/20210730/49a0fcaf62dc4a32a1b4fb9af15aa981.png
[format_png 6]: /images/20210730/b151b17bc37446c18955e32897c0ab99.png
[format_png 7]: /images/20210730/997b7eddfd3c4867a51206217fff2830.png
[format_png 8]: /images/20210730/31929d7fb3054aee8a4733d6827b0004.png
[format_png 9]: /images/20210730/7d4402e123b849ecb7b0278868946d48.png
[format_png 10]: /images/20210730/207ffcd82b25483e9e47d9cbd1180bc8.png
[format_png 11]: /images/20210730/4caaa5cf7bb84f3b94577e2af1de4a39.png
[format_png 12]: /images/20210730/1c13059c1fa8419eabc018ca5397230d.png
[format_png 13]: /images/20210730/440c3549a9784399b87e34dd813c4a26.png
[format_png 14]: /images/20210730/f0a084fe96214f0cb32abd85f60f1295.png
[format_png 15]: /images/20210730/ca9a16ff76f049b7862f0c80eae90546.png
[format_png 16]: /images/20210730/648cf9d750a54e1ead613cd9b1f52682.png
[format_png 17]: /images/20210730/fd7c1efb2df249338db82a8fd90dd167.png
[format_png 18]: /images/20210730/8845971eb8e84d9d836e827a338fc95b.png
[format_png 19]: /images/20210730/a785a5759b8a4993b974f1c5d451ed3b.png
[format_png 20]: /images/20210730/4c482bd7efc940758159c410f9410060.png
[format_png 21]: /images/20210730/98e5a240da52469a9f701d8adee11def.png
[format_png 22]: /images/20210730/5997b4f4c45e4a93b4ad961bb800261f.png
[format_png 23]: /images/20210730/48e4fc055aa3496483b24b14954d7c4a.png
[format_png 24]: /images/20210730/1d77531c008342b0b19f3a98cd98b198.png
[format_png 25]: /images/20210730/8b332abc44f14250b4bc8118848514fd.png
[format_png 26]: /images/20210730/9cf8272ca0c246998255ff22063bfdac.png
[format_png 27]: /images/20210730/84a9f586bc5f4215b3c4581547b6e654.png
[format_png 28]: /images/20210730/2c062e9c0cf24a9f8089b7b9e002012d.png