MyBatis源码分析工作原理

逃离我推掉我的手 2023-09-28 08:13 103阅读 0赞

## 一、MyBatis完整实例 ##

### 1.1 数据库准备 ###

在本示例中，需要针对一张用户表进行 CRUD 操作。其数据模型如下：

CREATE TABLE IF NOT EXISTS user (
        id      BIGINT(10) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT 'Id',
        name    VARCHAR(10)         NOT NULL DEFAULT '' COMMENT '用户名',
        age     INT(3)              NOT NULL DEFAULT 0 COMMENT '年龄',
        address VARCHAR(32)         NOT NULL DEFAULT '' COMMENT '地址',
        email   VARCHAR(32)         NOT NULL DEFAULT '' COMMENT '邮件',
        PRIMARY KEY (id)
    ) COMMENT = '用户表';
    
    INSERT INTO user (name, age, address, email)
    VALUES ('张三', 18, '北京', 'xxx@163.com');
    INSERT INTO user (name, age, address, email)
    VALUES ('李四', 19, '上海', 'xxx@163.com');

### 1.2 添加 MyBatis ###

如果使用 Maven 来构建项目，则需将下面的依赖代码置于 pom.xml 文件中：

<dependency>
      <groupId>org.Mybatis</groupId>
      <artifactId>Mybatis</artifactId>
      <version>x.x.x</version>
    </dependency>

### 1.3 MyBatis 配置 ###

XML 配置文件中包含了对 MyBatis 系统的核心设置，包括获取数据库连接实例的数据源（DataSource）以及决定事务作用域和控制方式的事务管理器（TransactionManager）。  
本示例中只是给出最简化的配置。【示例】MyBatis-config.xml 文件

<?xml version="1.0" encoding="utf-8"?>
    <!DOCTYPE configuration PUBLIC "-//Mybatis.org//DTD Config 3.0//EN"
      "http://Mybatis.org/dtd/Mybatis-3-config.dtd">
    <configuration>
      <environments default="development">
        <environment id="development">
          <transactionManager type="JDBC" />
          <dataSource type="POOLED">
            <property name="driver" value="com.mysql.cj.jdbc.Driver" />
            <property name="url"
                      value="jdbc:mysql://127.0.0.1:3306/spring_tutorial?serverTimezone=UTC" />
            <property name="username" value="root" />
            <property name="password" value="root" />
          </dataSource>
        </environment>
      </environments>
      <mappers>
        <mapper resource="Mybatis/mapper/UserMapper.xml" />
      </mappers>
    </configuration>

说明：上面的配置文件中仅仅指定了数据源连接方式和User表的映射配置文件。

### 1.4 Mapper ###

#### 1.4.1 Mapper.xml ####

个人理解，Mapper.xml 文件可以看做是 MyBatis 的 JDBC SQL 模板。【示例】UserMapper.xml 文件.  
下面是一个通过 MyBatis Generator 自动生成的完整的 Mapper 文件。

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//Mybatis.org//DTD Mapper 3.0//EN" "http://Mybatis.org/dtd/Mybatis-3-mapper.dtd">
    <mapper namespace="io.github.dunwu.spring.orm.mapper.UserMapper">
      <resultMap id="BaseResultMap" type="io.github.dunwu.spring.orm.entity.User">
        <id column="id" jdbcType="BIGINT" property="id" />
        <result column="name" jdbcType="VARCHAR" property="name" />
        <result column="age" jdbcType="INTEGER" property="age" />
        <result column="address" jdbcType="VARCHAR" property="address" />
        <result column="email" jdbcType="VARCHAR" property="email" />
      </resultMap>
      <delete id="deleteByPrimaryKey" parameterType="java.lang.Long">
        delete from user
        where id = #{
        id,jdbcType=BIGINT}
      </delete>
      <insert id="insert" parameterType="io.github.dunwu.spring.orm.entity.User">
        insert into user (id, name, age,
          address, email)
        values (#{
        id,jdbcType=BIGINT}, #{
        name,jdbcType=VARCHAR}, #{
        age,jdbcType=INTEGER},
          #{
        address,jdbcType=VARCHAR}, #{
        email,jdbcType=VARCHAR})
      </insert>
      <update id="updateByPrimaryKey" parameterType="io.github.dunwu.spring.orm.entity.User">
        update user
        set name = #{
        name,jdbcType=VARCHAR},
          age = #{
        age,jdbcType=INTEGER},
          address = #{
        address,jdbcType=VARCHAR},
          email = #{
        email,jdbcType=VARCHAR}
        where id = #{
        id,jdbcType=BIGINT}
      </update>
      <select id="selectByPrimaryKey" parameterType="java.lang.Long" resultMap="BaseResultMap">
        select id, name, age, address, email
        from user
        where id = #{
        id,jdbcType=BIGINT}
      </select>
      <select id="selectAll" resultMap="BaseResultMap">
        select id, name, age, address, email
        from user
      </select>
    </mapper>

