摘要：使用動態 SQL 并非一件易事，但借助可用于任何 SQL 映射陳述句中的強大的動態 SQL 語言，MyBatis 顯著地提升了這一特性的易用性，
本文分享自華為云社區《MyBatis詳解 - 動態SQL使用與原理》，作者：龍哥手記 ，
動態 SQL 是 MyBatis 的強大特性之一，如果你使用過 JDBC 或其它類似的框架，你應該能理解根據不同條件拼接 SQL 陳述句有多痛苦，例如拼接時要確保不能忘記添加必要的空格，還要注意去掉串列最后一個列名的逗號，利用動態 SQL，可以徹底擺脫這種痛苦，
使用動態 SQL 并非一件易事，但借助可用于任何 SQL 映射陳述句中的強大的動態 SQL 語言，MyBatis 顯著地提升了這一特性的易用性，
如果你之前用過 JSTL 或任何基于類 XML 語言的文本處理器，你對動態 SQL 元素可能會感覺似曾相識，在 MyBatis 之前的版本中，需要花時間了解大量的元素，借助功能強大的基于 OGNL 的運算式，MyBatis 3 替換了之前的大部分元素，大大精簡了元素種類，現在要學習的元素種類比原來的一半還要少，
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
if
使用動態 SQL 最常見情景是根據條件包含 where 子句的一部分，比如：
<select id="findActiveBlogWithTitleLike" resultType="Blog"> SELECT * FROM BLOG WHERE state = ‘ACTIVE’ <if test="title != null"> AND title like #{title} </if> </select>
這條陳述句提供了可選的查找文本功能，如果不傳入 “title”，那么所有處于 “ACTIVE” 狀態的 BLOG 都會回傳；如果傳入了 “title” 引數，那么就會對 “title” 一列進行模糊查找并回傳對應的 BLOG 結果（細心的讀者可能會發現，“title” 的引數值需要包含查找掩碼或通配符字符），
如果希望通過 “title” 和 “author” 兩個引數進行可選搜索該怎么辦呢？首先，我想先將陳述句名稱修改成更名副其實的名稱；接下來，只需要加入另一個條件即可，
<select id="findActiveBlogLike" resultType="Blog"> SELECT * FROM BLOG WHERE state = ‘ACTIVE’ <if test="title != null"> AND title like #{title} </if> <if test="author != null and author.name != null"> AND author_name like #{author.name} </if> </select>
choose、when、otherwise
有時候，我們不想使用所有的條件，而只是想從多個條件中選擇一個使用，針對這種情況，MyBatis 提供了 choose 元素，它有點像 Java 中的 switch 陳述句，
還是上面的例子，但是策略變為：傳入了 “title” 就按 “title” 查找，傳入了 “author” 就按 “author” 查找的情形，若兩者都沒有傳入，就回傳標記為 featured 的 BLOG（這可能是管理員認為，與其回傳大量的無意義隨機 Blog，還不如回傳一些由管理員挑選的 Blog），
<select id="findActiveBlogLike" resultType="Blog"> SELECT * FROM BLOG WHERE state = ‘ACTIVE’ <choose> <when test="title != null"> AND title like #{title} </when> <when test="author != null and author.name != null"> AND author_name like #{author.name} </when> <otherwise> AND featured = 1 </otherwise> </choose> </select>
trim、where、set
前面幾個例子已經合宜地解決了一個臭名昭著的動態 SQL 問題，現在回到之前的 “if” 示例，這次我們將 “state = ‘ACTIVE’” 設定成動態條件，看看會發生什么，
<select id="findActiveBlogLike" resultType="Blog"> SELECT * FROM BLOG WHERE <if test="state != null"> state = #{state} </if> <if test="title != null"> AND title like #{title} </if> <if test="author != null and author.name != null"> AND author_name like #{author.name} </if> </select>
如果沒有匹配的條件會怎么樣？最終這條 SQL 會變成這樣：
SELECT * FROM BLOG
WHERE
這會導致查詢失敗，如果匹配的只是第二個條件又會怎樣？這條 SQL 會是這樣:
SELECT * FROM BLOG
WHERE
AND title like ‘someTitle’
這個查詢也會失敗，這個問題不能簡單地用條件元素來解決，這個問題是如此的難以解決，以至于解決過的人不會再想碰到這種問題，
MyBatis 有一個簡單且適合大多數場景的解決辦法，而在其他場景中，可以對其進行自定義以符合需求，而這，只需要一處簡單的改動：
<select id="findActiveBlogLike" resultType="Blog"> SELECT * FROM BLOG <where> <if test="state != null"> state = #{state} </if> <if test="title != null"> AND title like #{title} </if> <if test="author != null and author.name != null"> AND author_name like #{author.name} </if> </where> </select>
where 元素只會在子元素回傳任何內容的情況下才插入 “WHERE” 子句，而且，若子句的開頭為 “AND” 或 “OR”，where 元素也會將它們去除，
如果 where 元素與你期望的不太一樣，你也可以通過自定義 trim 元素來定制 where 元素的功能，比如，和 where 元素等價的自定義 trim 元素為：
<trim prefix="WHERE" prefixOverrides="AND |OR "> ... </trim>
prefixOverrides 屬性會忽略通過管道符分隔的文本序列（注意此例中的空格是必要的），上述例子會移除所有 prefixOverrides 屬性中指定的內容，并且插入 prefix 屬性中指定的內容，
用于動態更新陳述句的類似解決方案叫做 set，set 元素可以用于動態包含需要更新的列，忽略其它不更新的列，比如：
<update id="updateAuthorIfNecessary"> update Author <set> <if test="username != null">username=#{username},</if> <if test="password != null">password=#{password},</if> <if test="email != null">email=#{email},</if> <if test="bio != null">bio=#{bio}</if> </set> where id=#{id} </update>
這個例子中，set 元素會動態地在行首插入 SET 關鍵字，并會刪掉額外的逗號（這些逗號是在使用條件陳述句給列賦值時引入的），
來看看與 set 元素等價的自定義 trim 元素吧：
<trim prefix="SET" suffixOverrides=","> ... </trim>
注意，我們覆寫了后綴值設定，并且自定義了前綴值，
foreach
動態 SQL 的另一個常見使用場景是對集合進行遍歷（尤其是在構建 IN 條件陳述句的時候），比如：
<select id="selectPostIn" resultType="domain.blog.Post"> SELECT * FROM POST P WHERE ID in <foreach item="item" index="index" collection="list" open="(" separator="," close=")"> #{item} </foreach> </select>
foreach 元素的功能非常強大，它允許你指定一個集合，宣告可以在元素體內使用的集合項（item）和索引（index）變數，它也允許你指定開頭與結尾的字串以及集合項迭代之間的分隔符，這個元素也不會錯誤地添加多余的分隔符，看它多智能！
提示：你可以將任何可迭代物件（如 List、Set 等）、Map 物件或者陣列物件作為集合引數傳遞給 foreach，當使用可迭代物件或者陣列時，index 是當前迭代的序號，item 的值是本次迭代獲取到的元素，當使用 Map 物件（或者 Map.Entry 物件的集合）時，index 是鍵，item 是值，
至此，我們已經完成了與 XML 配置及映射檔案相關的討論，下一章將詳細探討 Java API，以便你能充分利用已經創建的映射配置，
script
要在帶注解的映射器介面類中使用動態 SQL，可以使用 script 元素，比如:
@Update({"<script>",
"update Author",
" <set>",
" <if test='username != null'>username=#{username},</if>",
" <if test='password != null'>password=#{password},</if>",
" <if test='email != null'>email=#{email},</if>",
" <if test='bio != null'>bio=#{bio}</if>",
" </set>",
"where id=#{id}",
"</script>"})
void updateAuthorValues(Author author);
bind
bind 元素允許你在 OGNL 運算式以外創建一個變數，并將其系結到當前的背景關系，比如：
<select id="selectBlogsLike" resultType="Blog"> <bind name="pattern" value=https://www.cnblogs.com/huaweiyun/archive/2022/12/23/"'%' + _parameter.getTitle() + '%'" /> SELECT * FROM BLOG WHERE title LIKE #{pattern} </select>
多資料庫支持
如果配置了 databaseIdProvider，你就可以在動態代碼中使用名為 “_databaseId” 的變數來為不同的資料庫構建特定的陳述句，比如下面的例子：
<insert id="insert"> <selectKey keyProperty="id" resultType="int" order="BEFORE"> <if test="_databaseId == 'oracle'"> select seq_users.nextval from dual </if> <if test="_databaseId == 'db2'"> select nextval for seq_users from sysibm.sysdummy1" </if> </selectKey> insert into users values (#{id}, #{name}) </insert>
動態 SQL 中的插入腳本語言
MyBatis 從 3.2 版本開始支持插入腳本語言，這允許你插入一種語言驅動，并基于這種語言來撰寫動態 SQL 查詢陳述句，
可以通過實作以下介面來插入一種語言：
public interface LanguageDriver { ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql); SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType); SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType); }
實作自定義語言驅動后，你就可以在 mybatis-config.xml 檔案中將它設定為默認語言：
<typeAliases> <typeAlias type="org.sample.MyLanguageDriver" alias="myLanguage"/> </typeAliases> <settings> <setting name="defaultScriptingLanguage" value=https://www.cnblogs.com/huaweiyun/archive/2022/12/23/"myLanguage"/> </settings>
或者，你也可以使用 lang 屬性為特定的陳述句指定語言：
<select id="selectBlog" lang="myLanguage"> SELECT * FROM BLOG </select>
或者，在你的 mapper 介面上添加 @Lang 注解：
public interface Mapper { @Lang(MyLanguageDriver.class) @Select("SELECT * FROM BLOG") List<Blog> selectBlog(); }
提示：可以使用 Apache Velocity 作為動態語言，更多細節請參考 MyBatis-Velocity 專案，
你前面看到的所有 xml 標簽都由默認 MyBatis 語言提供，而它由語言驅動 org.apache.ibatis.scripting.xmltags.XmlLanguageDriver（別名為 xml）所提供，
動態SQL決議原理
我們在使用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的？下面帶著這個疑問，我們一步一步分析，
關于動態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：
- XMLConfigBuilder：決議mybatis中configLocation屬性中的全域xml檔案，內部會使用XMLMapperBuilder決議各個xml檔案，
- XMLMapperBuilder：遍歷mybatis中mapperLocations屬性中的xml檔案中每個節點的Builder，比如user.xml，內部會使用XMLStatementBuilder處理xml中的每個節點，
- XMLStatementBuilder：決議xml檔案中各個節點，比如select,insert,update,delete節點，內部會使用XMLScriptBuilder處理節點的sql部分，遍歷產生的資料會丟到Configuration的mappedStatements中，
- XMLScriptBuilder：決議xml中各個節點sql部分的Builder，
LanguageDriver介面及其實作類(屬性，方法省略了，大家有興趣的自己看)，該介面主要的作用就是構造sql:
簡單分析下XMLLanguageDriver(處理xml中的sql，RawLanguageDriver處理靜態sql)：XMLLanguageDriver內部會使用XMLScriptBuilder決議xml中的sql部分，
原始碼分析走起
Spring與Mybatis整合的時候需要配置SqlSessionFactoryBean，該配置會加入資料源和mybatis xml組態檔路徑等資訊：
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="configLocation" value=https://www.cnblogs.com/huaweiyun/archive/2022/12/23/"classpath:mybatisConfig.xml"/> <property name="mapperLocations" value=https://www.cnblogs.com/huaweiyun/archive/2022/12/23/"classpath*:org/format/dao/*.xml"/> </bean>
我們就分析這一段配置背后的細節：
SqlSessionFactoryBean實作了Spring的InitializingBean介面，InitializingBean介面的afterPropertiesSet方法中會呼叫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>
parseDynamicTags方法的回傳值是一個List，也就是一個Sql節點集合，SqlNode本文一開始已經介紹，分析完決議程序之后會說一下各個SqlNode型別的作用，
首先根據update節點(Node)得到所有的子節點，分別是3個子節點：
- 文本節點 \n UPDATE users
- trim子節點 ...
- 文本節點 \n where id = #
遍歷各個子節點：
- 如果節點型別是文本或者CDATA，構造一個TextSqlNode或StaticTextSqlNode；
- 如果節點型別是元素，說明該update節點是個動態sql，然后會使用NodeHandler處理各個型別的子節點，這里的NodeHandler是XMLScriptBuilder的一個內部介面，其實作類包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等，看類名也就明白了這個Handler的作用，比如我們分析的trim節點，對應的是TrimHandler；if節點，對應的是IfHandler...這里子節點trim被TrimHandler處理，TrimHandler內部也使用parseDynamicTags方法決議節點，
遇到子節點是元素的話，重復以上步驟：
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：MixedSqlNode會遍歷呼叫內部各個sqlNode的apply方法，
public boolean apply(DynamicContext context) { for (SqlNode sqlNode : contents) { sqlNode.apply(context); } return true; }
StaticTextSqlNode：直接append sql文本，
public boolean apply(DynamicContext context) { context.appendSql(text); return true; }
IfSqlNode：這里的evaluator是一個ExpressionEvaluator型別的實體，內部使用了OGNL處理運算式邏輯，
public boolean apply(DynamicContext context) { if (evaluator.evaluateBoolean(test, context.getBindings())) { contents.apply(context); return true; } return false; }
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，
點擊關注，第一時間了解華為云新鮮技術~
轉載請註明出處，本文鏈接：https://www.uj5u.com/shujuku/540662.html
標籤：其他