2.4 动态 SQL

2.4 动态 SQL

MyBatis 动态 SQL 深入详解

2.4.1 动态 SQL 的必要性

在实际的开发过程中，我们经常会遇到需要根据不同的条件来查询或者更新数据库的情况。例如，根据用户的姓名、年龄、性别等条件来查询用户列表，或者根据用户的 ID 来更新用户的某些字段。如果使用静态 SQL，就需要编写大量的 SQL 语句来处理不同的情况，这不仅会增加代码的复杂性，还会降低代码的可维护性。

动态 SQL 的出现正是为了解决这个问题。它允许我们使用一些特殊的标签来定义 SQL 语句，并在运行时根据不同的条件来动态地生成 SQL 语句。这样，我们就可以用更少的代码来处理更多的场景，从而提高代码的效率和可维护性。

2.4.2 动态 SQL 的组成部分

MyBatis 的动态 SQL 主要由以下几个部分组成：

• if 标签: 用于判断条件是否成立，如果条件成立，则将标签内的 SQL 片段添加到最终的 SQL 语句中。

• choose (when, otherwise) 标签: 类似于 Java 中的 switch 语句，用于根据不同的条件选择不同的 SQL 片段。

• trim (where, set) 标签: 用于去除 SQL 语句中多余的前缀或后缀，例如 WHERE 子句中的 AND 或 OR，SET 子句中的逗号。

• foreach 标签: 用于循环遍历集合，并将集合中的元素添加到 SQL 语句中。

下面将逐一介绍这些标签的使用方法和示例。

2.4.3 if 标签

if 标签是最常用的动态 SQL 标签之一，它用于判断条件是否成立，如果条件成立，则将标签内的 SQL 片段添加到最终的 SQL 语句中。

示例：

假设我们有一个 User 类，包含 id、username 和 email 属性。我们需要根据 username 和 email 来查询用户。

public class User {
    private Integer id;
    private String username;
    private String email;
    // 省略 getter 和 setter 方法
}
​

对应的 Mapper 接口：

public interface UserMapper {
    List<User> findUsers(User user);
}
​

对应的 Mapper XML 文件：

<select id="findUsers" parameterType="User" resultType="User">
    SELECT * FROM users
    <where>
        <if test="username != null and username != ''">
            AND username LIKE #{username}
        </if>
        <if test="email != null and email != ''">
            AND email = #{email}
        </if>
    </where>
</select>
​

代码详解：

• <select> 标签定义了一个查询语句，id 属性指定了该语句的唯一标识符，parameterType 属性指定了该语句的参数类型，resultType 属性指定了该语句的返回类型。

• <where> 标签用于包裹 WHERE 子句，它可以自动去除 WHERE 子句中多余的 AND 或 OR。

• <if> 标签用于判断条件是否成立，test 属性指定了判断条件，如果条件成立，则将标签内的 SQL 片段添加到最终的 SQL 语句中。

• #{username} 和 #{email} 是占位符，MyBatis 会将它们替换为实际的参数值。

graph TD 图示：

2.4.4 choose (when, otherwise) 标签

choose 标签类似于 Java 中的 switch 语句，用于根据不同的条件选择不同的 SQL 片段。它包含 when 和 otherwise 两个子标签，when 标签用于判断条件是否成立，如果条件成立，则将标签内的 SQL 片段添加到最终的 SQL 语句中。otherwise 标签用于定义默认的 SQL 片段，如果没有 when 标签的条件成立，则将 otherwise 标签内的 SQL 片段添加到最终的 SQL 语句中。

示例：

假设我们需要根据 username、email 或者 id 来查询用户。

<select id="findUsersByChoose" parameterType="User" resultType="User">
    SELECT * FROM users
    <where>
        <choose>
            <when test="username != null and username != ''">
                username LIKE #{username}
            </when>
            <when test="email != null and email != ''">
                email = #{email}
            </when>
            <otherwise>
                id = #{id}
            </otherwise>
        </choose>
    </where>