#### 1.4.2 Mapper.java ####

Mapper.java 文件是 Mapper.xml 对应的 Java 对象。【示例】UserMapper.java 文件

public interface UserMapper {
        
    
        int deleteByPrimaryKey(Long id);
    
        int insert(User record);
    
        User selectByPrimaryKey(Long id);
    
        List<User> selectAll();
    
        int updateByPrimaryKey(User record);
    
    }

对比 UserMapper.java 和 UserMapper.xml 文件，不难发现：UserMapper.java 中的方法和 UserMapper.xml 的 CRUD 语句元素存在一一对应关系。**在 MyBatis 中，正是通过方法的全限定名，将二者绑定在一起**。

#### 1.4.3 数据实体类 【示例】User.java 文件 ####

public class User {
        
        private Long id;
    
        private String name;
    
        private Integer age;
    
        private String address;
    
        private String email;
    
    }

parameterType 属性以及 的 type 属性都可能会绑定到数据实体。这样就可以把 JDBC 操作的输入输出和 JavaBean 结合起来，更加方便、易于理解。

### 1.5 测试程序 ###

【示例】MyBatisDemo.java 文件

public class MyBatisDemo {
        
    
        public static void main(String[] args) throws Exception {
        
            // 1. 加载 MyBatis 配置文件，创建 SqlSessionFactory
            // 注：在实际的应用中，SqlSessionFactory 应该是单例
            InputStream inputStream = Resources.getResourceAsStream("MyBatis/MyBatis-config.xml");
            SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
            SqlSessionFactory factory = builder.build(inputStream);
    
            // 2. 创建一个 SqlSession 实例，进行数据库操作
            SqlSession sqlSession = factory.openSession();
    
            // 3. Mapper 映射并执行
            Long params = 1L;
            List<User> list = sqlSession.selectList("io.github.dunwu.spring.orm.mapper.UserMapper.selectByPrimaryKey", params);
            for (User user : list) {
        
                System.out.println("user name: " + user.getName());
            }
            // 输出：user name: 张三
        }
    
    }

说明：  
1、**SqlSession 接口是 MyBatis API 核心中的核心，它代表 MyBatis 和数据库一次完整会话。**  
2、MyBatis 会解析配置，并根据配置创建 SqlSession 。  
3、然后，MyBatis 将 Mapper 映射为 SqlSession，然后传递参数，执行 SQL 语句并获取结果。

## 二、MyBatis 生命周期 ##

![在这里插入图片描述][2805cba5cc4446a4b0a6d9ca82f0305b.png]

### 2.1 SqlSessionFactoryBuilder ###

#### 2.1.1 SqlSessionFactoryBuilder 的职责 ####

**SqlSessionFactoryBuilder 负责创建 SqlSessionFactory 实例。**

SqlSessionFactoryBuilder 可以从 XML 配置文件（**核心配置文件**）或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。

Configuration类包含了对一个SqlSessionFactory实例可能关心的所有内容。  
![在这里插入图片描述][a2923271c9374d22b0e5351995271bed.png]  
**SqlSessionFactoryBuilder 应用了建造者设计模式，它有五个 build 方法，允许你通过不同的资源创建 SqlSessionFactory 实例。**

SqlSessionFactory build(InputStream inputStream)
    SqlSessionFactory build(InputStream inputStream, String environment)
    SqlSessionFactory build(InputStream inputStream, Properties properties)
    SqlSessionFactory build(InputStream inputStream, String env, Properties props)
    SqlSessionFactory build(Configuration config)

#### 2.1.2 SqlSessionFactoryBuilder 的生命周期 ####

SqlSessionFactoryBuilder 可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。

你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

### 2.2 SqlSessionFactory ###

#### SqlSessionFactory 职责 ####

**SqlSessionFactory负责创建SqlSession实例。**  
![在这里插入图片描述][c451f5c460024e3cb664d9a59e71af48.png]  
SqlSessionFactory 应用了工厂设计模式，它提供了一组方法，用于创建 SqlSession 实例。

SqlSession openSession()
    SqlSession openSession(boolean autoCommit)
    SqlSession openSession(Connection connection)
    SqlSession openSession(TransactionIsolationLevel level)
    SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
    SqlSession openSession(ExecutorType execType)
    SqlSession openSession(ExecutorType execType, boolean autoCommit)
    SqlSession openSession(ExecutorType execType, Connection connection)
    Configuration getConfiguration();

