MyBatis動態SQL底層原理分析

咱們在使用mybatis的時候，會在xml中編寫sql語句。
好比這段動態sql代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

<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標籤：

1 2 3

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

SqlSource Sql源接口，表明從xml文件或註解映射的sql內容，主要就是用於建立BoundSql，有實現類DynamicSqlSource(動態Sql源)，StaticSqlSource(靜態Sql源)等：

1 2 3

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配置文件路徑等信息：

1 2 3 4 5

<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的解析過程：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

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

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標籤必要的屬性。

1 2 3 4 5 6 7 8 9

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標籤必要的屬性。

1 2 3 4 5 6 7 8 9 10 11 12

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：

1 2 3 4 5 6

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

MixedSqlNode會遍歷調用內部各個sqlNode的apply方法。

StaticTextSqlNode:

1 2 3 4

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

直接append sql文本。

IfSqlNode:

1 2 3 4 5 6 7

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

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

TrimSqlNode:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

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的時候老是很費解。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

<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改爲以下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

<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解析的結果是同樣的，很是迫切地想知道這究竟是爲何，而後這也促使了我去看源碼的決心。最終仍是看下來了。