Java / MyBatis where、set、trim

MyBatis where、set、trim

1. 前言

在前面的小节中,我们一起学习了 if 标签,在通过 if 判断动态插入或查询的时候容易产生多余的前缀(如 WHERE)或后缀(如 , ),为了解决这类问题 MyBatis 提供了 where、set、trim 三个实用的标签。

其中 where 和 set 标签都是 trim 标签的一种特殊情况,不过使用频率非常高,因此被单独定义成了标签。本小节我们将一起来学习它们。

2. 定义

慕课解释:wheresettrim 三个标签都是为了解决 MyBatis 在动态生成 SQL 时,产生了多余的前缀和后缀的问题。

3. 实例

3.1 where 实例

<select id="selectUserByIdAndName" resultType="com.imooc.mybatis.model.User">
  SELECT * FROM imooc_user
  <where>
    <if test="id != null">
      id = #{id}
    </if>
    <if test="username != null">
      AND username = #{username}
    </if>
  </where>
</select>

在这个例子中,id 和 username 均非固定的过滤参数,只有当其不为 null 时才会加入到 SQL 语句中。此处 where 标签的作用大概有如下 3 个:

  1. 在 id 和 username 都为空的情况下,where 标签不会产生任何 SQL 代码段,最后的 SQL 语句为:SELECT * FROM imooc_user
  2. 在 id 不为空,username 为空的情况下,或者在 id 不为空,username 也不为空的情况下,where 标签会自动给 SQL 代码段添加上 WHERE 前缀;
  3. 在 id 为空,username 不为空的情况下,where 标签会自定去除 AND 前缀,此时生成的 SQL 语句为: SELECT * FROM imooc_user WHERE username = ?

3.2 set 实例

<update id="updateUsernameAndScoreById">
  UPDATE imooc_user
  <set>
    <if test="username != null">
      username = #{username},
    </if>
    id = #{id}
  </set>
  WHERE id = #{id}
</update>

set 标签会自动在 SQL 语句中添加上相应的 SET 前缀,并根据里面的条件动态地添加相应的字段。

由于 SQL update 的语法问题,若 set 标签里面条件均不满足,此时 set 标签也不会添加上 SET 前缀,但此时 SQL 会报语法错误,所以 set 标签中还是得有一个必然存在的赋值。

3.3 trim 实例

<update id="updateUsernameAndScoreById">
  UPDATE imooc_user
  <trim prefix="SET" suffixOverrides=",">
    <if test="username != null">
      username = #{username},
    </if>
    <if test="id != null">
      id = #{id}
    </if>
  </trim>
  WHERE id = #{id}
</update>

这里的 trim 实例实现了与 set 实例同样的功能,set 标签是 trim 标签的一种特殊情况。

trim 标签共有 4 个属性,它们的作用分别如下:

  • prefix: 前缀属性,若标签内不为空则在 SQL 中添加上前缀;
  • prefixOverrides: 前缀覆盖属性,若标签中有多余的前缀,将会被覆盖(其实就是丢弃该前缀);
  • suffix: 后缀属性,若标签内不为空则在 SQL 中添加上后缀;
  • suffixOverrides: 后缀覆盖属性,若标签中有多余的后缀,将会被覆盖(其实就是丢弃该后缀)。

这个例子中,trim 标签的前缀为SET,后缀覆盖属性为,,所以在标签内不为空的情况下给 SQL 语句添加了 SET 关键字,且标签内若有多余的,后缀也会被丢弃。

4. 实践

4.1 例1. 动态插入用户

请使用 MyBatis 完成对 imooc_user 表动态插入用户的功能,若用户属性值不为 null 则插入该字段,否则不插入字段。

分析:

按照 MyBatis 的开发模式,先在 UserMapper.xml 文件中添加动态插入用户的 insert 标签,然后在 UserMapper.java 中添加上对应的方法。

步骤:

首先,在 UserMapper.xml 中添加 insert 标签,并在标签中写入 SQL,使用 trim 标签来动态判断属性是否为空,若不为空则插入该字段。

<insert id="insertUserDynamic" parameterType="com.imooc.mybatis.model.User">
  INSERT INTO imooc_user
  <trim prefix="(" suffix=")" suffixOverrides=",">
    <if test="username != null">
      username,
    </if>
    <if test="age != null">
      age,
    </if>
    <if test="score != null">
      score,
    </if>
  </trim>
  VALUES
  <trim prefix="(" suffix=")" suffixOverrides=",">
    <if test="username != null">
      #{username},
    </if>
    <if test="age != null">
      #{age},
    </if>
    <if test="score != null">
      #{score},
    </if>
  </trim>
</insert>

这里,我们使用了两个 trim 标签,一个用来动态写入字段名,另一个用来动态写入字段值;trim 标签的前缀为(,后缀为),当出现多余的,时,会通过后缀覆盖属性来丢弃。

然后在 UserMapper.java 中添加上对应的接口方法:

package com.imooc.mybatis.mapper;

import org.apache.ibatis.annotations.Mapper;
import com.imooc.mybatis.model.User;

@Mapper
public interface UserMapper {
   int insertUserDynamic(User user);
}

结果:

通过如下代码,我们运行 insertUserDynamic 这个方法。

UserMapper userMapper = session.getMapper(UserMapper.class);
User user = new User();
user.setUsername("dynamic");
user.setScore(100);
int rows = userMapper.insertUserDynamic(user);
System.out.println(rows);

成功后,结果为:

1

TIPS: 注意,在 username、score 和 age 均为 null 时, insertUserDynamic 会报 SQL 语法错误,但理论上若是所有属性均为空,那么也不应该插入。

5. 小结

  • where、set 以及 trim 将 MyBatis 的动态 SQL 发挥到了极致,为开发者节省了大量的精力和时间。
  • trim 标签是 MyBatis 中最为强大的一个标签,使用它可以方便的完成 SQL 动态插入和动态更新。