MyBatis 3手册 MyBatis 3 动态SQL-trim、where、set

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>

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