MyBatis框架底層的執(zhí)行原理源碼解析

更新時(shí)間：2022年06月22日 15:14:04 作者：張起靈-小哥

這篇文章主要介紹了MyBatis框架底層的執(zhí)行原理源碼解析,本文通過圖文實(shí)例代碼相結(jié)合給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

1.前言

MyBatis框架大家肯定都用過的，廢話我就不再多說了，這篇文章就給大家分享一下有關(guān)MyBatis框架底層的執(zhí)行原理吧（Debug?。。。?/p>

2.案例項(xiàng)目源碼

我這里寫了一個(gè)簡(jiǎn)單的MyBatis相關(guān)的maven項(xiàng)目，把源碼分享給大家，一會(huì)的debug就以這個(gè)項(xiàng)目的測(cè)試代碼為主。

首先給出pom依賴。

<dependencies>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.5.1</version>
    </dependency>
 
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.9</version>
    </dependency>
 
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.20</version>
    </dependency>
 
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
 
  <build>
    <!--資源插件：處理src/main/java目錄中的xml-->
    <resources>
      <resource>
        <directory>src/main/java</directory><!--所在的目錄-->
        <includes><!--包括目錄下的.properties,.xml 文件都會(huì)掃描到-->
          <include>**/*.properties</include>
          <include>**/*.xml</include>
        </includes>
        <filtering>false</filtering>
      </resource>
    </resources>
  </build>

下面是實(shí)體類，以及數(shù)據(jù)庫(kù)中表結(jié)構(gòu)信息。

package com.szh.entity;
 
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
/**
 *
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student {
    private Integer id;
    private String name;
    private Integer age;
    private String email;
}

然后是對(duì)應(yīng)的mapper接口和xml映射文件。

package com.szh.dao;
import com.szh.entity.Student;
import java.util.List;
/**
 *
 */
public interface StudentDao {
 
    List<Student> selectAll();
}

<?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.szh.dao.StudentDao">
 
    <sql id="column">
        id, name, age, email
    </sql>
 
    <select id="selectAll" resultType="com.szh.entity.Student">
        select <include refid="column"></include>
        from student
    </select>
</mapper>

接下來是數(shù)據(jù)庫(kù)配置文件和mybatis核心配置文件。

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm?useUnicode=true&amp;characterEncoding=utf-8
jdbc.username=root
jdbc.password=12345678

<?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 resource="jdbc.properties" />
 
    <!--設(shè)置日志-->
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
 
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <!--配置數(shù)據(jù)源：創(chuàng)建Connection對(duì)象-->
            <dataSource type="POOLED">
                <!-- driver：驅(qū)動(dòng)內(nèi)容 -->
                <property name="driver" value="${jdbc.driver}"/>
                <!-- 連接數(shù)據(jù)庫(kù)的url -->
                <property name="url" value="${jdbc.url}"/>
                <!-- 用戶名 -->
                <property name="username" value="${jdbc.username}"/>
                <!-- 密碼 -->
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
 
    <mappers>
        <mapper class="com.szh.dao.StudentDao"/>
<!--        <package name="com.szh.dao"/>-->
    </mappers>
</configuration>

最后給出獲取mybatis中核心對(duì)象（SqlSeesion、SqlSeesionFactory這些對(duì)象）的工具類、以及測(cè)試代碼。

package com.szh.utils;
 
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
 
import java.io.IOException;
import java.io.InputStream;
 
/**
 *  工具類：創(chuàng)建SqlSession對(duì)象
 */
public class MyBatisUtil {
 
    private static SqlSessionFactory factory = null;
 
