写点什么

MyBatis 的动态 SQL 超详细讲解

作者:顾言
  • 2022 年 5 月 03 日
  • 本文字数:2148 字

    阅读完需:约 7 分钟

概述

动态 SQL 是 MyBatis 的强大的特性之一。如果你使用过 JDBC 或其它类似的框架,应该能感受到拼接 SQL 语句的麻烦。例如拼接时要确保不能忘记添加必要的空格,还要注意去掉列表最后一个列名的逗号。


使用动态 SQL,MyBatis 帮助我们避免了这些问题。MyBatis 的动态 SQL 标签有如下 4 种:

  • if

  • choose(when、otherwise)

  • trim(where、set)

  • foreach


接下来逐个讲解。

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'参数,只返回 state = ‘ACTIVE’的数据;如果传入了‘title’参数,那么就会对 “title” 一列进行模糊查找并返回对应的 BLOG 结果。


如果我们想再加入一个条件呢?直接在后面的语句拼接即可。

<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>
复制代码

choose(when、otherwise)

有时候,我们不想使用所有的条件,只想使用其中的一个条件去查找,MyBatis 提供 choose 标签,有点像 Java 中的 switch 语句。


还是上面的例子,我们改为传入 ‘title’就按‘title’查找,传入‘author'就按‘author’查找,都没有传入,就按默认的条件查找。

<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>
复制代码

trim(where、set)

现在回到之前的 “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 BLOGWHERE
复制代码

这会导致查询失败。如果匹配的只是第二个条件又会怎样?这条 SQL 会是这样:

SELECT * FROM BLOGWHEREAND title like ‘someTitle’
复制代码

这个查询也会失败。


简单的条件判断没法解决上面的问题,MyBatis 提供了 where 标签来解决。

<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>
复制代码

用于动态更新语句的类似解决方案叫做 setset 元素可以用于动态包含需要更新的列,忽略其它不更新的列。比如:

<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>
复制代码

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

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>
复制代码


你可以将任何可迭代对象(如 List、Set 等)、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时,index 是当前迭代的序号,item 的值是本次迭代获取到的元素。当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是键,item 是值。

发布于: 刚刚阅读数: 4
用户头像

顾言

关注

技术发烧友 2018.07.20 加入

还未添加个人简介

评论

发布
暂无评论
MyBatis 的动态 SQL超详细讲解_mybatis_顾言_InfoQ写作社区