方法说明：  
默认的 openSession() 方法没有参数，它会创建具备如下特性的 SqlSession：  
1）事务作用域将会开启（也就是不自动提交）。

*  将由当前环境配置的 DataSource 实例中获取 Connection 对象。
 *  事务隔离级别将会使用驱动或数据源的默认设置。
 *  预处理语句不会被复用，也不会批量处理更新。

2）TransactionIsolationLevel 表示事务隔离级别，它对应着 JDBC 的五个事务隔离级别。

3）ExecutorType 枚举类型定义了三个值:

*  ExecutorType.SIMPLE：该类型的执行器没有特别的行为。它为每个语句的执行创建一个新的预处理语句。
 *  ExecutorType.REUSE：该类型的执行器会复用预处理语句。
 *  ExecutorType.BATCH：该类型的执行器会批量执行所有更新语句，如果 SELECT 在多个更新中间执行，将在必要时将多条更新语句分隔开来，以方便理解。

#### SqlSessionFactory 生命周期 ####

**SQLSessionFactory 应该以单例形式在应用的运行期间一直存在。**

### 2.3 SqlSession ###

#### 2.3.1 SqlSession职责 ####

MyBatis 的主要 Java 接口就是 SqlSession。它包含了所有执行语句，获取映射器和管理事务等方法。  
SqlSession类的方法可按照下图进行大致分类：![在这里插入图片描述][c8c89057b7c24cf6bf486f5ebe1de903.png]

#### 2.3.2 SqlSession生命周期 ####

SqlSession是由SqlSessionFactory实例创建的；而 SqlSessionFactory 是由 SqlSessionFactoryBuilder 创建的。

注意：**当MyBatis与Spring框架整合使用时，SqlSession将被依赖注入框架所创建，所以你不需要使用SqlSessionFactoryBuilder 或者 SqlSessionFactory。**

### 2.4 映射器 ###

#### 2.4.1 映射器职责 ####

映射器是一些由用户创建的、绑定 SQL 语句的接口。

SqlSession 中的 insert、update、delete 和 select 方法都很强大，但也有些繁琐。更通用的方式是使用映射器类来执行映射语句。一个映射器类就是一个仅需声明与 SqlSession 方法相匹配的方法的接口类。

MyBatis 会根据相应的接口声明的方法信息，**通过动态代理机制生成一个 Mapper 实例**；MyBatis 会根据这个方法的方法名和参数类型，确定 Statement id，然后和 SqlSession 进行映射，**底层还是通过 SqlSession 完成和数据库的交互**。

下面的示例展示了一些方法签名以及它们是如何映射到 SqlSession 上的。  
![在这里插入图片描述][c12789b42cbe419e8b0fa7dc626fa6ab.png]

#### 2.4.2 映射器生命周期 ####

映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲，任何映射器实例的最大作用域是和请求它们的 SqlSession 相同的。尽管如此，映射器实例的最佳作用域是方法作用域。也就是说，映射器实例应该在调用它们的方法中被请求，用过之后即可丢弃。

编程模式：

try (SqlSession session = sqlSessionFactory.openSession()) {
        
      BlogMapper mapper = session.getMapper(BlogMapper.class);
      // 你的应用逻辑代码
    }

**映射器注解**  
MyBatis 是一个 XML 驱动的框架。配置信息是基于 XML 的，而且映射语句也是定义在 XML 中的。MyBatis 3 以后，支持注解配置。注解配置基于配置 API；而配置 API 基于 XML 配置。

MyBatis 支持诸如 @Insert、@Update、@Delete、@Select、@Result 等注解。

## 三、MyBatis的架构 ##

从 MyBatis 代码实现的角度来看，MyBatis 的主要组件有以下几个：  
1）**SqlSession** \- 作为 MyBatis 工作的主要顶层 API，**表示和数据库交互的会话，完成必要数据库增删改查功能**。

2）**Executor** \- MyBatis 执行器，**是 MyBatis 调度的核心，负责 SQL 语句的生成和查询缓存的维护**。

3）StatementHandler - 封装了 JDBC Statement 操作，负责对 JDBC statement 的操作，如设置参数、将 Statement 结果集转换成 List 集合。

4）ParameterHandler - 负责对用户传递的参数转换成 JDBC Statement 所需要的参数。

5）ResultSetHandler - 负责将 JDBC 返回的 ResultSet 结果集对象转换成 List 类型的集合。

