【深刻淺出MyBatis系列四】強大的動態SQL

時間  2019-11-06
標籤 深刻淺出MyBatis系列四 強大 動態 sql 欄目 SQL 简体版
原文   原文鏈接

#0 系列目錄#java

#1 動態SQL# 那麼，問題來了： 什麼是動態SQL? 動態SQL有什麼做用？node

傳統的使用JDBC的方法，相信你們在組合複雜的的SQL語句的時候，須要去拼接，稍不注意哪怕少了個空格，都會致使錯誤。Mybatis的動態SQL功能正是爲了解決這種問題， 其經過 if, choose, when, otherwise, trim, where, set, foreach標籤，可組合成很是靈活的SQL語句，從而提升開發人員的效率。下面就去感覺Mybatis動態SQL的魅力吧。spring

#2 if: 大家能判斷，我也能判斷！# 做爲程序猿，誰不懂 if ! 在mybatis中也能用 if 啦：sql

<select id="findUserById" resultType="user">
    select * from user where 
        <if test="id != null">
               id=#{id}
        </if>
    and deleteFlag=0;
</select>

上面例子： 若是傳入的id 不爲空， 那麼纔會SQL才拼接id = #{id}。 這個相信你們看同樣就能明白，很少說。細心的人會發現一個問題：「你這不對啊！ 要是你傳入的id爲null, 那麼你這最終的SQL語句不就成了 select * from user where and deleteFlag=0, 這語句有問題！」數組

是啊，這時候，mybatis的 where 標籤就該隆重登場啦。 #3 where, 有了我，SQL語句拼接條件神馬的都是浮雲！# 我們經過where改造一下上面的例子：緩存

<select id="findUserById" resultType="user">
    select * from user 
        <where>
            <if test="id != null">
                id=#{id}
            </if>
            and deleteFlag=0;
        </where>
</select>

有些人就要問了： 「你這都是些什麼玩意兒！ 跟上面的相比， 不就是多了個where標籤嘛！ 那這個還會不會出現 select * from user where and deleteFlag=0 ？」mybatis

的確，從表面上來看，就是多了個where標籤而已， 不過實質上， mybatis是對它作了處理，當它遇到AND或者OR這些，它知道怎麼處理。其實咱們能夠經過 trim 標籤去自定義這種處理規則。app

#4 trim : 個人地盤，我作主！# 上面的where標籤，其實用trim 能夠表示以下：dom

<trim prefix="WHERE" prefixOverrides="AND |OR ">
    ... 
</trim>

它的意思就是：當WHERE後緊隨AND或則OR的時候，就去除AND或者OR。 除了WHERE之外， 其實還有一個比較經典的實現，那就是SET。ide

#5 set: 信我，不出錯！#

<update id="updateUser" parameterType="com.dy.entity.User">
    update user set 
        <if test="name != null">
            name = #{name},
        </if> 
        <if test="password != null">
            password = #{password},
        </if> 
        <if test="age != null">
            age = #{age}
        </if> 
        <where>
            <if test="id != null">
                id = #{id}
            </if>
            and deleteFlag = 0;
        </where>
</update>

問題又來了： 「若是我只有name不爲null, 那麼這SQL不就成了 update set name = #{name}, where ........ ? 你那name後面那逗號會致使出錯啊！」

是的，這時候，就能夠用mybatis爲咱們提供的set 標籤了。下面是經過set標籤改造後：

<update id="updateUser" parameterType="com.dy.entity.User">
    update user
        <set>
            <if test="name != null">name = #{name},</if> 
            <if test="password != null">password = #{password},</if> 
            <if test="age != null">age = #{age},</if> 
        </set>
        <where>
            <if test="id != null">
                id = #{id}
            </if>
            and deleteFlag = 0;
        </where>
</update>

這個用trim 可表示爲：

<trim prefix="SET" suffixOverrides=",">
  ...
</trim>

WHERE是使用的 prefixOverrides（前綴）， SET是使用的 suffixOverrides （後綴）， 看明白了吧！

#6 foreach: 你有for, 我有foreach, 不要覺得就你才屌！# java中有for, 可經過for循環， 一樣， mybatis中有foreach, 可經過它實現循環，循環的對象固然主要是java容器和數組。

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

**將一個 List 實例或者數組做爲參數對象傳給 MyBatis：**當這麼作的時候，MyBatis 會自動將它包裝在一個 Map 中並以名稱爲鍵。List 實例將會以「list」做爲鍵，而數組實例的鍵將是「array」。一樣，當循環的對象爲map的時候，index其實就是map的key。

#7 choose: 我選擇了你，你選擇了我！# Java中有switch, mybatis有choose。

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

以上例子中： 當title和author都不爲null的時候， 那麼選擇二選一（前者優先）， 若是都爲null, 那麼就選擇 otherwise中的， 若是tilte和author只有一個不爲null, 那麼就選擇不爲null的那個。

#8 動態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的？下面帶着這個疑問，咱們一步一步分析。

##8.1 關於動態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部分。

##8.2 源碼分析走起## 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方法 該方法內部會使用XMLConfigBuilder解析屬性configLocation中配置的路徑，還會使用XMLMapperBuilder屬性解析mapperLocations屬性中的各個xml文件。部分源碼以下：

輸入圖片說明

因爲XMLConfigBuilder內部也是使用XMLMapperBuilder，咱們就看看XMLMapperBuilder的解析細節：

輸入圖片說明

輸入圖片說明

咱們關注一下，增刪改查節點的解析：

輸入圖片說明

XMLStatementBuilder的解析：

輸入圖片說明

默認會使用XMLLanguageDriver建立SqlSource（Configuration構造函數中設置）。

XMLLanguageDriver建立SqlSource：

輸入圖片說明

XMLScriptBuilder解析sql：

輸入圖片說明

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

##8.3 實例分析## 如下面的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類型的做用。

  1. 首先根據update節點(Node)獲得全部的子節點，分別是3個子節點：

(1) 文本節點 \n UPDATE users

(2) trim子節點 ...

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

  1. 遍歷各個子節點：

(1) 若是節點類型是文本或者CDATA，構造一個TextSqlNode或StaticTextSqlNode；

(2) 若是節點類型是元素，說明該update節點是個動態sql，而後會使用NodeHandler處理各個類型的子節點。這裏的NodeHandler是XMLScriptBuilder的一個內部接口，其實現類包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看類名也就明白了這個Handler的做用，好比咱們分析的trim節點，對應的是TrimHandler；if節點，對應的是IfHandler...這裏子節點trim被TrimHandler處理，TrimHandler內部也使用parseDynamicTags方法解析節點。

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

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方法實現：

  1. MixedSqlNode：MixedSqlNode會遍歷調用內部各個sqlNode的apply方法。
public boolean apply(DynamicContext context) {
   for (SqlNode sqlNode : contents) {
     sqlNode.apply(context);
   }
   return true;
}
  1. StaticTextSqlNode：直接append sql文本。
public boolean apply(DynamicContext context) {
   context.appendSql(text);
   return true;
}
  1. IfSqlNode：這裏的evaluator是一個ExpressionEvaluator類型的實例，內部使用了OGNL處理表達式邏輯。
public boolean apply(DynamicContext context) {
   if (evaluator.evaluateBoolean(test, context.getBindings())) {
     contents.apply(context);
     return true;
   }
   return false;
}
  1. 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。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程