2. 程式人生 > >Mybatis解析動態sql原理分析

Mybatis解析動態sql原理分析

阿新 • • 發佈：2019-01-09

前言

廢話不多說，直接進入文章。
我們在使用mybatis的時候，會在xml中編寫sql語句。
比如這段動態sql程式碼：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

mybatis底層是如何構造這段sql的？
這方面的知識網上資料不多，於是就寫了這麼一篇文章。
下面帶著這個疑問，我們一步一步分析。

介紹MyBatis中一些關於動態SQL的介面和類

SqlNode介面，簡單理解就是xml中的每個標籤，比如上述sql的update,trim,if標籤：

public interface SqlNode {
  boolean apply(DynamicContext context);
}

SqlSource Sql源介面，代表從xml檔案或註解對映的sql內容，主要就是用於建立BoundSql，有實現類DynamicSqlSource(動態Sql源)，StaticSqlSource(靜態Sql源)等：

public interface SqlSource {
  BoundSql getBoundSql(Object parameterObject);
}

BoundSql類，封裝mybatis最終產生sql的類，包括sql語句，引數，引數源資料等引數：

XNode，一個Dom API中的Node介面的擴充套件類。

BaseBuilder介面及其實現類(屬性，方法省略了，大家有興趣的自己看),這些Builder的作用就是用於構造sql:

下面我們簡單分析下其中4個Builder：

1 XMLConfigBuilder

解析mybatis中configLocation屬性中的全域性xml檔案，內部會使用XMLMapperBuilder解析各個xml檔案。

2 XMLMapperBuilder

遍歷mybatis中mapperLocations屬性中的xml檔案中每個節點的Builder，比如user.xml，內部會使用XMLStatementBuilder處理xml中的每個節點。

3 XMLStatementBuilder

解析xml檔案中各個節點，比如select,insert,update,delete節點，內部會使用XMLScriptBuilder處理節點的sql部分，遍歷產生的資料會丟到Configuration的mappedStatements中。

4 XMLScriptBuilder

解析xml中各個節點sql部分的Builder。

LanguageDriver介面及其實現類(屬性，方法省略了，大家有興趣的自己看)，該介面主要的作用就是構造sql:

簡單分析下XMLLanguageDriver(處理xml中的sql，RawLanguageDriver處理靜態sql)：

XMLLanguageDriver內部會使用XMLScriptBuilder解析xml中的sql部分。

ok， 大部分比較重要的類我們都已經介紹了，下面原始碼分析走起。

原始碼分析走起

Spring與Mybatis整合的時候需要配置SqlSessionFactoryBean，該配置會加入資料來源和mybatis xml配置檔案路徑等資訊：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatisConfig.xml"/>
    <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
</bean>

我們就分析這一段配置背後的細節：

SqlSessionFactoryBean實現了Spring的InitializingBean介面，InitializingBean介面的afterPropertiesSet方法中會呼叫buildSqlSessionFactory方法

buildSqlSessionFactory方法內部會使用XMLConfigBuilder解析屬性configLocation中配置的路徑，還會使用XMLMapperBuilder屬性解析mapperLocations屬性中的各個xml檔案。

部分原始碼如下：

由於XMLConfigBuilder內部也是使用XMLMapperBuilder，我們就看看XMLMapperBuilder的解析細節。

我們關注一下，增刪改查節點的解析。

XMLStatementBuilder的解析：

預設會使用XMLLanguageDriver建立SqlSource（Configuration建構函式中設定）。

XMLLanguageDriver建立SqlSource：

XMLScriptBuilder解析sql：

得到SqlSource之後，會放到Configuration中，有了SqlSource，就能拿BoundSql了，BoundSql可以得到最終的sql。

例項分析

我以以下xml的解析大概說下parseDynamicTags的解析過程：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

在看這段解析之前，請先了解dom相關的知識，xml dom知識, dom博文

parseDynamicTags方法的返回值是一個List，也就是一個Sql節點集合。SqlNode本文一開始已經介紹，分析完解析過程之後會說一下各個SqlNode型別的作用。