6）TypeHandler - 负责 java 数据类型和 jdbc 数据类型之间的映射和转换。

7）MappedStatement - MappedStatement 维护了一条 <select|update|delete|insert> 节点的封装。

8）SqlSource - 负责根据用户传递的 parameterObject，动态地生成 SQL 语句，将信息封装到 BoundSql 对象中，并返回。

9）BoundSql - 表示动态生成的 SQL 语句以及相应的参数信息。

10）Configuration - MyBatis 所有的配置信息都维持在 Configuration 对象之中。

这些组件的架构层次如下：

![在这里插入图片描述][3273027961344e948a98038fa3268a70.jpeg_pic_center]

### 3.1 配置层 ###

配置层决定了 MyBatis 的工作方式。  
MyBatis 提供了两种配置方式：

*  基于XML配置文件的方式
 *  基于Java API的方式

SqlSessionFactoryBuilder 会根据配置创建 SqlSessionFactory ；  
SqlSessionFactory 负责创建 SqlSession

### 3.2 接口层 ###

接口层负责和数据库交互的方式。MyBatis 和数据库的交互有两种方式：  
1）**使用 SqlSession**：SqlSession 封装了所有执行语句，获取映射器和管理事务的方法。

*  用户只需要传入 Statement Id （**dao层接口中的方法名称**）和查询参数给 SqlSession 对象，就可以很方便的和数据库进行交互。
 *  这种方式的缺点是不符合面向对象编程的范式。

2）**使用Mapper接口**：MyBatis 会根据相应的接口声明的方法信息，**通过动态代理机制生成一个 Mapper 实例**；MyBatis 会根据这个方法的方法名和参数类型，确定 Statement Id，然后和 SqlSession 进行映射，底层还是通过 SqlSession 完成和数据库的交互。

### 3.3 数据处理层 ###

数据处理层可以说是 MyBatis 的核心，从大的方面上讲，它要完成两个功能：  
1）**根据传参 Statement 和参数构建动态 SQL 语句**

*  动态语句生成可以说是MyBatis框架非常优雅的一个设计，**MyBatis通过传入的参数值，使用Ognl来动态地构造SQL语句，使得MyBatis有很强的灵活性和扩展性**。
 *  参数映射指的是对于java数据类型和jdbc数据类型之间的转换：这里有包括两个过程：查询阶段，我们要将 java 类型的数据，转换成 jdbc 类型的数据，通过 preparedStatement.setXXX() 来设值；另一个就是对 resultset 查询结果集的 jdbcType 数据转换成 java 数据类型。

2）**执行SQL语句以及处理响应结果集ResultSet**

*  动态 SQL 语句生成之后，MyBatis 将执行 SQL 语句，并将可能返回的结果集转换成 List 列表。
 *  MyBatis 在对结果集的处理中，支持结果集关系一对多和多对一的转换，并且有两种支持方式，一种为嵌套查询语句的查询，还有一种是嵌套结果集的查询。

### 框架支持层 ###

1、事务管理机制 - MyBatis 将事务抽象成了 Transaction 接口。MyBatis 的事务管理分为两种形式：

*  **使用 JDBC 的事务管理机制**：即利用 \*\*java.sql.Connection 对象完成对事务的提交（commit）、回滚（rollback）、关闭（close）\*\*等。
 *  MyBatis 自身不会去实现事务管理，而是让程序的容器如（JBOSS，Weblogic）来实现对事务的管理。

2、缓存机制 - MyBatis 采用两级缓存结构;

*  一级缓存是 Session 会话级别的缓存 - 一级缓存又被称之为**本地缓存**。一般而言，**一个 SqlSession 对象会使用一个 Executor 对象来完成会话操作，Executor 对象会维护一个 Cache 缓存，以提高查询性能，一级缓存的生命周期是Session会话级别的**。
 *  **二级缓存**是 Application 应用级别的缓存 - 用户配置了 “cacheEnabled=true”，才会开启二级缓存。  
    1、如果开启了二级缓存，SqlSession会先使用CachingExcutor对象来处理出现请求。  
    **CachingExecutor** 会在二级缓存中查看是否有匹配的数据，如果匹配，则直接返回缓存结果；如果缓存中没有，再交给真正的 **Executor** 对象来完成查询，之后 CachingExecutor 会将真正 Executor 返回的查询结果放置到缓存中，然后在返回给用户。  
    2、二级缓存的生命周期是Application应用级别的。  
    ![在这里插入图片描述][b0731fdd6a94413c87677a3abb30e6e5.png]

## 四、SqlSession 内部工作机制 ##

