mybatis动态sql总结

前言

平时在开发中，针对动态sql这块目前是薄弱点，本身根据官网在对应项目边测试边写博客，此篇只是为了加深动态sql的熟练度，有不到之处敬请批评指正！

1.if

使用动态 SQL 最多见情景是根据条件包含 where 子句的一部分。好比：

<select id="findActiveBlogWithTitleLike"
     resultType="Blog">
  SELECT * FROM BLOG
  WHERE state = ‘ACTIVE’
  <if test="title != null">
    AND title like #{title}
  </if>
</select>

这条语句提供了可选的查找文本功能。若是不传入 “title”，那么全部处于 “ACTIVE” 状态的 BLOG 都会返回；若是传入了 “title” 参数，那么就会对 “title”
一列进行模糊查找并返回对应的 BLOG 结果（细心的读者可能会发现，“title” 的参数值须要包含查找掩码或通配符字符）。
若是但愿经过 “title” 和 “author” 两个参数进行可选搜索该怎么办呢？首先，我想先将语句名称修改为改名副其实的名称；接下来，只须要加入另外一个条件便可。

<select id="findActiveBlogLike"
     resultType="Blog">
  SELECT * FROM BLOG WHERE state = ‘ACTIVE’
  <if test="title != null">
    AND title like #{title}
  </if>
  <if test="author != null and author.name != null">
    AND author_name like #{author.name}
  </if>
</select>

2. choose、when、otherwise

有时候，咱们不想使用全部的条件，而只是想从多个条件中选择一个使用。针对这种状况，MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。
仍是上面的例子，可是策略变为：传入了 “title” 就按 “title” 查找，传入了 “author” 就按 “author” 查找的情形。若二者都没有传入，
就返回标记为 featured 的 BLOG（这多是管理员认为，与其返回大量的无心义随机 Blog，还不如返回一些由管理员精选的 Blog）。

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

3. trim、where、set

前面几个例子已经方便地解决了一个臭名昭著的动态 SQL 问题。如今回到以前的 “if” 示例，此次咱们将 “state = ‘ACTIVE’” 设置成动态条件，看看会发生什么。

<select id="findActiveBlogLike"
     resultType="Blog">
  SELECT * FROM BLOG
  WHERE
  <if test="state != null">
    state = #{state}
  </if>
  <if test="title != null">
    AND title like #{title}
  </if>
  <if test="author != null and author.name != null">
    AND author_name like #{author.name}
  </if>
</select>

若是没有匹配的条件会怎么样？最终这条 SQL 会变成这样：

SELECT * FROM BLOG
WHERE

这会致使查询失败。若是匹配的只是第二个条件又会怎样？这条 SQL 会是这样:

SELECT * FROM BLOG
WHERE
AND title like ‘someTitle’

这个查询也会失败。这个问题不能简单地用条件元素来解决。这个问题是如此的难以解决，以致于解决过的人不会再想碰到这种问题。
MyBatis 有一个简单且适合大多数场景的解决办法。而在其余场景中，能够对其进行自定义以符合需求。而这，只须要一处简单的改动：

<select id="findActiveBlogLike"
     resultType="Blog">
  SELECT * FROM BLOG
  <where>
    <if test="state != null">
         state = #{state}
    </if>
    <if test="title != null">
        AND title like #{title}
    </if>
    <if test="author != null and author.name != null">
        AND author_name like #{author.name}
    </if>
  </where>
</select>

where 元素只会在子元素返回任何内容的状况下才插入 “WHERE” 子句。并且，若子句的开头为 “AND” 或 “OR”，where 元素也会将它们去除。
若是 where 元素与你指望的不太同样，你也能够经过自定义 trim 元素来定制 where 元素的功能。好比，和 where 元素等价的自定义 trim 元素为：

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

prefixOverrides 属性会忽略经过管道符分隔的文本序列（注意此例中的空格是必要的）。上述例子会移除全部 prefixOverrides 属性中指定的内容，而且插入 prefix 属性中指定的内容。
用于动态更新语句的相似解决方案叫作 set。set 元素能够用于动态包含须要更新的列，忽略其它不更新的列。好比：

<update id="updateAuthorIfNecessary">
  update Author
    <set>
      <if test="username != null">username=#{username},</if>
      <if test="password != null">password=#{password},</if>
      <if test="email != null">email=#{email},</if>
      <if test="bio != null">bio=#{bio}</if>
    </set>
  where id=#{id}
</update>

这个例子中，set 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。
来看看与 set 元素等价的自定义 trim 元素吧：

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

注意，咱们覆盖了后缀值设置，而且自定义了前缀值。

4. foreach

动态 SQL 的另外一个常见使用场景是对集合进行遍历（尤为是在构建 IN 条件语句的时候）。好比：

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

foreach 元素的功能很是强大，它容许你指定一个集合，声明能够在元素体内使用的集合项（item）和索引（index）变量。它也容许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。 这个元素也不会错误地添加多余的分隔符，看它多智能！ 提示 你能够将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象做为集合参数传递给 foreach。当使用可迭代对象或者数组时，index 是当前迭代的序号， item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。 至此，咱们已经完成了与 XML 配置及映射文件相关的讨论。下一章将详细探讨 Java API，以便你能充分利用已经建立的映射配置。