    static {
        String config = "mybatis.xml";
        try {
            InputStream inputStream = Resources.getResourceAsStream(config);
            factory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
 
    public static SqlSession getSqlSession() {
        SqlSession session = null;
        if (factory != null) {
            session = factory.openSession();
        }
        return session;
    }
}

package com.szh;
 
import com.szh.dao.StudentDao;
import com.szh.entity.Student;
import com.szh.utils.MyBatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
 
import java.util.List;
 
/**
 *
 */
public class MyTest {
 
    @Test
    public void testSelectStudents() {
        SqlSession session = MyBatisUtil.getSqlSession();
        StudentDao studentDao = session.getMapper(StudentDao.class);
        //com.sun.proxy.$Proxy == StudentDaoImpl
        System.out.println("studentDao === " + studentDao.getClass().getName());
        List<Student> studentList = studentDao.selectAll();
        studentList.forEach(stu-> System.out.println("stu = " + stu));
        session.close();
    }
}

下面我們測(cè)試一下，確保項(xiàng)目可以正常運(yùn)行，然后再進(jìn)行debug。

3.MyBatis源碼解析底層執(zhí)行原理

3.1 讀取mybatis配置文件創(chuàng)建出SqlSeesionFactory對(duì)象

由于我們這里要摸清MyBatis框架到底是如何執(zhí)行的？如何創(chuàng)建SqlSeesionFactory、SqlSession這些對(duì)象的？怎樣解析配置文件的？

所以debug的源頭就從下面這張圖開始。

然后我們按F7跟進(jìn)去，這里需要按兩次，因?yàn)橛袃蓚€(gè)方法需要確定跟哪個(gè)？我們進(jìn)到build方法中。

上圖也就是跟進(jìn)去的build方法，可以看到這個(gè)inputStream中讀取的就是我們當(dāng)前項(xiàng)目的 mybatis 核心配置文件了。

接下來再次F7跟進(jìn)這個(gè)build方法中。

此時(shí)在下圖可以看到，有一個(gè)XMLConfigBuilder這個(gè)類，從名字上大致可以猜到它就是來解析我們的 mybatis 核心配置文件（mybatis.xml）。

在 parseConfiguration 這個(gè)方法中，我們可以通過 Evaluate 計(jì)算一下這個(gè)root 的值是什么。

<configuration>
	<properties resource="jdbc.properties"/>
	
	<settings>
		<setting name="logImpl" value="STDOUT_LOGGING"/>
	</settings>
	
	<environments default="development">
		<environment id="development">
		<transactionManager type="JDBC"/>
		<dataSource type="POOLED">
			<property name="driver" value="${jdbc.driver}"/>
			<property name="url" value="${jdbc.url}"/>
			<property name="username" value="${jdbc.username}"/>
			<property name="password" value="${jdbc.password}"/>
		</dataSource>
		</environment>
	</environments>
	
	<mappers>
		<mapper class="com.szh.dao.StudentDao"/>
	</mappers>
</configuration>

?????? 我們就看到了熟悉的內(nèi)容了，properties標(biāo)簽、settings、mappers這些，這不就是我們mybatis核心配置文件中的內(nèi)容嗎？

所以下面我們就詳細(xì)看下 parseConfiguration 方法中如何進(jìn)行這些標(biāo)簽解析的。（由于這里的標(biāo)簽很多，而我在配置文件中只定義了圖中打斷點(diǎn)的這幾個(gè)，所以就依次來看這幾個(gè)吧，其他的都是大同小異了）

先來看第一個(gè) properties。

跟進(jìn)去之后，我們可以通過 Evaluate 計(jì)算一下這個(gè)context 的值是什么。

<properties resource="jdbc.properties"/>

顯然這里的context != null，走進(jìn)這個(gè)if判斷中，然后它會(huì)從 properties 標(biāo)簽中依次獲取相關(guān)屬性值（resource、url），那么我的配置文件中使用的是resource。

所以會(huì)走到下面那個(gè)if中。

按照上面的依次跟進(jìn)源碼，就可以看到，這里它調(diào)了defaults.putAll就是將resource對(duì)應(yīng)的屬性值（db.properties）中的內(nèi)容放到了這個(gè)map集合中。也就是上圖的內(nèi)容。

將db.properties中的四項(xiàng)內(nèi)容（driver、url、root、password）存入map之后，它將這個(gè)map集合（defaults）set到了configuration對(duì)象中（這個(gè)對(duì)象很重要?。。。竺嫖覀儠?huì)經(jīng)?？吹剿?，這里有個(gè)印象。

到此，我們配置文件中的 properties 屬性就被讀取解析完了。

按照上面那張圖，下面要讀取解析的就是 environments 了。（仍然F7跟進(jìn)去）

跟進(jìn)去之后，會(huì)看到傳入的參數(shù)是context，通過 Evaluate 計(jì)算得到，這個(gè)context不是別的，就是核心配置文件中environments標(biāo)簽的所有內(nèi)容。

<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/ssm?useUnicode=true&amp;characterEncoding=utf-8"/>
			<property name="username" value="root"/>
			<property name="password" value="12345678"/>
		</dataSource>
	</environment>
</environments>

上面的源碼首先去獲取了 environments 標(biāo)簽中的 default 屬性值，在配置文件中我寫的就是 development。

for循環(huán)第一次，會(huì)先讀取 environments 標(biāo)簽中的第一個(gè) environment 標(biāo)簽的id值，然后通過 isSpecifiedEnvironment 方法去判斷此id是否和 environments 標(biāo)簽中我們剛剛通過 default 獲取的那個(gè)值一致，如果一致，就可以確定當(dāng)前走的是哪一套 sql 數(shù)據(jù)源的配置。

