MyBatis動態SQL底層原理分析
MyBatis動態SQL底層原理分析
我們在使用mybatis的時候，會在xml中編寫sql語句。
比如這段動態sql代碼：
UPDATE users
name = #{name}
, age = #{age}
, birthday = #{birthday}
where id = ${id}
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配置文件路徑等信息：
我們就分析這一段配置背後的細節：
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 users
name = #{name}
, age = #{age}
, birthday = #{birthday}
where id = ${id}
parseDynamicTags方法的返回值是一個List，也就是一個Sql節點集合。SqlNode本文一開始已經介紹，分析完解析過程之後會說一下各個SqlNode類型的作用。
1 首先根據update節點(Node)得到所有的子節點，分別是3個子節點
(1)文本節點
UPDATE users
(2)trim子節點 …
(3)文本節點
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, ListtargetContents) {
Listcontents = 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, ListtargetContents) {
Listcontents = 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 users
name = #{name}
, age = #{age}
, birthday = #{birthday}
where id = ${id}
想搞明白這個trim節點的prefixOverrides到底是什麼意思(從字面上理解就是前綴覆蓋)，而且官方文檔上也沒這方面知識的說明。我將這段xml改成如下：
UPDATE users
, name = #{name}
, age = #{age}
, birthday = #{birthday}
where id = ${id}
(第二段第一個if節點多了個逗號) 結果我發現這2段xml解析的結果是一樣的，非常迫切地想知道這到底是為什麼，然後這也促使了我去看源碼的決心。最終還是看下來了。
推薦閱讀：
