Mybatis Mapper的动态SQL语句问题、if-else、choose、when、foreach

比眉伴天荒 2022-12-23 09:57 259阅读 0赞

### 文章目录 ###

*  Mybatis Mapper的动态SQL语句问题
 *   *  一、if
     *  二、choose、when、otherwise
     *  三、where
     *  四、trim 元素来定制 where 元素的功能
     *  五、set 动态地在行首插入 SET 关键字
     *  六、foreach
     *  七、script
     *  八、bind
 *  应用举例
 *   *  1、Mybatis Mapper中字符串if判断
     *  2、MyBatis Mapper中的if-else判断

内容来自mybatis官网，此处做学习记录，了解更多：[Mybatis官网][Mybatis]

# Mybatis Mapper的动态SQL语句问题 #

## 一、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” 和 “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>

## 二、choose、when、otherwise ##

有时候，我们不想使用所有的条件，而只是想从多个条件中选择一个使用。

MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。

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

传入了 “title” 就按 “title” 查找，传入了 “author” 就按 “author” 查找的情形。若两者都没有传入，就返回标记为 featured 的 BLOG

## 三、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>
    </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` 元素也会将它们去除。

## 四、trim 元素来定制 where 元素的功能 ##

如果 *where* 元素与你期望的不太一样，你也可以通过自定义 trim 元素来定制 *where* 元素的功能。比如，和 *where* 元素等价的自定义 trim 元素为：

prefixOverrides 属性会忽略通过管道符分隔的文本序列**注意此例中的空格是必要的**。

上述例子会移除所有 *prefixOverrides* 属性中指定的内容，并且插入 *prefix* 属性中指定的内容。

## 五、set 动态地在行首插入 SET 关键字 ##

*set* 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）

与 *set* 元素等价的自定义 *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>

*foreach* 元素允许你指定一个集合，元素体内使用的集合项（item）和索引（index）变量。

它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。

你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为集合参数传递给 *foreach*。

*  当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。
 *  当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。

## 七、script ##

要在带注解的映射器接口类中使用动态 SQL，可以使用 *script* 元素。比如:

@Update({ "<script>",
          "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}",
          "</script>"})
        void updateAuthorValues(Author author);

## 八、bind ##

`bind` 元素允许你在 OGNL 表达式以外创建一个变量，并将其绑定到当前的上下文。比如：

<select id="selectBlogsLike" resultType="Blog">
      <bind name="pattern" value="'%' + _parameter.getTitle() + '%'" />
      SELECT * FROM BLOG
      WHERE title LIKE #{pattern}
    </select>

# 应用举例 #

## 1、Mybatis Mapper中字符串if判断 ##

<test="sex =='Y'.toString()">
        或者
    <test = 'sex == "Y"'>

<if test="companyId != null and companyId !='' ">  
    	<if test="companyFlag == '1'.toString() ">   
    		AND COMPANY_ID = #{companyId,jdbcType=VARCHAR}  
    	</if>  
    
    	<if test="companyFlag == '0'.toString() ">   
    		AND COMPANY_ID != #{companyId,jdbcType=VARCHAR}  
    	</if> 
    </if>

不能使用

因为mybatis会把’jack’解析为字符，java是强类型语言，所以不能这样写。

## 2、MyBatis Mapper中的if-else判断 ##

在MyBatis的Mapper中是不支持if-else语句，如下：

if( condition ) { 
        // ...
    } else { 
        // ...
    }

我们可以通过choose（即Java的switch语句）语句来进行替换。choose语句的语法如下：

<choose>
        <when test="测试条件">
            你的SQL语句1
        </when>
        <otherwise>
            所有when都没有匹配的默认SQL语句
        </otherwise>
    </choose>

其中：

*  when 表示一个if语句
 *  otherwise 表示if语句的else语句

[Mybatis]: https://mybatis.org/mybatis-3/zh/getting-started.html