MyBatis 的工作原理解析

前言

本文记录 Mybatis 的工作原理，做到知识梳理总结的作用。

一、mybatis工作原理

Mybatis 的总体工作原理流程图如下图所示

1.1 流程图

1.2 步骤解析

Mybatis 框架在工作时大致经过8个步骤，如下：

1. 读取 Mybatis 配置文件 mybatis-config.xml，该配置文件作为 Mybatis 的全局配置文件，配置了 Mybatis 的运行环境和数据库连接等信息。

2. 加载映射文件 mapper.xml，该文件中配置了操作数据库的 sql 语句，需要在mybatis-config.xml中加载才能执行。mybatis-config.xml 可以加载多个配置文件，每个配置文件对应数据库中的一张表。

3. 通过 SqlSessionFactoryBuilder 对象的 build() 方法构建会话工厂，且 build() 方法参数为 mybatis-config.xml 配置文件的输入流，通过 Mybatis 的环境等配置信息构建会话工厂 SqlSessionFactory - 工厂设计模式。

//build方法源码：将mybatis-config.xml 配置文件输入流解析成xml配置对象
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);

4. 创建 SqlSession 对象，由会话工厂创建 SqlSession 对象，该对象中包含了执行 SQL 的所有方法。

5. Mybatis 的底层定义了一个 Executor 接口来操作数据库，它会根据 SqlSession 传递的参数动态的生成需要执行的 SQL 语句，同时负责查询缓存的维护。

6. 在 Executor 接口的方法中，包含一个 MappedStatement 类型的参数，该参数是对映射信息的封装，用于存储要映射的 SQL 语句的 id、参数等。Mapper.xml 文件中的一个SQL对应一个 MappedStatement 对象，SQL 的 id 即是 MappedStatement 的 id。

7. 输入映射参数，在执行方法时 MappedStatement 对象会对用户执行 SQL 语句的输入参数进行定义（可以定义为 Map、List 类型、基本类型和 POJO 类型），Executor 执行器会通过 MappedStatement 对象在执行 SQL 前，将输入的 java 对象映射到 SQL 语句中。这里对输入参数的映射过程就类似于 JDBC 编程中对 preparedStatement 对象设置参数的过程。

8. 输出结果映射，在数据库中执行完SQL语句后 MappedStatement 对象会对 SQL 执行输出的结果进行定义（可以定义为 Map、List 类型、基本类型、POJO类型），Executor 执行器会通过 MappedStatement 对象在执行 SQL 语句后，将输出结果映射到 java 对象中。这种将输出结果映射到 java 对象的过程就类似于 JDBC 编程中对结果的解析处理过程。

1.3 代码实现

mybatis 数据库的 user 表数据

Mybatis 的 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.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;useUnicode=false&amp;
                characterEncoding=utf8;serverTimezone=GMT%2B8"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!--每一个Mapper.xml都需要在mybatis核心配置文件中注册-->
    <mappers>
        <!--resource要用 /-->
        <mapper resource="com/kuang/dao/UserMapper.xml"/>
    </mappers>
</configuration>

MybatisUtils 获取 sqlSession 对象工具类

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;
    static{
        try {
            //访问mybatis 读取User数据
            //mybatis全局配置文件名定义
            String resource = "mybatis-config.xml";
            //读取这个resource表示的文件并将其转化为输入流
            InputStream inputStream = Resources.getResourceAsStream(resource);
            //
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    /**
     *既然有了SqlSessionFactory顾名思义,我们可以从其中获得SqlSession的实例了
     * Session完全包含了面向数据库执行sql命令的所有方法
     */
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

UserMapper 操作数据库的方法定义

public interface UserMapper{
    /**
     *查询全部用户
     */
    List<User> getUserList();

    /**
     *根据id查询用户 传递参数id
     */
    User getUserById(int id);
}    

UserMapper.xml 操作数据库的 SQL 语句

<?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="com.kuang.dao.UserMapper">
<!-- id就是UserMapper中的方法名  resultType sql语句的返回值类型  parameterType参数类型-->
    <select id="getUserList" resultType="com.kuang.pojo.User">
        select *from mybatis.user;
    </select>
    
    <select id="getUserById" parameterType="int" resultType="com.kuang.pojo.User">
        select *from mybatis.user where id = #{id};
    </select>
</mapper>    

获取所有数据，单元测试

@Test
public void test() {
    //获得SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    try{
        //方式一：获得getMapper
        UserMapper userDao = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userDao.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }
    } catch (Exception e) {
        e.printStackTrace();
    }finally{
        //关闭sql
        sqlSession.close();
    }
}

测试结果

根据 id 获取用户数据，单元测试

@Test
public void getUserById(){
    //获得SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();

    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    User user = mapper.getUserById(3);
    System.out.println(user);
    //关闭sql
    sqlSession.close();
}

测试结果