MyBatis框架底層的執行原理源碼解析

Posted on by

1.前言

MyBatis框架大傢肯定都用過的，廢話我就不再多說瞭，這篇文章就給大傢分享一下有關MyBatis框架底層的執行原理吧（Debug！！！）

2.案例項目源碼

我這裡寫瞭一個簡單的MyBatis相關的maven項目，把源碼分享給大傢，一會的debug就以這個項目的測試代碼為主。

首先給出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 文件都會掃描到-->
          <include>**/*.properties</include>
          <include>**/*.xml</include>
        </includes>
        <filtering>false</filtering>
      </resource>
    </resources>
  </build>

下面是實體類，以及數據庫中表結構信息。

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;
}

然後是對應的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>

接下來是數據庫配置文件和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" />
 
    <!--設置日志-->
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
 
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <!--配置數據源：創建Connection對象-->
            <dataSource type="POOLED">
                <!-- driver：驅動內容 -->
                <property name="driver" value="${jdbc.driver}"/>
                <!-- 連接數據庫的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中核心對象（SqlSeesion、SqlSeesionFactory這些對象）的工具類、以及測試代碼。

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;
 
/**
 *  工具類：創建SqlSession對象
 */
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();
    }
}

下面我們測試一下，確保項目可以正常運行，然後再進行debug。

3.MyBatis源碼解析底層執行原理

3.1 讀取mybatis配置文件創建出SqlSeesionFactory對象

由於我們這裡要摸清MyBatis框架到底是如何執行的？如何創建SqlSeesionFactory、SqlSession這些對象的？怎樣解析配置文件的？

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

然後我們按F7跟進去，這裡需要按兩次，因為有兩個方法需要確定跟哪個？我們進到build方法中。 

上圖也就是跟進去的build方法，可以看到這個inputStream中讀取的就是我們當前項目的 mybatis 核心配置文件瞭。

接下來再次F7跟進這個build方法中。

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

在 parseConfiguration 這個方法中，我們可以通過 Evaluate 計算一下這個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>

👆👆👆  我們就看到瞭熟悉的內容瞭，properties標簽、settings、mappers這些，這不就是我們mybatis核心配置文件中的內容嗎？

所以下面我們就詳細看下 parseConfiguration 方法中如何進行這些標簽解析的。（由於這裡的標簽很多，而我在配置文件中隻定義瞭圖中打斷點的這幾個，所以就依次來看這幾個吧，其他的都是大同小異瞭）

先來看第一個 properties。

跟進去之後，我們可以通過 Evaluate 計算一下這個context 的值是什麼。

<properties resource="jdbc.properties"/>

顯然這裡的context != null，走進這個if判斷中，然後它會從 properties 標簽中依次獲取相關屬性值（resource、url），那麼我的配置文件中使用的是resource。

所以會走到下面那個if中。 

 

按照上面的依次跟進源碼，就可以看到，這裡它調瞭defaults.putAll就是將resource對應的屬性值（db.properties）中的內容放到瞭這個map集合中。也就是上圖的內容。 

將db.properties中的四項內容（driver、url、root、password）存入map之後，它將這個map集合（defaults）set到瞭configuration對象中（這個對象很重要！！！），後面我們會經常看到它，這裡有個印象。

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

按照上面那張圖，下面要讀取解析的就是 environments 瞭。（仍然F7跟進去）

跟進去之後，會看到傳入的參數是context，通過 Evaluate 計算得到，這個context不是別的，就是核心配置文件中environments標簽的所有內容。 

<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 標簽中的 default 屬性值，在配置文件中我寫的就是 development。

for循環第一次，會先讀取  environments 標簽中的第一個 environment 標簽的id值，然後通過 isSpecifiedEnvironment 方法去判斷此id是否和 environments 標簽中我們剛剛通過 default 獲取的那個值一致，如果一致，就可以確定當前走的是哪一套 sql 數據源的配置。

那麼這裡肯定是 equals 為 true的，因為我隻寫瞭一個 environment 標簽，如果有多個，for循環會依次遍歷直到找到與 default 屬性值匹配的id。

當default與id匹配成功之後，就會走進當前的environment標簽中，而我的配置文件在這個標簽中首先定義瞭事務

<transactionManager type="JDBC"/>

所以下面也會走事務的相關源碼，可以看到這裡正常的獲取到事務中的type屬性值是JDBC，最後會去創建JDBC相關的事務工廠類。

有關事務的配置走完之後，下面就走到瞭重要的 dataSource 瞭。

<!--配置數據源：創建Connection對象-->
            <dataSource type="POOLED">
                <!-- driver：驅動內容 -->
                <property name="driver" value="${jdbc.driver}"/>
                <!-- 連接數據庫的url -->
                <property name="url" value="${jdbc.url}"/>
                <!-- 用戶名 -->
                <property name="username" value="${jdbc.username}"/>
                <!-- 密碼 -->
                <property name="password" value="${jdbc.password}"/>
            </dataSource>

跟著下面截圖來看。

 

跟進去之後，我們首先通過 Evaluate 計算一下 context 的值。 這不就是我們的數據源信息嗎？所以它這裡其實也是先獲取相關的type屬性值POOLED，然後再讀取這些數據源信息存入Properties這個map集合中，最後返回當前的數據源工廠類對象。