</select>
​

代码详解：

• <choose> 标签用于定义一个选择语句。

• <when> 标签用于判断条件是否成立，test 属性指定了判断条件，如果条件成立，则将标签内的 SQL 片段添加到最终的 SQL 语句中。

• <otherwise> 标签用于定义默认的 SQL 片段，如果没有 when 标签的条件成立，则将 otherwise 标签内的 SQL 片段添加到最终的 SQL 语句中。

graph TD 图示：

2.4.5 trim (where, set) 标签

trim 标签用于去除 SQL 语句中多余的前缀或后缀，例如 WHERE 子句中的 AND 或 OR，SET 子句中的逗号。where 和 set 标签是 trim 标签的特殊形式，它们分别用于处理 WHERE 子句和 SET 子句。

示例：

假设我们需要根据 username 和 email 来更新用户的信息。

<update id="updateUser" parameterType="User">
    UPDATE users
    <set>
        <if test="username != null and username != ''">
            username = #{username},
        </if>
        <if test="email != null and email != ''">
            email = #{email},
        </if>
    </set>
    WHERE id = #{id}
</update>
​

上面的代码中，如果在 username 和 email 都为空的情况下，SET 子句会变成空，导致 SQL 语句出错。为了解决这个问题，可以使用 set 标签来去除 SET 子句中多余的逗号。

<update id="updateUser" parameterType="User">
    UPDATE users
    <set>
        <if test="username != null and username != ''">
            username = #{username},
        </if>
        <if test="email != null and email != ''">
            email = #{email},
        </if>
    </set>
    WHERE id = #{id}
</update>
​

set 标签会自动去除 SET 子句中多余的逗号。

trim 标签也可以用于处理 WHERE 子句中的 AND 或 OR。例如：

<select id="findUsersByTrim" parameterType="User" resultType="User">
    SELECT * FROM users
    <trim prefix="WHERE" prefixOverrides="AND |OR">
        <if test="username != null and username != ''">
            AND username LIKE #{username}
        </if>
        <if test="email != null and email != ''">
            OR email = #{email}
        </if>
    </trim>
</select>
​

代码详解：

• prefix="WHERE" 指定了要添加的前缀。

• prefixOverrides="AND |OR" 指定了要去除的前缀。

上面的代码中，trim 标签会自动添加 WHERE 前缀，并去除 AND 或 OR 前缀。

2.4.6 foreach 标签

foreach 标签用于循环遍历集合，并将集合中的元素添加到 SQL 语句中。它通常用于 IN 子句中。

示例：

假设我们需要根据一组 ID 来查询用户。

public interface UserMapper {
    List<User> findUsersByIds(List<Integer> ids);
}
​

<select id="findUsersByIds" parameterType="java.util.List" resultType="User">
    SELECT * FROM users
    WHERE id IN
    <foreach item="id" collection="list" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>
​

代码详解：

• item="id" 指定了集合中元素的变量名。

• collection="list" 指定了要遍历的集合，如果参数是 List 类型，则使用 "list"，如果参数是数组类型，则使用 "array"。

• open="(" 指定了循环开始时的字符串。

• separator="," 指定了循环元素之间的分隔符。

• close=")" 指定了循环结束时的字符串。

graph TD 图示：

2.4.7 总结

MyBatis 的动态 SQL 是一个非常强大的工具，它可以帮助我们编写更加灵活和可维护的 SQL 语句。 本文详细介绍了 MyBatis 的动态 SQL 的各个组成部分，包括 if、choose、trim 和 foreach 标签，并提供了详细的代码示例和图示。掌握这些动态 SQL 标签的使用方法，可以极大地提高你的 MyBatis 开发效率。

通过熟练运用这些动态 SQL 标签，你可以根据不同的业务需求，灵活地生成不同的 SQL 语句，从而提高代码的效率和可维护性。希望这篇文章能够帮助你更好地理解和使用 MyBatis 的动态 SQL。