那么這里肯定是 equals 為 true的，因?yàn)槲抑粚懥艘粋€(gè) environment 標(biāo)簽，如果有多個(gè)，for循環(huán)會(huì)依次遍歷直到找到與 default 屬性值匹配的id。

當(dāng)default與id匹配成功之后，就會(huì)走進(jìn)當(dāng)前的environment標(biāo)簽中，而我的配置文件在這個(gè)標(biāo)簽中首先定義了事務(wù)

<transactionManager type="JDBC"/>

所以下面也會(huì)走事務(wù)的相關(guān)源碼，可以看到這里正常的獲取到事務(wù)中的type屬性值是JDBC，最后會(huì)去創(chuàng)建JDBC相關(guān)的事務(wù)工廠類。

有關(guān)事務(wù)的配置走完之后，下面就走到了重要的 dataSource 了。

<!--配置數(shù)據(jù)源：創(chuàng)建Connection對(duì)象-->
            <dataSource type="POOLED">
                <!-- driver：驅(qū)動(dòng)內(nèi)容 -->
                <property name="driver" value="${jdbc.driver}"/>
                <!-- 連接數(shù)據(jù)庫(kù)的url -->
                <property name="url" value="${jdbc.url}"/>
                <!-- 用戶名 -->
                <property name="username" value="${jdbc.username}"/>
                <!-- 密碼 -->
                <property name="password" value="${jdbc.password}"/>
            </dataSource>

跟著下面截圖來看。

跟進(jìn)去之后，我們首先通過 Evaluate 計(jì)算一下 context 的值。這不就是我們的數(shù)據(jù)源信息嗎？所以它這里其實(shí)也是先獲取相關(guān)的type屬性值POOLED，然后再讀取這些數(shù)據(jù)源信息存入Properties這個(gè)map集合中，最后返回當(dāng)前的數(shù)據(jù)源工廠類對(duì)象。

<dataSource type="POOLED">
    <property name="driver" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/ssm?useUnicode=true&amp;characterEncoding=utf-8"/>
    <property name="username" value="root"/>
    <property name="password" value="12345678"/>
</dataSource>

最后它這里是通過建造者模式將剛剛的事務(wù)、數(shù)據(jù)源這些信息設(shè)置到了當(dāng)前的Environment對(duì)象中，然后又調(diào)用了 configuration 對(duì)象，將environment對(duì)象set到其中，這是我們又一次見到了 configuration 對(duì)象。

到此，我們配置文件中的 environments 屬性就被讀取解析完了。

按照上面那張圖，下面要讀取解析的就是 mappers 了。（仍然F7跟進(jìn)去）

跟進(jìn)來之后，我們首先通過 Evaluate 計(jì)算一下傳入?yún)?shù)parent的值是什么。

<mappers>
	<mapper class="com.szh.dao.StudentDao"/>
</mappers>

好的，通過結(jié)果大家肯定心里就有數(shù)了，此時(shí)我們讀取解析的就是核心配置文件中 mappers 的相關(guān)內(nèi)容。

因?yàn)閙appers標(biāo)簽中可以定義多個(gè)mapper標(biāo)簽、或者是 package標(biāo)簽，所以這里必然要通過 for 循環(huán)依次獲取 mappers 標(biāo)簽中的所有子標(biāo)簽。

走進(jìn)for循環(huán)之后，我們仔細(xì)看源碼就會(huì)發(fā)現(xiàn)，這些if、else是很有趣的，它們之后存在著一種優(yōu)先級(jí)。也就是說如果我們?cè)趍yabtis核心配置文件中的mappers標(biāo)簽中聲明了package、通過mapper標(biāo)簽定義 resource、url、class這些屬性的時(shí)候，它會(huì)先讀取加載誰呢？下面的源碼告訴你答案。

我們并未定義 package所以不會(huì)走第一個(gè)if，而是走到else，而我們?cè)谧訕?biāo)簽mapper中也沒有定義resource、url，所以會(huì)走到第三個(gè) else if 中。

在這，我們又看到了 configuration 對(duì)象，調(diào)用了 addMapper 將我們這個(gè)mapper接口注冊(cè)到了其中。

然后依次按F8單步執(zhí)行就行，走到下面這張圖。之后F7跟進(jìn)這個(gè)build方法中，在這個(gè)方法中可以看到傳入的參數(shù)就是剛剛我們一再?gòu)?qiáng)調(diào)的那個(gè) configuration 對(duì)象，然后通過 new DefaultSqlSessionFactory 的構(gòu)造器傳入這個(gè)configuration 對(duì)象，成功創(chuàng)建出 SqlSeesionFactory 對(duì)象。

