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

2022-06-22 18:02:36

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>

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

目錄

1.前言

2.案例專案原始碼

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

3.1 讀取mybatis組態檔建立出SqlSeesionFactory物件

熱門文章