mybatis 的动态SQL使用

动态 SQL

动态 SQL 是mybatis一个很强大的特性，咱们常常会由于不一样的条件去拼接sql，一不当心可能就会少了个空格，或是列名后面多了个逗号。利用动态sql能够很灵活的去为咱们拼接sql，且相对简洁清晰。

这里咱们主要来了解下面几个元素：

• if
• choose (when, otherwise)
• trim (where, set)
• foreach

1、if

咱们先看一下语法

<select id="selectUser" resultMap="upmsUser">
    select * from upms_user
    where is_locked = 1
    <if test="loginname != null">
        and loginname like #{loginname}
    </if>
</select>

test 里面是对条件的判断，若里面为 true 的话，便会加上 if 元素里的内容。如上面的loginname不为空的话，sql语句就会是
select * from upms_user where is_locked = 1 and loginname like #{loginname}

test 里面的 与 和 或 不能用 && 和 ||，而是要使用 and 和 or

test 属性值是不能包含 '<' 字符的， 因此判断大小不能用 < 和 <=，用 lt 和 lte 代替。> 和 >= 虽然能够用，但规范起见，最好也用 gt 和 gte 代替

<select id="selectUser" resultMap="upmsUser">
    select * from upms_user
    where is_locked = 1
    <if test="upmsUser.age gte 10 and upmsUser.age lt 20">
        <if test="loginname != null and loginname != '' ">
            and loginname like #{loginname}
        </if>
    </if>
</select>

2、choose (when, otherwise)

有时候咱们只想应用多个条件语句中的一个，咱们就要用到 choose (when, otherwise) 了。它与 java 中的 if...else if...else 和 switch 很像。

<select id="selectUser" resultMap="upmsUser">
    select * from upms_user
    where is_locked = 1
    <choose>
        <when test="loginname != null and loginname != '' ">
            and loginname like #{loginname}
        </when>
        <when test="upmsUser != null and upmsUser.realname != '' ">
            and realname like #{upmsUser.realname}
        </when>
        <otherwise>
            and phone is not null
        </otherwise>
    </choose>
</select>

test属性值的语法和 if 元素的是同样的

3、trim (where, set)

一、where

这里咱们先回到 if 的第一个例子，假如把 is_locked 字段也设为动态的

<select id="selectUser" resultMap="upmsUser">
    select * from upms_user
    where
    <if test="locked != null">
        is_locked = #{locked}
    </if>
    <if test="loginname != null and loginname != '' ">
        and loginname like #{loginname}
    </if>
</select>

若是两个 if 的条件都成立，这时是没有问题的，但有两个状况下会出问题。

1. 若是两个 if 都不成立，sql 语句就会变成
   select * from upms_user where (多了一个where)
2. 若是 locked 为 null，然后面的 if 成立，sql 语句就会变成
   select * from upms_user where and loginname like #{loginname} (多了一个and)

这里其实咱们能够在 where 后面加上一个 1=1，但 mabatis 给了咱们一个更好的解决方法

<select id="selectUser" resultMap="upmsUser">
    select * from upms_user
    <where>
        <if test="locked != null">
            is_locked = #{locked}
        </if>
        <if test="loginname != null and loginname != '' ">
            and loginname like #{loginname}
        </if>
    </where>
</select>

使用 where 元素，它会在没有条件成立时去掉where，在有条件成立的时候检查语句的开头，并去掉多余的 and 或是 or

二、set

一样的道理，咱们在更新数据时使用 if 动态更新语句也可能会出现问题。这里能够使用 set 元素

<update id="updateUser">
  update user
    <set>
      <if test="username != null">username=#{username},</if>
      <if test="password != null">password=#{password},</if>
      <if test="email != null">email=#{email},</if>
      <if test="phone != null">phone=#{phone}</if>
    </set>
  where id=#{id}
</update>

它会删除set语句后面可能会多出来的逗号

三、trim

有时候咱们在其余地方可能也须要相似的功能，去除某些语句开头或结尾多出来的符号或是链接词。这时候咱们能够使用 trim 去定制某些功能

<!-- prefix:前缀词  prefixOverrides:语句前多余要去除的内容   suffixOverrides:语句后多余要去除的内容 -->
<trim prefix="" prefixOverrides="" suffixOverrides="">
  ...
</trim>

这里咱们能够自定义与 where 和 set 元素等价的 trim 元素

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

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

4、foreach

动态 SQL 的另一个经常使用的操做需求是对一个集合进行遍历，一般是在构建 IN 条件语句的时候

<select id="selectUser" resultMap="upmsUser">
    select * from upms_user
    where user_id in
    <foreach item="item" index="index" collection="userIdList"
       open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

collection 表示要遍历的集合或数组，item 表示当前遍历的对象，index 表示当前遍历的序号或键，在元素体内使用的集合项（item）和索引（index）变量。
open、close、separator 能够指定开头与结尾的字符串以及在迭代结果之间放置分隔符

你能够将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象传递给 foreach 做为集合参数。当使用可迭代对象或者数组时，index 是当前迭代的次数，item 的值是本次迭代获取的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值

5、bind

bind 元素能够从 OGNL 表达式中建立一个变量并将其绑定到上下文

<select id="selectUser" resultMap="User">
  <bind name="pattern" value="'%' + user.getLoginname() + '%'" />
  SELECT * FROM upms_user
  WHERE loginname LIKE #{pattern}
</select>