1 首先根據update節點(Node)得到所有的子節點，分別是3個子節點

(1)文字節點 \n UPDATE users

(2)trim子節點 ...

(3)文字節點 \n where id = #{id}

2 遍歷各個子節點

(1) 如果節點型別是文字或者CDATA，構造一個TextSqlNode或StaticTextSqlNode

(2) 如果節點型別是元素，說明該update節點是個動態sql，然後會使用NodeHandler處理各個型別的子節點。這裡的NodeHandler是XMLScriptBuilder的一個內部介面，其實現類包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看類名也就明白了這個Handler的作用，比如我們分析的trim節點，對應的是TrimHandler；if節點，對應的是IfHandler...

這裡子節點trim被TrimHandler處理，TrimHandler內部也使用parseDynamicTags方法解析節點

3 遇到子節點是元素的話，重複以上步驟

trim子節點內部有7個子節點，分別是文字節點、if節點、是文字節點、if節點、是文字節點、if節點、文字節點。文字節點跟之前一樣處理，if節點使用IfHandler處理

遍歷步驟如上所示，下面我們看下幾個Handler的實現細節。

IfHandler處理方法也是使用parseDynamicTags方法，然後加上if標籤必要的屬性。

private class IfHandler implements NodeHandler {
    public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
      List<SqlNode> contents = parseDynamicTags(nodeToHandle);
      MixedSqlNode mixedSqlNode = new MixedSqlNode(contents);
      String test = nodeToHandle.getStringAttribute("test");
      IfSqlNode ifSqlNode = new IfSqlNode(mixedSqlNode, test);
      targetContents.add(ifSqlNode);
    }
}

TrimHandler處理方法也是使用parseDynamicTags方法，然後加上trim標籤必要的屬性。

private class TrimHandler implements NodeHandler {
    public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
      List<SqlNode> contents = parseDynamicTags(nodeToHandle);
      MixedSqlNode mixedSqlNode = new MixedSqlNode(contents);
      String prefix = nodeToHandle.getStringAttribute("prefix");
      String prefixOverrides = nodeToHandle.getStringAttribute("prefixOverrides");
      String suffix = nodeToHandle.getStringAttribute("suffix");
      String suffixOverrides = nodeToHandle.getStringAttribute("suffixOverrides");
      TrimSqlNode trim = new TrimSqlNode(configuration, mixedSqlNode, prefix, prefixOverrides, suffix, suffixOverrides);
      targetContents.add(trim);
    }
}

以上update方法最終通過parseDynamicTags方法得到的SqlNode集合如下：

trim節點：

由於這個update方法是個動態節點，因此構造出了DynamicSqlSource。

DynamicSqlSource內部就可以構造sql了:

DynamicSqlSource內部的SqlNode屬性是一個MixedSqlNode。

然後我們看看各個SqlNode實現類的apply方法

下面分析一下兩個SqlNode實現類的apply方法實現：

MixedSqlNode：

public boolean apply(DynamicContext context) {
    for (SqlNode sqlNode : contents) {
      sqlNode.apply(context);
    }
    return true;
}

MixedSqlNode會遍歷呼叫內部各個sqlNode的apply方法。

StaticTextSqlNode:

public boolean apply(DynamicContext context) {
    context.appendSql(text);
    return true;
}

直接append sql文字。

IfSqlNode:

public boolean apply(DynamicContext context) {
    if (evaluator.evaluateBoolean(test, context.getBindings())) {
      contents.apply(context);
      return true;
    }
    return false;
}

這裡的evaluator是一個ExpressionEvaluator型別的例項，內部使用了OGNL處理表達式邏輯。

TrimSqlNode:

public boolean apply(DynamicContext context) {
    FilteredDynamicContext filteredDynamicContext = new FilteredDynamicContext(context);
    boolean result = contents.apply(filteredDynamicContext);
    filteredDynamicContext.applyAll();
    return result;
}

