Liuye Notebook
0%

MyBatis-Dynamic-SQL

发表于 更新于 分类于 ， ， 阅读次数： Valine：

阅读更多

1 概述

MyBatis的动态SQL包括以下几种元素

元素 作用 备注
if 判断语句 单条件分支判断
choose(when、otherwise) 相当于Java中的case when语句 多条件分支判断
trim(where、set) 辅助元素 用于处理一些SQL拼装问题
foreach 循环语句 在in语句等列举条件常用

2 if元素

if元素是最常用的判断语句，相当于Java中的if语句，它常常与test属性联合使用

1
2
3
4
5
6
<select id="findRoles" parameterType="string" resultMap="roleResultMap">
    SELECT role_no, role_name, note FROM t_role WHERE 1=1
    <if test="roleName != null and roleName != ''">
        AND role_name LIKE CONCAT('%', #{roleName}, '%')
    </if>
</select>

3 choose、when、otherwise元素

有时候，if语句不能满足我们的需求，我们还需要第三种选择甚至更多的选择，这时可以使用choose、when、otherwise元素，它相当于Java中的switch-case-default语句

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<select id="findRoles" parameterType="role" resultMap="roleResultMap">
    SELECT role_no, role_name, note FROM t_role
    WHERE 1=1
    <choose>
        <when test="roleNo != null and roleNo != ''">
            AND role_no = #{roleNo}
        </when>
        <when test="roleName != null and roleName != ''">
            AND role_name LIKE CONCAT('%', #{roleName}, '%')
        </when>
        <otherwise>
            AND note IS NOT NULL
        </otherwise>
    </choose>
</select>

4 trim、where、set元素

4.1 where元素

前面的例子中加入了"1=1"这样一个条件，如果没有这个条件，得到的SQL语句是有语法错误的（where后面直接跟了一个and）

我们可以使用where元素，如下

1
2
3
4
5
6
7
8
<select id="findRoles" parameterType="string" resultMap="roleResultMap">
    SELECT role_no, role_name, note FROM t_role
    <where>
        <if test="roleName != null and roleName != ''">
            AND role_name LIKE CONCAT('%', #{roleName}, '%')
        </if>
    </where>
</select>

这样一来，当where元素里面的条件成立时，才会加入where这个SQL关键字到组装的SQL里面，否则就不加入

4.2 trim元素

有时候，我们需要去掉一些特殊的SQL语法，比如常见的and、or，使用trim元素可以达到这个效果。trim元素有如下属性

  1. prefix：添加前缀
  2. prefixOverrides：去掉第一个指定的字符串
  3. suffixoverride：去掉最后一个指定的字符串
  4. suffix：添加后缀
1
2
3
4
5
6
7
8
<select id="findRoles" parameterType="string" resultMap="roleResultMap">
    SELECT role_no, role_name, note FROM t_role
    <trim prefix="where" prefixOverrides="and">
        <if test="roleName != null and roleName != ''">
            AND role_name LIKE CONCAT('%', #{roleName}, '%')
        </if>
    </trim>
</select>

4.3 set元素

在更新数据的时候，我们要根据入参的有效数据（不为null且不为空）的情况来动态地生成update语句，set元素可以帮助我们完成这个需求

  1. set元素会为我们添加关键字SET
  2. set元素会删除生成语句最后面一个逗号
1
2
3
4
5
6
7
8
9
10
11
12
<update id="updateRole" parameterType="role">
    UPDATE t_role
    <set>
        <if test="roleName != null and roleName != ''">
            role_name = #{roleName},
        </if>
        <if test="note != null and note != ''">
            note = #{note},
        </if>
    </set>
    WHERE role_no = #{roleNo}
</update>

当set元素遇到了逗号，它会把对应的逗号去掉

trim元素意味着我们需要去掉一些特殊的字符串，prefix代表的是语句的前缀，而prefixOverrides代表的是你需要去掉的那种字符串

5 foreach元素

foreach元素是一个循环语句，它的作用是遍历集合。它能够很好地支持数组和List、Set接口的集合，对此提供遍历的功能

1
2
3
4
5
6
<select id="findUserBySex" resultType="user">
    SELECT * FROM t_user WHERE sex IN
    <foreach item="sex" index="index" collection="sexList" open="(" separator="," close=")">
        #{sex}
    </foreach>
</select>

其中

  1. collection：传递进来的参数名称，它可以是一个数组或者List、Set等集合
  2. item：循环中当前的元素
  3. index：当前元素在集合的位置下标
  4. open和close：以什么符号将这些元素包装起来
  5. separator：各个元素间的分隔符

6 test的属性

test属性用于条件判断语句中，它在MyBatis中广泛使用。它的作用相当于判断真假。在大部分场景中我们都是用它判断空和非空。有时候需要判断字符串、数字和枚举等

7 参考