Java MyBatis是如何執行一條SQL語句的

Posted on by

背景

在前兩天的一次面試中，面試官問瞭一個和標題一樣的問題，由於一直認為MyBatis隻是一個ORM框架，所以並沒有對他有過深入的瞭解，於是被問到瞭，那麼這一篇文章來從源碼探究一下MyBatis是如何執行一條SQL語句的。

閱讀環境

源碼環境，github直接下載的main分支代碼，版本號為 3.5.11-SNAPSHOT

Ide Jetbrain Idea 2021.2.1 社區版
Maven 3.8.2
JDK 17

配置文件：

<?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.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://******/**"/>
        <property name="username" value="****"/>
        <property name="password" value="******"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="LogChartMapper.xml"/>
  </mappers>
</configuration>

測試主方法：

public class Main {
  public static void main(String[] args) throws IOException {
    InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
    SqlSessionFactory build = new SqlSessionFactoryBuilder().build(resourceAsStream);
    SqlSession sqlSession = build.openSession();
    LogChartMapper mapper = sqlSession.getMapper(LogChartMapper.class);
    List<LogChart> logCharts = mapper.selectList();
    System.out.println(JSONUtil.toJsonStr(logCharts));
  }
}

mapper

public interface LogChartMapper {
  @Select(value = "select * from log_chart")
  List<LogChart> selectList();
}

mapper.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="org.mybatis.test.mapper.LogChartMapper">
</mapper>

閱讀過程

加載XML的過程

從上方的測試主方法可以看到，比較重要的是 SqlSessionFactory，第一步需要看的就是他是被如何構建出來的，點擊build方法，跟進去。

Build方法追到最下面，構建瞭一個XMLConfigBuilder，那麼這個Parser方法，有必要進去看一下。

這段代碼比較簡短，可以看到兩個信息點。第一個返回的類型是Configuration類，調用瞭一個parseConfiguration方法，並且傳入的configuration的xml節點。
說明方法進入是對的，後續我們繼續跟一下 parseConfiguration方法

針對這個方法，看到幾個眼熟的東西。分別是解析 plugins、objectFactory、mappers 這些標簽的。其他的我們這裡不關心，我們主要看一下處理 Mappers 標簽的這個方法。

這裡通過遍歷我們寫的每個mapper標簽，會得到resource、url、mapperClass這三個變量。他們在配置時是互斥的。 這裡的三個if，也對應瞭每個不為空的情況。

我們的XML使用的是Resources屬性，可以回到上面翻XML，我們這裡看Resource標簽不為空的 if 判斷即可。

這裡註意看，Myabtis去讀取瞭Mapper指向的xml，然後new瞭一個XmlMapperBuilder，隨後調用瞭parse方法，這裡的邏輯和剛剛開頭的地方很相似。值得註意的是在創建XmlMapperBuilder的時候吧Configuration傳瞭進去，也就是說在parse中是會改變這個configuration裡面的東西的。到這裡接著往裡面跟代碼。

看名字有兩個比較重要的方法，ConfigurationElement、binMapperForNameScpace。
configurationElement 看這個方法的入參，大概率是對XML做一些處理，像ResultMap、sql、select這些標簽做處理，我這裡沒有用到就不說瞭，感興趣的可以自己閱讀一下。

後面主要看一下BindMapperForNameSpace方法。

創建Mapper

上面的代碼中，看到瞭AddMapper這個方法，傳入的值，是剛剛xml中配置的nameSpace，也就是Mapper類的完整類名，追進去看一下。

看到這裡，知道瞭一個知識點，為什麼Mapper類一定要是 Interface，如果不是interface，這個方法就進不來瞭。

註意看瞭，有一個細節，向knownMappers中，以這個class為鍵，放入瞭一個MapperProxyFactory。到達這裡，就可以得知。所有的Mapper方法，都是由代理類去調用的。

接下來往下，又看到一個相似的，parse方法，看他的類名 MapperAnnotationBuilder 是用來處理註解的，往裡追看一下。

這裡的圈出來的 IF 判斷，判斷方法上有Select 或者 SelectProvider註解，並且沒有ResultMap註解的。會去解析ResultMap，這裡大概率是根據返回值，去遍歷屬性這裡就跳過瞭，進入下一個方法。

parseStatement方法像是去解析方法瞭，代碼有點多，這裡就不粘貼瞭，感興趣可以自己看一下，知道這裡是去解析方法就可以瞭。

到這裡結束，最後返回瞭SqlSessionFactory類。

獲得一個Mapper

SqlSessionFactory build = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession sqlSession = build.openSession();
LogChartMapper mapper = sqlSession.getMapper(LogChartMapper.class);

knownMapper 這個對象很眼熟是不是，這個在上面有提到過，以Class為Key，value時MapperProxyFactory，所以這裡可以Get出來一個工廠，然後點用瞭newInstance方法，追進去看一下。

這裡看到是Java原生的動態代理，這裡返回的是一個代理對象。

執行一個Mapper的方法

因為看到這裡時Java的動態代理，所以也很顯而易見的得知。MapperProxy實現瞭InvocationHandler接口。

實現這個接口，會重寫Invoke方法。也就是說，我們雖然代碼上寫的是調用的我們Mapper中指向的方法，但是其實jvm會去調用這個invoke方法，接下來直接去追Invoke方法。

由於我們mapper是接口，所以上面的if是為false的，也就是else是我們執行的代碼，接著往裡追。

這裡可以看到new瞭一個PlainMethodInvoker，然後調用他的invoke方法，追進來。

接下來這個Execute就是他的具體執行Select語句的地方瞭。

由於後面的代碼有點長，我這裡就摘取瞭一小段關鍵的地方。看一下即可。

結論

MyBatis先讀取配置文件生成一個configuration對象，然後會生成對應的XmlParseBuilder，在對應的XmlParseBuilder會向configuration中的knowMapper中，放入對應的MapperProxyFactory。然後要執行mapper方法的時候，會通過mapperProxyFactory拿到一個Mapper的動態代理對象。隨後會動態代理對象會根據當前的方法去判斷調用SqlSession的不同的方法來執行Sql語句。

到此這篇關於Java MyBatis是如何執行一條SQL語句的的文章就介紹到這瞭,更多相關MyBatis執行SQL語句內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：