public void applyAll() {
  sqlBuffer = new StringBuilder(sqlBuffer.toString().trim());
  String trimmedUppercaseSql = sqlBuffer.toString().toUpperCase(Locale.ENGLISH);
  if (trimmedUppercaseSql.length() > 0) {
    applyPrefix(sqlBuffer, trimmedUppercaseSql);
    applySuffix(sqlBuffer, trimmedUppercaseSql);
  }
  delegate.appendSql(sqlBuffer.toString());
}

private void applyPrefix(StringBuilder sql, String trimmedUppercaseSql) {
  if (!prefixApplied) {
    prefixApplied = true;
    if (prefixesToOverride != null) {
      for (String toRemove : prefixesToOverride) {
        if (trimmedUppercaseSql.startsWith(toRemove)) {
          sql.delete(0, toRemove.trim().length());
          break;
        }
      }
    }
    if (prefix != null) {
      sql.insert(0, " ");
      sql.insert(0, prefix);
    }
  }
}

TrimSqlNode的apply方法也是呼叫屬性contents(一般都是MixedSqlNode)的apply方法，按照例項也就是7個SqlNode，都是StaticTextSqlNode和IfSqlNode。 最後會使用FilteredDynamicContext過濾掉prefix和suffix。

總結

大致講解了一下mybatis對動態sql語句的解析過程，其實回過頭來看看不算複雜，還算蠻簡單的。 之前接觸mybaits的時候遇到剛才分析的那一段動態sql的時候總是很費解。

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

想搞明白這個trim節點的prefixOverrides到底是什麼意思(從字面上理解就是字首覆蓋)，而且官方文件上也沒這方面知識的說明。我將這段xml改成如下：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            , name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

(第二段第一個if節點多了個逗號) 結果我發現這2段xml解析的結果是一樣的，非常迫切地想知道這到底是為什麼，然後這也促使了我去看原始碼的決心。最終還是看下來了。

文章有點長，而且講的也不是非常直觀，希望對有些人有幫助。

 

Java Framework,歡迎各位前來交流java相關
QQ群:965125360

推薦JVM的視訊:

深入理解Java虛擬機器（jvm效能調優+記憶體模型+虛擬機器原理）
https://item.taobao.com/item.htm?spm=a1z38n.10677092.0.0.c9e51deb8seTn4&id=583526620411
 

 

轉載自:https://www.cnblogs.com/fangjian0423/p/mybaits-dynamic-sql-analysis.html

相關推薦

Mybatis解析動態sql原理分析

前言 廢話不多說，直接進入文章。 我們在使用mybatis的時候，會在xml中編寫sql語句。 比如這段動態sql程式碼： <update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">

mybatis 之動態 SQL

if mybatis _parameter _databaseid 動態 sql 1、動態 SQL 簡介： 動態 SQL 是 MyBatis 強大特性之一。極大的簡化我們拼裝 SQL 的操作。 動態 SQL 元素和使用 JSTL 或者其他類似基於 XML 的文本處理器相似。

Mybatis中動態sql中trim標簽的使用

bat fix 打印 第一個 屬性 其中 紅色 span pre trim是一個格式化的標記，可以完成set或者where標記的功能。 trim屬性： prefix：前綴覆蓋並增加其內容 suffix：後綴覆蓋並增加其內容 prefixOverrides：前綴判斷的條件 s

mybatis 之動態sql 增刪改查

delete ktr password test 事務回滾 tel class http ctype ====================== mybatis的動態SQL ============ ------------------------------------

MyBatis中動態SQL語句完成多條件查詢

null nbsp mybatis myba 查詢 from ref HR OS http://blog.csdn.net/yanggaosheng/article/details/46685565 MyBatis中動態SQL語句完成多條件查詢 <select i

MyBatis的動態SQL（五）

pan 需要 9.png ack bat 鏈接 where In 標簽 　　 用於實現動態SQL的元素主要有iftrimwheresetchoose（when、otherwise）foreach if標簽 　　Where標簽 　　Sql後面添加： where 1=1 ，那

Java SSM框架之MyBatis3（八）MyBatis之動態SQL

