一篇文章帶你瞭解mybatis的動態SQL

Posted on by

1、動態SQL:if 語句

根據 username 和 sex 來查詢數據。如果username為空，那麼將隻根據sex來查詢；反之隻根據username來查詢

首先不使用 動態SQL 來書寫

<select id="selectUserByUsernameAndSex"
        resultType="user" parameterType="com.ys.po.User">
    <!-- 這裡和普通的sql 查詢語句差不多，對於隻有一個參數，後面的 #{id}表示占位符，裡面不一定要寫id,
            寫啥都可以，但是不要空著，如果有多個參數則必須寫pojo類裡面的屬性 -->
    select * from user where username=#{username} and sex=#{sex}
</select>

上面的查詢語句，我們可以發現，如果 #{username} 為空，那麼查詢結果也是空，如何解決這個問題呢？使用 if 來判斷

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
    select * from user where
        <if test="username != null">
           username=#{username}
        </if>
        <if test="username != null">
           and sex=#{sex}
        </if>
</select>

這樣寫我們可以看到，如果 sex 等於 null，那麼查詢語句為 select * from user where username=#{username},但是如果usename 為空呢？那麼查詢語句為 select * from user where and sex=#{sex}，這是錯誤的 SQL 語句，如何解決呢？請看下面的 where 語句

2、動態SQL:if+where語句

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
    select * from user
    <where>
        <if test="username != null">
           username=#{username}
        </if>
        <if test="username != null">
           and sex=#{sex}
        </if>
    </where>
</select>

這個“where”標簽會知道如果它包含的標簽中有返回值的話，它就插入一個‘where’。此外，如果標簽返回的內容是以AND 或OR 開頭的，則它會剔除掉。

3、動態SQL:if+set 語句

同理，上面的對於查詢 SQL 語句包含 where 關鍵字，如果在進行更新操作的時候，含有 set 關鍵詞，我們怎麼處理呢？

<!-- 根據 id 更新 user 表的數據 -->
<update id="updateUserById" parameterType="com.ys.po.User">
    update user u
        <set>
            <if test="username != null and username != ''">
                u.username = #{username},
            </if>
            <if test="sex != null and sex != ''">
                u.sex = #{sex}
            </if>
        </set>
     where id=#{id}
</update>

這樣寫，如果第一個條件 username 為空，那麼 sql 語句為：update user u set u.sex=? where id=?

如果第一個條件不為空，那麼 sql 語句為：update user u set u.username = ? ,u.sex = ? where id=?

4、動態SQL:choose(when,otherwise) 語句

有時候，我們不想用到所有的查詢條件，隻想選擇其中的一個，查詢條件有一個滿足即可，使用 choose 標簽可以解決此類問題，類似於 Java 的 switch 語句

<select id="selectUserByChoose" resultType="com.ys.po.User" parameterType="com.ys.po.User">
      select * from user
      <where>
          <choose>
              <when test="id !='' and id != null">
                  id=#{id}
              </when>
              <when test="username !='' and username != null">
                  and username=#{username}
              </when>
              <otherwise>
                  and sex=#{sex}
              </otherwise>
          </choose>
      </where>
  </select>

也就是說，這裡我們有三個條件，id,username,sex，隻能選擇一個作為查詢條件

如果 id 不為空，那麼查詢語句為：select * from user where id=?

如果 id 為空，那麼看username 是否為空，如果不為空，那麼語句為 select * from user whereusername=?;

如果 username 為空，那麼查詢語句為 select * from user where sex=?

5、動態SQL:trim 語句

trim標記是一個格式化的標記，可以完成set或者是where標記的功能

①、用 trim 改寫上面第二點的 if+where 語句

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
        select * from user
        <!-- <where>
            <if test="username != null">
               username=#{username}
            </if>
            <if test="username != null">
               and sex=#{sex}
            </if>
        </where>  -->
        <trim prefix="where" prefixOverrides="and | or">
            <if test="username != null">
               and username=#{username}
            </if>
            <if test="sex != null">
               and sex=#{sex}
            </if>
        </trim>
    </select>

prefix：前綴　　　　　　

prefixoverride：去掉第一個and或者是or

②、用 trim 改寫上面第三點的 if+set語句