<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對象中，然後又調用瞭 configuration 對象，將environment對象set到其中，這是我們又一次見到瞭 configuration 對象。

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

按照上面那張圖，下面要讀取解析的就是 mappers 瞭。（仍然F7跟進去）

跟進來之後，我們首先通過 Evaluate 計算一下傳入參數parent的值是什麼。 

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

好的，通過結果大傢肯定心裡就有數瞭，此時我們讀取解析的就是核心配置文件中 mappers 的相關內容。

因為mappers標簽中可以定義多個mapper標簽、或者是 package標簽，所以這裡必然要通過 for 循環依次獲取 mappers 標簽中的所有子標簽。

走進for循環之後，我們仔細看源碼就會發現，這些if、else是很有趣的，它們之後存在著一種優先級。也就是說如果我們在myabtis核心配置文件中的mappers標簽中聲明瞭package、通過mapper標簽定義 resource、url、class這些屬性的時候，它會先讀取加載誰呢？下面的源碼告訴你答案。 

我們並未定義 package所以不會走第一個if，而是走到else，而我們在子標簽mapper中也沒有定義resource、url，所以會走到第三個 else if 中。

在這，我們又看到瞭 configuration 對象，調用瞭 addMapper 將我們這個mapper接口註冊到瞭其中。 

然後依次按F8單步執行就行，走到下面這張圖。之後F7跟進這個build方法中，在這個方法中可以看到傳入的參數就是剛剛我們一再強調的那個 configuration 對象，然後通過 new DefaultSqlSessionFactory 的構造器傳入這個configuration 對象，成功創建出 SqlSeesionFactory 對象。

3.2 通過SqlSeesionFactory對象進而創建出SqlSession對象

跟進去之後就可以看到，這裡仍然是用瞭上面提到的那個 configuration 對象獲取相關 environment 配置信息、事務信息。

最後是 new DefaultSqlSession 通過 environment 配置信息、事務信息以及設置自動提交為false創建出 SqlSession 對象。 

依次F8單步執行，回到最初打斷點的地方，執行一步，可以看到當前SqlSession對象中存在瞭兩個重要的對象：

configuration：讀取解析配置文件中相關的environment、mappers等各種信息。executor：執行器，負責執行處理mapper中的各種sql語句。

3.3 通過SqlSession的getMapper獲取到接口代理對象

所以這一系列的源碼追蹤到此，可以看到MyBatis的底層就是通過JDK動態代理創建出瞭mapper接口的代理對象。 

3.4 通過mapper接口的代理對象執行CRUD

在下圖的斷點中，直接F7跟進去。會跳轉到下面第二張圖中。 

這裡大傢自己F8單步執行，就能看到try中的if、else if中的內容都沒有執行，而是直接來到瞭下面的final、return這裡。為什麼會這樣，簡單解釋一下：

這個 MapperMethod 是執行代理增強功能的類，而當前我們位於 MapperProxy 這個類中，它實現瞭 InvocationHandler 這個接口，而該接口中（也就是上圖中）的invoke方法就是代理增強功能代碼所寫的位置瞭。

而第一個if是說，如果傳進來的是Object對象，則直接執行本對象自己的方法，並非執行mapper對象的接口中的方法。就例如Object中原始的toString、hashCode方法一樣。

那麼在上圖中，F7跟進這個execute方法中。此時就走進瞭 MapperMethod 這個類中。

首先看一下這個類中有兩個成員變量。解釋如下：👇👇👇

在上圖中F8單步執行，就會走到 case SELECT 這裡。這裡我們對 command 這個成員變量進行計算，就可以看到它的 name和type 到底是什麼瞭。

它的name正是我上面給大傢的項目源碼中StudentDao.xml中的那個selectAll，而type就對應著標簽具體是CRUD的哪一個。

它這裡還會通過method成員變量（對應mapper接口中的方法），獲取到此方法的返回值是List、還是void決定走哪個判斷語句。

F8單步執行一步，然後F7進入下面這個 executeForMany 方法中。因為先前已經在switch-case中獲取到mapper接口中的selectAll的返回值是List，所以這裡就使用sqlSession對象調用瞭selectList方法來查詢。

我們F7跟進這個selectList方法中看看。

 

上圖中有多個mappedStatement是因為我後來又在接口中添瞭幾個方法，大傢隻關註我上面給出的selectAll就行瞭。

跟進來之後，就可以看到這裡是通過configuration對象獲取到其中的mappedStatement來創建出MappedStatement對象，這個東西是什麼呢？其實就是Executor執行器真正要執行的那些sql語句（xml中的那些sql標簽）。

可以理解為 mapper接口中有多少個方法，configuration對象中的 mappedStatement 就有多少組。因為底層都通過反射機制完成瞭mapper接口方法和xml映射文件標簽的綁定！！！

走到最後，我們Evaluate計算出result的內容，這不就是我們數據庫中的所有student信息嗎？（大傢對照我上面給出的源碼即可）。 

最終程序的運行結果：👇👇👇 和上面的result是一樣一樣的。😄😄😄

到此這篇關於MyBatis框架底層的執行原理源碼解析的文章就介紹到這瞭,更多相關MyBatis執行原理內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：