one uniq div mapper ODB when rop mail con 前言： 　　mybatis框架中最具特色的便是sql語句中的自定義，而動態sql的使用又使整個框架更加靈活。 創建User表 /*Table structure for tab

MyBatis(4)動態SQL

截圖 轉義字符 ram 分隔符 當前 pup efi Opens rep MyBatis 的強大特性之一便是它的動態 SQL。如果你有使用 JDBC 或其它類似框架的經驗，你就能體會到根據不同條件拼接 SQL 語句的痛苦。例如拼接時要確保不能忘記添加必要的空格，還要註意去

MyBatis的動態sql小練習，小回顧

關鍵字if+trim trim可以去除多餘的關鍵字，是where和set的組合 trim標記是一個格式化的標記，可以完成set或者是where標記的功能，如下程式碼： <trim prefix="" suffix="" suffixOverrides="" prefixOverrides=""

mybatis的動態sql與核心對映

一：mybatis中如何使用動態sql： MyBatis的強大特性之一便是它的動態 SQL。如果你有使用 JDBC 或其他類似框架的經驗，你就能體會到根據不同條件拼接 SQL 語句有多麼痛苦。拼接的時候要確保不能忘了必要的空格，還要注意省掉列名列表最後的逗號。有些時候，SQL語句where條

mybatis中動態sql的實現與使用

首先引用一段mybatis文件中的話： 動態 SQL     MyBatis 的強大特性之一便是它的動態 SQL。如果你有使用 JDBC 或其它類似框架的經驗，你就能體會到根據不同條件拼接 SQL 語句的痛苦。例如拼接時要確保不能忘記新增必要的空格，還要注意去掉列表最

Mybatis之動態SQL揭祕

今天小編在這裡為大家介紹一下Mybatis的一個強大功能-動態SQL 動態SQL是Mybatis的一個強大的特性，在使用JDBC操作資料時，如果查詢條件特別多，將條件串聯成SQL字串是一件非常痛苦的事情，通常的解決方法使寫很多的if-else條件語句去判斷和拼接，並確保不能忘了空格或在欄位的最後省略逗號。My

Mybatis中動態SQL使用foreach遍歷

在之前資料庫中用sql語句批量刪除的操作    使用sql多條刪除語句delete from person where name in ('a','b'); 現在改用mybatis中批量資料庫語句刪除 <delete id="deletePerson"&g

Mybatis之動態 SQL

Mybatis之動態 SQL 轉載地址：http://www.mybatis.org/mybatis-3/zh/dynamic-sql.html 一、動態SQL     MyBatis 的強大特性之一便是它的動態 SQL。如果你有使用 JDBC 或其他

mybatis中動態sql的trim標籤的使用

trim標籤是一種格式化的標記，可以完成set或者是where標記的功能，程式碼如下： 1、select * from user 　<trim prefix="WHERE" prefixoverride="AND |OR"> 　　　　<if test="name != n

使用mybatis的動態sql來完成 SQL 多條件組合查詢（模糊查詢）

對於一般的模糊查詢，沒有使用框架的連結部落格地址：點選這裡 對於mybatis，框架內部欸出了處理方式，即使用mybatis的內建標籤和OGNL表示式 mybatis在select，update,delete,insert等標籤中加入了 if choose (when, ot

【Mybatis】動態SQL之choose、when、otherwise

Mybatis中沒有if-else的寫法，取而代之的是choose-when-otherwise。choose在最外面，when相當於if，otherwise則相當於else。 <choose> <wh

mybatis之動態SQL操作之刪除

/** * 持久層 */ public class StudentDao { /** * 動態SQL--刪除 */ public void dynaSQLwithDelete(int... ids) throws Exception{

mybatis之動態SQL操作之更新

1）  更新條件不確定，需要根據情況產生SQL語法，這種情況叫動態SQL /** * 持久層*/ public class StudentDao { /** * 動態SQL--更新 */ public void dynaSQLwithUpda

mybatis之動態SQL操作之查詢

1）  查詢條件不確定，需要根據情況產生SQL語法，這種情況叫動態SQL /** * 持久層 * @author AdminTC */ public class StudentDao { /** * 動態SQL--查詢 */ publ