前言

廢話不多說，直接進(jìn)入文章。
我們在使用mybatis的時候，會在xml中編寫sql語句。
比如這段動態(tài)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底層是如何構(gòu)造這段sql的？
這方面的知識網(wǎng)上資料不多，于是就寫了這么一篇文章。
下面帶著這個疑問，我們一步一步分析。

介紹MyBatis中一些關(guān)于動態(tài)SQL的接口和類

SqlNode接口，簡單理解就是xml中的每個標(biāo)簽，比如上述sql的update,trim,if標(biāo)簽：

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

SqlSource Sql源接口，代表從xml文件或注解映射的sql內(nèi)容，主要就是用于創(chuàng)建BoundSql，有實現(xiàn)類DynamicSqlSource(動態(tài)Sql源)，StaticSqlSource(靜態(tài)Sql源)等：

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

BoundSql類，封裝mybatis最終產(chǎn)生sql的類，包括sql語句，參數(shù)，參數(shù)源數(shù)據(jù)等參數(shù)：

XNode，一個Dom API中的Node接口的擴(kuò)展類。

BaseBuilder接口及其實現(xiàn)類(屬性，方法省略了，大家有興趣的自己看),這些Builder的作用就是用于構(gòu)造sql:

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

1 XMLConfigBuilder

解析mybatis中configLocation屬性中的全局xml文件，內(nèi)部會使用XMLMapperBuilder解析各個xml文件。

2 XMLMapperBuilder

遍歷mybatis中mapperLocations屬性中的xml文件中每個節(jié)點的Builder，比如user.xml，內(nèi)部會使用XMLStatementBuilder處理xml中的每個節(jié)點。

3 XMLStatementBuilder

解析xml文件中各個節(jié)點，比如select,insert,update,delete節(jié)點，內(nèi)部會使用XMLScriptBuilder處理節(jié)點的sql部分，遍歷產(chǎn)生的數(shù)據(jù)會丟到Configuration的mappedStatements中。

4 XMLScriptBuilder

解析xml中各個節(jié)點sql部分的Builder。

LanguageDriver接口及其實現(xiàn)類(屬性，方法省略了，大家有興趣的自己看)，該接口主要的作用就是構(gòu)造sql:

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

XMLLanguageDriver內(nèi)部會使用XMLScriptBuilder解析xml中的sql部分。

ok， 大部分比較重要的類我們都已經(jīng)介紹了，下面源碼分析走起。

源碼分析走起

Spring與Mybatis整合的時候需要配置SqlSessionFactoryBean，該配置會加入數(shù)據(jù)源和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>

我們就分析這一段配置背后的細(xì)節(jié)：

SqlSessionFactoryBean實現(xiàn)了Spring的InitializingBean接口，InitializingBean接口的afterPropertiesSet方法中會調(diào)用buildSqlSessionFactory方法

buildSqlSessionFactory方法內(nèi)部會使用XMLConfigBuilder解析屬性configLocation中配置的路徑，還會使用XMLMapperBuilder屬性解析mapperLocations屬性中的各個xml文件。

部分源碼如下：

由于XMLConfigBuilder內(nèi)部也是使用XMLMapperBuilder，我們就看看XMLMapperBuilder的解析細(xì)節(jié)。

我們關(guān)注一下，增刪改查節(jié)點的解析。

XMLStatementBuilder的解析：

默認(rèn)會使用XMLLanguageDriver創(chuàng)建SqlSource（Configuration構(gòu)造函數(shù)中設(shè)置）。

XMLLanguageDriver創(chuàng)建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相關(guān)的知識，xml dom知識,?dom博文

parseDynamicTags方法的返回值是一個List，也就是一個Sql節(jié)點集合。SqlNode本文一開始已經(jīng)介紹，分析完解析過程之后會說一下各個SqlNode類型的作用。

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

(1)文本節(jié)點 \n UPDATE users

(2)trim子節(jié)點?…

(3)文本節(jié)點 \n where id = #{id}

2 遍歷各個子節(jié)點

(1) 如果節(jié)點類型是文本或者CDATA，構(gòu)造一個TextSqlNode或StaticTextSqlNode

(2) 如果節(jié)點類型是元素，說明該update節(jié)點是個動態(tài)sql，然后會使用NodeHandler處理各個類型的子節(jié)點。這里的NodeHandler是XMLScriptBuilder的一個內(nèi)部接口，其實現(xiàn)類包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等?？搭惷簿兔靼琢诉@個Handler的作用，比如我們分析的trim節(jié)點，對應(yīng)的是TrimHandler；if節(jié)點，對應(yīng)的是IfHandler…

這里子節(jié)點trim被TrimHandler處理，TrimHandler內(nèi)部也使用parseDynamicTags方法解析節(jié)點

3 遇到子節(jié)點是元素的話，重復(fù)以上步驟

trim子節(jié)點內(nèi)部有7個子節(jié)點，分別是文本節(jié)點、if節(jié)點、是文本節(jié)點、if節(jié)點、是文本節(jié)點、if節(jié)點、文本節(jié)點。文本節(jié)點跟之前一樣處理，if節(jié)點使用IfHandler處理

遍歷步驟如上所示，下面我們看下幾個Handler的實現(xiàn)細(xì)節(jié)。

IfHandler處理方法也是使用parseDynamicTags方法，然后加上if標(biāo)簽必要的屬性。

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標(biāo)簽必要的屬性。

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節(jié)點：

由于這個update方法是個動態(tài)節(jié)點，因此構(gòu)造出了DynamicSqlSource。

DynamicSqlSource內(nèi)部就可以構(gòu)造sql了:

DynamicSqlSource內(nèi)部的SqlNode屬性是一個MixedSqlNode。

然后我們看看各個SqlNode實現(xiàn)類的apply方法

下面分析一下兩個SqlNode實現(xiàn)類的apply方法實現(xiàn)：

MixedSqlNode：

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

MixedSqlNode會遍歷調(diào)用內(nèi)部各個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類型的實例，內(nèi)部使用了OGNL處理表達(dá)式邏輯。

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方法也是調(diào)用屬性contents(一般都是MixedSqlNode)的apply方法，按照實例也就是7個SqlNode，都是StaticTextSqlNode和IfSqlNode。 最后會使用FilteredDynamicContext過濾掉prefix和suffix。

總結(jié)

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

<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節(jié)點的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節(jié)點多了個逗號) 結(jié)果我發(fā)現(xiàn)這2段xml解析的結(jié)果是一樣的，非常迫切地想知道這到底是為什么，然后這也促使了我去看源碼的決心。最終還是看下來了。

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

本文作者：Format
原文鏈接： http://fangjian0423.github.io/2014/09/26/mybatis-dynamic-sql /

總結(jié)

以上是生活随笔為你收集整理的MyBatis动态SQL底层原理分析的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。