MyBatis從入門到精通(七)：MyBatis動態Sql之choose,where,set標籤的用法

時間  2019-12-14
標籤 mybatis 入門 精通 動態 sql choose set 標籤 用法 欄目 MyBatis 简体版
原文   原文鏈接

最近在讀劉增輝老師所著的《MyBatis從入門到精通》一書，頗有收穫，因而將本身學習的過程以博客形式輸出，若有錯誤，歡迎指正，如幫助到你，不勝榮幸！java

本篇博客主要講解如何使用choose,where,set標籤生成動態的Sql。git

1. choose 用法

假設有這樣1個需求：當參數id有值時優先使用id查詢，當id沒有值時就去判斷用戶名是否有值，若是有值就用用戶名查詢，若是沒值，就使查詢無結果。github

首先，咱們在接口SysUserMapper中添加以下方法：sql

/**
 * 根據用戶id或用戶名查詢
 *
 * @param sysUser
 * @return
 */
SysUser selectByIdOrUserName(SysUser sysUser);

而後在對應的SysUserMapper.xml中添加以下代碼：mybatis

<select id="selectByIdOrUserName" resultType="com.zwwhnly.mybatisaction.model.SysUser">
    SELECT  id,
            user_name,
            user_password,
            user_email,
            create_time
    FROM sys_user
    WHERE 1 = 1
    <choose>
        <when test="id != null">
            AND id = #{id}
        </when>
        <when test="userName != null and userName != ''">
            AND user_name = #{userName}
        </when>
        <otherwise>
            AND 1 = 2
        </otherwise>
    </choose>
</select>

注意事項：app

在以上的代碼中，若是沒有otherwise這個限制條件，當id和userName都爲null時，全部的用戶都會被查詢出來，但咱們接口的返回值是SysUser，當查詢結果是多個時就會報錯。添加otherwise條件後，因爲where條件不知足，所以在這種狀況下就查詢不到結果。學習

最後，在SysUserMapperTest測試類中添加以下測試方法：測試

@Test
public void testSelectByIdOrUserName() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        // 按id查詢
        SysUser query = new SysUser();
        query.setId(1L);
        query.setUserName("admin");
        SysUser sysUser = sysUserMapper.selectByIdOrUserName(query);
        Assert.assertNotNull(sysUser);

        // 只按userName查詢
        query.setId(null);
        sysUser = sysUserMapper.selectByIdOrUserName(query);
        Assert.assertNotNull(sysUser);

        // id 和 userName 都爲空
        query.setUserName(null);
        sysUser = sysUserMapper.selectByIdOrUserName(query);
        Assert.assertNull(sysUser);
    } finally {
        sqlSession.close();
    }
}

運行測試代碼，測試經過，輸出日誌以下：日誌

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE 1 = 1 AND id = ?code

DEBUG [main] - ==> Parameters: 1(Long)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 123456, admin@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE 1 = 1 AND user_name = ?

DEBUG [main] - ==> Parameters: admin(String)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 123456, admin@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE 1 = 1 AND 1 = 2

DEBUG [main] - ==> Parameters:

DEBUG [main] - <== Total: 0

2. where 用法

where標籤的做用：若是該標籤包含的元素中有返回值，就插入一個where，若是where後面的字符串是以AND或者OR開頭的，就將它們剔除。

假設有這樣1個需求：根據用戶的輸入條件來查詢用戶列表，若是輸入了用戶名，就根據用戶名模糊查詢，若是輸入了郵箱，就根據郵箱精確查詢，若是同時輸入了用戶名和郵箱，就用這兩個條件去匹配用戶。

首先，咱們在接口SysUserMapper中添加以下方法：

/**
 * 根據動態條件查詢用戶信息(使用Where標籤)
 *
 * @param sysUser
 * @return
 */
List<SysUser> selectByUserWhere(SysUser sysUser);

而後在對應的SysUserMapper.xml中添加以下代碼：

