MyBatis动态 SQL

MyBatis 的动态 SQL 是其核心特性之一，通过动态生成 SQL 语句，满足复杂的查询条件和业务逻辑。MyBatis 使用 XML 配置文件中的标签，如 <if>、<choose>、<when>、<foreach> 等，来实现条件判断、循环、拼接等功能。相比于传统的 SQL 语句，动态 SQL 提供了更大的灵活性，能够根据不同的条件自动生成所需的 SQL 语句。

一、动态 SQL 的作用

在实际开发中，数据库查询需求往往是复杂多变的，简单的静态 SQL 很难覆盖各种场景。动态 SQL 允许我们根据传入的参数或条件，动态生成 SQL 语句，从而满足不同的查询需求。通过动态 SQL，我们可以：

1. 实现条件查询：根据条件拼接 SQL 语句，生成不同的查询语句。
2. 避免冗余的 SQL 代码：动态 SQL 可以减少大量重复的代码，提高开发效率。
3. 简化 SQL 逻辑：通过灵活的 XML 标签，简化复杂的 SQL 逻辑。
4. 提高 SQL 可读性：相比手动拼接 SQL 语句，动态 SQL 更具可读性。

二、常用的动态 SQL 标签

MyBatis 提供了一些常用的动态 SQL 标签，帮助开发者动态生成 SQL 语句。以下是常用标签及其用法。

1. <if> 标签

<if> 标签用于判断条件，只有当条件为真时，SQL 语句才会包含该部分内容。常用于条件查询。

<select id="findUsers" resultType="User">
    SELECT * FROM users
    <where>
        <if test="name != null">
            AND name = #{name}
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
</select>

在这个示例中，SQL 语句会根据传入的 name 和 email 参数决定是否包含相应的条件。如果 name 为 null，则 AND name = #{name} 不会出现在生成的 SQL 语句中。

2. <choose>、<when> 和 <otherwise> 标签

这些标签类似于 Java 中的 switch 语句，用于在多个条件中进行选择。<when> 定义条件，<otherwise> 定义默认的处理逻辑。

<select id="findUsersByStatus" resultType="User">
    SELECT * FROM users
    <where>
        <choose>
            <when test="status == 'ACTIVE'">
                AND status = 'ACTIVE'
            </when>
            <when test="status == 'INACTIVE'">
                AND status = 'INACTIVE'
            </when>
            <otherwise>
                AND status IS NOT NULL
            </otherwise>
        </choose>
    </where>
</select>

这里，SQL 会根据 status 参数的值选择不同的 AND 条件。如果 status 既不是 'ACTIVE' 也不是 'INACTIVE'，则默认条件 AND status IS NOT NULL 会生效。

3. <where> 标签

<where> 标签用于自动添加 WHERE 关键字。如果标签内部没有条件，它会自动忽略 WHERE。同时，<where> 标签可以智能地处理条件之间的 AND 或 OR。

<select id="findUsers" resultType="User">
    SELECT * FROM users
    <where>
        <if test="name != null">
            name = #{name}
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
</select>

当只有 email 参数不为空时，生成的 SQL 会自动变为：

SELECT * FROM users WHERE email = ?

<where> 标签能够自动处理 AND 的拼接，避免 SQL 语句错误。

4. <set> 标签

<set> 标签用于动态生成 UPDATE 语句中的 SET 子句。它会自动去除最后多余的逗号。

<update id="updateUser" parameterType="User">
    UPDATE users
    <set>
        <if test="name != null">
            name = #{name},
        </if>
        <if test="email != null">
            email = #{email},
        </if>
        <if test="status != null">
            status = #{status},
        </if>
    </set>
    WHERE id = #{id}
</update>

即使部分字段为空，<set> 标签也能确保 SET 子句的正确性，避免多余的逗号。

5. <foreach> 标签

<foreach> 标签用于遍历集合，常用于 IN 查询或批量插入操作。它支持 List、Map、数组等多种集合类型。

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