3.2 通過SqlSeesionFactory對(duì)象進(jìn)而創(chuàng)建出SqlSession對(duì)象

跟進(jìn)去之后就可以看到，這里仍然是用了上面提到的那個(gè) configuration 對(duì)象獲取相關(guān) environment 配置信息、事務(wù)信息。

最后是 new DefaultSqlSession 通過 environment 配置信息、事務(wù)信息以及設(shè)置自動(dòng)提交為false創(chuàng)建出 SqlSession 對(duì)象。

依次F8單步執(zhí)行，回到最初打斷點(diǎn)的地方，執(zhí)行一步，可以看到當(dāng)前SqlSession對(duì)象中存在了兩個(gè)重要的對(duì)象：
configuration：讀取解析配置文件中相關(guān)的environment、mappers等各種信息。executor：執(zhí)行器，負(fù)責(zé)執(zhí)行處理mapper中的各種sql語(yǔ)句。

3.3 通過SqlSession的getMapper獲取到接口代理對(duì)象

所以這一系列的源碼追蹤到此，可以看到MyBatis的底層就是通過JDK動(dòng)態(tài)代理創(chuàng)建出了mapper接口的代理對(duì)象。

3.4 通過mapper接口的代理對(duì)象執(zhí)行CRUD

在下圖的斷點(diǎn)中，直接F7跟進(jìn)去。會(huì)跳轉(zhuǎn)到下面第二張圖中。

這里大家自己F8單步執(zhí)行，就能看到try中的if、else if中的內(nèi)容都沒有執(zhí)行，而是直接來到了下面的final、return這里。為什么會(huì)這樣，簡(jiǎn)單解釋一下：

這個(gè) MapperMethod 是執(zhí)行代理增強(qiáng)功能的類，而當(dāng)前我們位于 MapperProxy 這個(gè)類中，它實(shí)現(xiàn)了 InvocationHandler 這個(gè)接口，而該接口中（也就是上圖中）的invoke方法就是代理增強(qiáng)功能代碼所寫的位置了。

而第一個(gè)if是說，如果傳進(jìn)來的是Object對(duì)象，則直接執(zhí)行本對(duì)象自己的方法，并非執(zhí)行mapper對(duì)象的接口中的方法。就例如Object中原始的toString、hashCode方法一樣。

那么在上圖中，F(xiàn)7跟進(jìn)這個(gè)execute方法中。此時(shí)就走進(jìn)了 MapperMethod 這個(gè)類中。

首先看一下這個(gè)類中有兩個(gè)成員變量。解釋如下：??????

在上圖中F8單步執(zhí)行，就會(huì)走到 case SELECT 這里。這里我們對(duì) command 這個(gè)成員變量進(jìn)行計(jì)算，就可以看到它的 name和type 到底是什么了。

它的name正是我上面給大家的項(xiàng)目源碼中StudentDao.xml中的那個(gè)selectAll，而type就對(duì)應(yīng)著標(biāo)簽具體是CRUD的哪一個(gè)。

它這里還會(huì)通過method成員變量（對(duì)應(yīng)mapper接口中的方法），獲取到此方法的返回值是List、還是void決定走哪個(gè)判斷語(yǔ)句。

F8單步執(zhí)行一步，然后F7進(jìn)入下面這個(gè) executeForMany 方法中。因?yàn)橄惹耙呀?jīng)在switch-case中獲取到mapper接口中的selectAll的返回值是List，所以這里就使用sqlSession對(duì)象調(diào)用了selectList方法來查詢。

我們F7跟進(jìn)這個(gè)selectList方法中看看。

上圖中有多個(gè)mappedStatement是因?yàn)槲液髞碛衷诮涌谥刑砹藥讉€(gè)方法，大家只關(guān)注我上面給出的selectAll就行了。

跟進(jìn)來之后，就可以看到這里是通過configuration對(duì)象獲取到其中的mappedStatement來創(chuàng)建出MappedStatement對(duì)象，這個(gè)東西是什么呢？其實(shí)就是Executor執(zhí)行器真正要執(zhí)行的那些sql語(yǔ)句（xml中的那些sql標(biāo)簽）。

可以理解為 mapper接口中有多少個(gè)方法，configuration對(duì)象中的 mappedStatement 就有多少組。因?yàn)榈讓佣纪ㄟ^反射機(jī)制完成了mapper接口方法和xml映射文件標(biāo)簽的綁定?。?！