从前文，我们已经了解了，MyBatis 封装了对数据库的访问，**把对数据库的会话和事务控制放到了 SqlSession 对象中**。那么具体是如何工作的呢？接下来，我们通过源码解读来进行分析。  
![在这里插入图片描述][ac89b9b2e3074e77bae4c952d9e4c9b8.png]

### 4.1 SqlSession子组件 ###

SqlSession是MyBatis的顶层接口，它提供了所有执行语句，获取映射器和管理事务等方法。  
实际上，**SqlSession 是通过聚合多个子组件，让每个子组件负责各自功能的方式，实现了任务的下发。**

#### 4.1.1 Executor ####

Executor 即执行器，**它负责生成动态 SQL 以及管理缓存**。  
![在这里插入图片描述][237dfc763739454bb1e5be11a3dfbba4.png]

*  Executor即执行器接口
 *  **BaseExecutor**：是 Executor 的抽象类，它采用了模板方法设计模式，内置了一些共性方法，而将定制化方法留给子类去实现。
 *  **SimpleExecutor**：是最简单的执行器。它只会直接执行 SQL，不会做额外的事。
 *  **BatchExecutor**：是批处理执行器。它的作用是通过批处理来优化性能。值得注意的是，批量更新操作，由于内部有缓存机制，使用完后需要调用 flushStatements 来清除缓存。
 *  ReuseExecutor：是可重用的执行器。重用的对象是 Statement，也就是说，该执行器会缓存同一个 SQL 的 Statement，避免重复创建 Statement。其内部的实现是通过一个 HashMap 来维护 Statement 对象的。由于当前 Map 只在该 session 中有效，所以使用完后需要调用 flushStatements 来清除 Map。
 *  **CachingExecutor 是缓存执行器**。它只在启用二级缓存时才会用到。

#### 4.1.2 StatementHandler ####

**StatementHandler 对象负责设置 Statement 对象中的查询参数、处理 JDBC 返回的 resultSet，将 resultSet 加工为 List 集合返回**。

StatementHandler 的家族成员：  
![在这里插入图片描述][3ca9f5cec71d42e98e49a5134ad4a05b.png]

#### 4.1.3 ParameterHandler ####

**ParameterHandler 负责将传入的 Java 对象转换 JDBC 类型对象，并为 PreparedStatement 的动态 SQL 填充数值。**

ParameterHandler 只有一个具体实现类，即 DefaultParameterHandler。

#### 4.1.4 TypeHandler ####

**TypeHandler 负责将 Java 对象类型和 JDBC 类型进行相互转换。**

#### 4.1.5 ResultSetHandler ####

ResultSetHandler 负责两件事：

*  **处理 Statement 执行后产生的结果集，生成结果列表**。
 *  **处理存储过程执行后的输出参数**。  
    ResultSetHandler 只有一个具体实现类，即 DefaultResultSetHandler。

[2805cba5cc4446a4b0a6d9ca82f0305b.png]: https://img-blog.csdnimg.cn/2805cba5cc4446a4b0a6d9ca82f0305b.png
[a2923271c9374d22b0e5351995271bed.png]: https://img-blog.csdnimg.cn/a2923271c9374d22b0e5351995271bed.png
[c451f5c460024e3cb664d9a59e71af48.png]: https://img-blog.csdnimg.cn/c451f5c460024e3cb664d9a59e71af48.png
[c8c89057b7c24cf6bf486f5ebe1de903.png]: https://img-blog.csdnimg.cn/c8c89057b7c24cf6bf486f5ebe1de903.png
[c12789b42cbe419e8b0fa7dc626fa6ab.png]: https://img-blog.csdnimg.cn/c12789b42cbe419e8b0fa7dc626fa6ab.png
[3273027961344e948a98038fa3268a70.jpeg_pic_center]: https://img-blog.csdnimg.cn/3273027961344e948a98038fa3268a70.jpeg#pic_center
[b0731fdd6a94413c87677a3abb30e6e5.png]: https://img-blog.csdnimg.cn/b0731fdd6a94413c87677a3abb30e6e5.png
[ac89b9b2e3074e77bae4c952d9e4c9b8.png]: https://img-blog.csdnimg.cn/ac89b9b2e3074e77bae4c952d9e4c9b8.png
[237dfc763739454bb1e5be11a3dfbba4.png]: https://img-blog.csdnimg.cn/237dfc763739454bb1e5be11a3dfbba4.png
[3ca9f5cec71d42e98e49a5134ad4a05b.png]: https://img-blog.csdnimg.cn/3ca9f5cec71d42e98e49a5134ad4a05b.png