这里，<foreach> 标签会遍历传入的 list 集合，并将每个 id 依次拼接到 IN 语句中。如果传入的 list 是 [1, 2, 3]，则生成的 SQL 语句为：

SELECT * FROM users WHERE id IN (1, 2, 3)

6. <trim> 标签

<trim> 标签用于自定义 SQL 语句的前后缀，并可以删除多余的分隔符。它可以替代 <where> 和 <set> 标签，灵活处理复杂的 SQL 片段。

<trim prefix="WHERE" prefixOverrides="AND |OR">
    <if test="name != null">
        AND name = #{name}
    </if>
    <if test="email != null">
        AND email = #{email}
    </if>
</trim>

<trim> 标签的 prefixOverrides="AND |OR" 属性会自动去除条件开头多余的 AND 或 OR，确保生成的 SQL 语法正确。

三、动态 SQL 实际应用场景

1. 多条件查询

动态 SQL 最常见的应用场景是多条件查询。用户可能只输入部分查询条件，我们可以根据传入的参数动态生成 SQL，而不是为每种组合都编写一个 SQL 语句。

<select id="findUsers" resultType="User">
    SELECT * FROM users
    <where>
        <if test="name != null and name != ''">
            AND name LIKE CONCAT('%', #{name}, '%')
        </if>
        <if test="email != null and email != ''">
            AND email = #{email}
        </if>
        <if test="status != null">
            AND status = #{status}
        </if>
    </where>
</select>

根据传入的 name、email 和 status，SQL 会动态生成对应的查询语句，确保查询灵活性。

2. 动态更新

在更新操作中，往往只有部分字段需要更新。动态 SQL 可以根据非空字段生成 UPDATE 语句，避免不必要的更新操作。

<update id="updateUser" parameterType="User">
    UPDATE users
    <set>
        <if test="name != null">
            name = #{name},
        </if>
        <if test="email != null">
            email = #{email},
        </if>
        <if test="status != null">
            status = #{status},
        </if>
    </set>
    WHERE id = #{id}
</update>

如果传入的 User 对象中只有 name 和 email 字段不为空，那么最终生成的 SQL 会只更新这两个字段，而不是更新所有字段。

3. 批量插入

批量插入也是动态 SQL 的常见场景之一。<foreach> 标签可以轻松实现批量插入操作。

<insert id="batchInsertUsers">
    INSERT INTO users (name, email)
    VALUES
    <foreach collection="list" item="user" separator=",">
        (#{user.name}, #{user.email})
    </foreach>
</insert>

通过遍历 list 集合，可以实现批量插入用户数据，生成的 SQL 类似于：

INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com'), ('Bob', 'bob@example.com')

4. 动态 IN 查询

在 IN 查询中，条件的数量是动态变化的，使用 <foreach> 标签可以灵活处理 IN 子句。

<select id="findUsersByIds" resultType="User">
    SELECT * FROM users WHERE id IN
    <foreach collection="list" item

="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

该 SQL 语句根据传入的 id 列表生成不同数量的 IN 子句，避免手动拼接 SQL。

四、动态 SQL 使用的注意事项

1. 防止 SQL 注入 ：使用动态 SQL 时要特别注意防止 SQL 注入攻击，确保所有的输入参数都使用 #{} 占位符，而不是直接拼接 SQL。

2. 适度使用动态 SQL：动态 SQL 提供了极大的灵活性，但应避免过度使用，特别是在业务逻辑过于复杂时，代码的可读性和维护性可能受到影响。

3. 合理设计查询条件：对于频繁使用的查询条件，建议在动态 SQL 中合理设计，避免生成过于复杂和冗长的 SQL 语句。

五、总结

MyBatis 的动态 SQL 是其核心优势之一，能够根据传入的参数动态生成 SQL，满足复杂多变的查询和更新需求。通过 <if>、<choose>、<foreach> 等标签，开发者可以高效地实现条件查询、批量插入、动态更新等操作。动态 SQL 提升了代码的灵活性和可维护性，使得 MyBatis 能够适应更多复杂场景。