MyBatis原理解析

2019-05-10 本文已影响0人 jesse_cheng

可以效仿Spring IoC的流程去理解mybatis流程，其流程也可以认为包含两大块：配置对象初始化；注入。
（1）配置对象初始化：同样可以效仿Spring IoC，将流程细分为“定位”、“加载”和“注册”。“定位”阶段，针对“XML配置文件”配置方式，就是寻找配置文件的过程，这里，一般就是在classpath下定位到 mybatis配置文件；“加载”阶段，针对已定位到的xml文件，结合mybatis在xml形式中的预发规则，去解析各类信息，比如：数据源、映射器、属性信息、类型命名等等；“注册”阶段，将上一阶段的解析好的信息注册进configuration配置对象中。（实际过程中，“加载”、“注册”是在一起的，边解析边设置configuration对象）
（2）注入：这里的注入区别于Spring IoC的注入（实例化对象），这里是结合configuration中的配置信息，生成接口的代理对象，代理对象负责完成“数据库交互”、“返参格式化”等。

我以“基于XML配置文件”的方式，详细介绍MyBatis的工作原理，先简要说下这种方式下的主要工作流程，可细分为6部分：
（1）读取核心配置文件并返回InputStream流对象（初始化 — 定位）；
（2）根据InputStream流对象解析出Configuration对象，然后创建SqlSessionFactory工厂对象（初始化 — 加载、注册）；
（3）根据一系列属性从SqlSessionFactory工厂中创建SqlSession（注入）；
（4）从SqlSession中调用Executor执行数据库操作并生成具体SQL指令；
（5）对执行结果进行二次封装；
（6）事务提交。

备注：
对于MyBatis的初始化可以有两种方式：

基于XML配置文件：将MyBatis的所有配置信息放在XML文件中，MyBatis通过加载XML配置文件，将配置文信息组装成内部的Configuration对象。

基于Java API：这种方式不使用XML配置文件，需要MyBatis使用者在Java代码中，手动创建Configuration对象，然后将配置参数set 进入Configuration对象中。

1 配置对象初始化

1.1 初始化概况

任何框架的初始化，无非就是加载运行时所需要的配置信息，mybatis也不例外，其配置信息主要包括以下信息（可见源码中 org.apache.ibatis.builder.xml.XMLConfigBuilder.parseConfiguration）：
properties(属性)，typeAliases(类型命名)，plugins(插件)，objectFactory(对象工厂)，objectWrapperFactory()，settings(设置)，environments(环境)，environment(环境变量)，dataSource(数据源)，typeHandlers(类型处理器)，transactionManager(事务管理器)，mappers(映射器)。

在mybatis底层结构中，会将这些配置信息存储在configuration对象中，因此，也可以认为，mybatis的初始化过程，也是创建configuration配置对象的过程。

1.2 初始化详细流程

1.2.1 读取核心配置文件并返回InputStream流对象

（1）配置文件 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>
    <!-- 指定properties配置文件，配置的是数据库相关 -->
    <properties resource="dbConfig.properties"></properties>

    <!-- 指定Mybatis使用log4j -->
    <settings>
        <setting name="logImpl" value="LOG4J"/>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>

    <typeAliases>
        <package name="com.jesse.learn.mybatis"/>
    </typeAliases>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!-- 上面指定了数据库配置文件，配置文件里面也是对应的这四个属性 -->
                <property name="driver" value="${datasource.driver}"/>
                <property name="url" value="${datasource.url}"/>
                <property name="username" value="${datasource.username}"/>
                <property name="password" value="${datasource.password}"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 映射文件，mybatis精髓 -->
    <mappers>
        <mapper class="com.jesse.learn.mybatis.demo.KolDao"/>
    </mappers>

</configuration>

（2）mapper文件 kolDao.xml

<?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.jesse.learn.mybatis.demo.KolDao">
    <sql id="tableName">
        demo_kol
    </sql>

    <sql id="fields">
      id,
      name,
      gender,
      created_at,
      updated_at
    </sql>

    <sql id="setupx">
        <set>
            <if test="name != null">
                name = #{name},
            </if>
            <if test="gender != null">
                gender = #{gender},
            </if>
        </set>
    </sql>

    <insert id="insert" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO
        <include refid="tableName"></include>
        <include refid="setupx"></include>
    </insert>

    <select id="getKolById" resultType="KolDO">
        SELECT
        <include refid="fields"/>
        FROM
        <include refid="tableName"/>
        WHERE id = #{id}
    </select>
</mapper>

（3）main方法

public class KolDaoTest {

    @Test
    public void findUserById() {
        // 参考：https://www.cnblogs.com/dongying/p/4031382.html
        SqlSession sqlSession = getSessionFactory().openSession();
        KolDao kolDao = sqlSession.getMapper(KolDao.class);
        KolDO kolDO = kolDao.getKolById(1L);
        Assert.assertNotNull("没找到数据", kolDO.getName());
    }

    // Mybatis 通过SqlSessionFactory获取SqlSession, 然后才能通过SqlSession与数据库进行交互
    private static SqlSessionFactory getSessionFactory() {

        SqlSessionFactory sessionFactory = null;
        String resource = "mybatis-config.xml";

        try {
            // Resources: MyBatis提供的加载资源文件的工具类
            Reader reader = Resources.getResourceAsReader(resource);
            sessionFactory = new SqlSessionFactoryBuilder().build(reader);
        } catch (IOException e) {
            e.printStackTrace();
        }

        return sessionFactory;
    }
}