<select id="selectByUserWhere" resultType="com.zwwhnly.mybatisaction.model.SysUser">
    SELECT id,
    user_name,
    user_password,
    user_email,
    create_time
    FROM sys_user
    <where>
        <if test="userName != null and userName != ''">
            AND user_name LIKE CONCAT('%',#{userName},'%')
        </if>
        <if test="userEmail != null and userEmail != ''">
            AND user_email = #{userEmail}
        </if>
    </where>
</select>

當if條件都不知足的時候，where元素中沒有內容，此時的Sql語句不會有where，語法正確。

若是if條件知足，where元素的內容就是以AND開頭的條件，where會自動去掉開頭的and，保證Sql語句的正確。

最後，在SysUserMapperTest測試類中添加以下測試方法：

@Test
public void testSelectByUserWhere() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        // 只按用戶名查詢
        SysUser query = new SysUser();
        query.setUserName("ad");
        List<SysUser> sysUserList = sysUserMapper.selectByUserWhere(query);
        Assert.assertTrue(sysUserList.size() > 0);

        // 只按郵箱查詢
        query = new SysUser();
        query.setUserEmail("test@mybatis.tk");
        sysUserList = sysUserMapper.selectByUserWhere(query);
        Assert.assertTrue(sysUserList.size() > 0);

        // 同時按用戶民和郵箱查詢
        query = new SysUser();
        query.setUserName("ad");
        query.setUserEmail("test@mybatis.tk");
        sysUserList = sysUserMapper.selectByUserWhere(query);
        // 因爲沒有同時符合這兩個條件的用戶，所以查詢結果數爲0
        Assert.assertTrue(sysUserList.size() == 0);
    } finally {
        sqlSession.close();
    }
}

運行測試代碼，測試經過，輸出日誌以下：

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE user_name LIKE CONCAT('%',?,'%')

DEBUG [main] - ==> Parameters: ad(String)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 123456, admin@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE user_email = ?

DEBUG [main] - ==> Parameters: test@mybatis.tk(String)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1001, test, 123456, test@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE user_name LIKE CONCAT('%',?,'%') AND user_email = ?

DEBUG [main] - ==> Parameters: ad(String), test@mybatis.tk(String)

DEBUG [main] - <== Total: 0

3. set 用法

set標籤的做用：若是該標籤包含的元素中有返回值，就插入一個set，若是set後面的字符串是以,結尾的，就將這個逗號剔除。

假設有這樣1個需求：更新用戶信息的時候不能將原來有值但沒有發生變化的字段更新爲空或null，即只更新有值的字段。

首先，咱們在接口SysUserMapper中添加以下方法：

/**
 * 根據主鍵選擇性更新用戶信息(使用Set標籤)
 *
 * @param sysUser
 * @return
 */
int updateByIdSelectiveSet(SysUser sysUser);

而後在對應的SysUserMapper.xml中添加以下代碼：

<update id="updateByIdSelectiveSet">
    UPDATE sys_user
    <set>
        <if test="userName != null and userName != ''">
            user_name = #{userName},
        </if>
        <if test="userPassword != null and userPassword != ''">
            user_password = #{userPassword},
        </if>
        <if test="userEmail != null and userEmail != ''">
            user_email = #{userEmail},
        </if>
        <if test="userInfo != null and userInfo != ''">
            user_info = #{userInfo},
        </if>
        <if test="headImg != null">
            head_img = #{headImg,jdbcType=BLOB},
        </if>
        <if test="createTime != null">
            create_time = #{createTime,jdbcType=TIMESTAMP},
        </if>
        id = #{id},
    </set>
    WHERE id = #{id}
</update>

注意事項：爲了不全部的條件都不知足，生成的Sql語句沒有set標籤，所以在最後加上了id = #{id},這樣必然存在的賦值。

最後，在SysUserMapperTest測試類中添加以下測試方法：

@Test
public void testUpdateByIdSelectiveSet() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        SysUser sysUser = new SysUser();
        // 更新id=1的用戶
        sysUser.setId(1L);
        // 修改郵箱
        sysUser.setUserEmail("test@mybatis.tk");

        int result = sysUserMapper.updateByIdSelectiveSet(sysUser);
        Assert.assertEquals(1, result);

        // 查詢id=1的用戶
        sysUser = sysUserMapper.selectById(1L);
        // 修改後的名字保持不變，可是郵箱變成了新的
        Assert.assertEquals("admin", sysUser.getUserName());
        Assert.assertEquals("test@mybatis.tk", sysUser.getUserEmail());
    } finally {
        sqlSession.close();
    }
}

運行測試代碼，測試經過，輸出日誌以下：

DEBUG [main] - ==> Preparing: UPDATE sys_user SET user_email = ?, id = ? WHERE id = ?

DEBUG [main] - ==> Parameters: test@mybatis.tk(String), 1(Long), 1(Long)

DEBUG [main] - <== Updates: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE id = ?

DEBUG [main] - ==> Parameters: 1(Long)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 123456, test@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

4. 源碼

源碼地址：https://github.com/zwwhnly/mybatis-action.git，歡迎下載。

5. 參考

劉增輝《MyBatis從入門到精通》

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