<!-- 根據 id 更新 user 表的數據 -->
    <update id="updateUserById" parameterType="com.ys.po.User">
        update user u
            <!-- <set>
                <if test="username != null and username != ''">
                    u.username = #{username},
                </if>
                <if test="sex != null and sex != ''">
                    u.sex = #{sex}
                </if>
            </set> -->
            <trim prefix="set" suffixOverrides=",">
                <if test="username != null and username != ''">
                    u.username = #{username},
                </if>
                <if test="sex != null and sex != ''">
                    u.sex = #{sex},
                </if>
            </trim>
         where id=#{id}
    </update>

suffix：後綴　　

suffixoverride：去掉最後一個逗號（也可以是其他的標記，就像是上面前綴中的and一樣）

6、動態SQL: SQL 片段

有時候可能某個 sql 語句我們用的特別多，為瞭增加代碼的重用性，簡化代碼，我們需要將這些代碼抽取出來，然後使用時直接調用。

比如：假如我們需要經常根據用戶名和性別來進行聯合查詢，那麼我們就把這個代碼抽取出來，如下：

<!-- 定義 sql 片段 -->
<sql id="selectUserByUserNameAndSexSQL">
    <if test="username != null and username != ''">
        AND username = #{username}
    </if>
    <if test="sex != null and sex != ''">
        AND sex = #{sex}
    </if>
</sql>

引用 sql 片段

註意：

①、最好基於 單表來定義 sql 片段，提高片段的可重用性

②、在 sql 片段中最好不要包括 where

7、動態SQL: foreach 語句

需求：我們需要查詢 user 表中 id 分別為1,2,3的用戶

sql語句：

select * from user where id=1 or id=2 or id=3

select * from user where id in (1,2,3)

①、建立一個 UserVo 類，裡面封裝一個 List<Integer> ids 的屬性

package com.ys.vo;
import java.util.List;
public class UserVo {
    //封裝多個用戶的id
    private List<Integer> ids;
    public List<Integer> getIds() {
        return ids;
    }
    public void setIds(List<Integer> ids) {
        this.ids = ids;
    }
}　　

②、我們用 foreach 來改寫select * from user where id=1 or id=2 or id=3

<select id="selectUserByListId" parameterType="com.ys.vo.UserVo" resultType="com.ys.po.User">
    select * from user
    <where>
        <!--
            collection:指定輸入對象中的集合屬性
            item:每次遍歷生成的對象
            open:開始遍歷時的拼接字符串
            close:結束時拼接的字符串
            separator:遍歷對象之間需要拼接的字符串
            select * from user where 1=1 and (id=1 or id=2 or id=3)
          -->
        <foreach collection="ids" item="id" open="and (" close=")" separator="or">
            id=#{id}
        </foreach>
    </where>
</select>

測試：

//根據id集合查詢user表數據
@Test
public void testSelectUserByListId(){
    String statement = "com.ys.po.userMapper.selectUserByListId";
    UserVo uv = new UserVo();
    List<Integer> ids = new ArrayList<>();
    ids.add(1);
    ids.add(2);
    ids.add(3);
    uv.setIds(ids);
    List<User> listUser = session.selectList(statement, uv);
    for(User u : listUser){
        System.out.println(u);
    }
    session.close();
}

③、我們用 foreach 來改寫select * from user where id in (1,2,3)

<select id="selectUserByListId" parameterType="com.ys.vo.UserVo" resultType="com.ys.po.User">
        select * from user
        <where>
            <!--
                collection:指定輸入對象中的集合屬性
                item:每次遍歷生成的對象
                open:開始遍歷時的拼接字符串
                close:結束時拼接的字符串
                separator:遍歷對象之間需要拼接的字符串
                select * from user where 1=1 and id in (1,2,3)
              -->
            <foreach collection="ids" item="id" open="and id in (" close=") " separator=",">
                #{id}
            </foreach>
        </where>
    </select>

8、總結

其實動態 sql 語句的編寫往往就是一個拼接的問題，為瞭保證拼接準確，我們最好首先要寫原生的 sql 語句出來，然後在通過 mybatis 動態sql 對照著改，防止出錯。

本篇文章就到這裡瞭，希望能夠給你帶來幫助，也希望您能夠多多關註WalkonNet的更多內容!

推薦閱讀：