MyBatis 动态 SQL 详解：灵活构建强大查询

MyBatis 的动态 SQL 功能是其最强大的特性之一，它允许开发者根据不同条件动态生成 SQL 语句，极大地提高了 SQL 的灵活性和复用性。本文将深入探讨 MyBatis 的动态 SQL 功能，包括 OGNL 表达式的使用以及各种动态 SQL 元素（如 if、choose、when、foreach 等）的应用场景和示例。

1.动态 SQL 概述

动态 SQL 是 MyBatis 的核心特性之一，它允许在 XML 映射文件或注解中定义灵活的 SQL 语句，根据运行时条件动态生成最终执行的 SQL。常见的应用场景包括：

• 根据不同条件构建 WHERE 子句

• 动态插入或更新字段

• 处理集合参数，实现批量操作

• 构建复杂的查询条件组合

动态 SQL 的核心是通过 OGNL（对象图导航语言）表达式来评估条件，并结合各种动态元素来生成 SQL。

2.OGNL 表达式基础

OGNL（Object Graph Navigation Language）是一种强大的表达式语言，MyBatis 使用它来解析动态 SQL 中的条件表达式。在 MyBatis 中，OGNL 表达式主要用于：

• 访问对象属性：user.username

• 调用方法：list.size()

• 执行逻辑运算：age > 18 && gender == 'M'

• 判断集合是否包含元素：list.contains('value')

示例：

<if test="username != null and username != ''">
    AND username = #{username}
</if>

这里的 test 属性值就是一个 OGNL 表达式，用于判断 username 是否不为空。

3.动态 SQL 元素详解

3.1 <if> 元素

<if> 元素是最基本的动态 SQL 元素，用于条件判断。

示例：

<select id="findUser" parameterType="map" resultType="User">
    SELECT * FROM users
    WHERE 1=1<if test="username != null and username != ''">
        AND username = #{username}</if><if test="age != null and age > 0">
        AND age > #{age}</if>
</select>

这个查询会根据传入的参数动态添加条件。如果 username 不为空，则添加 username 条件；如果 age 不为空且大于 0，则添加 age 条件。

3.2 <choose>、<when>、<otherwise> 元素

<choose> 元素类似于 Java 中的 switch 语句，用于多条件选择。

示例：

<select id="findUser" parameterType="map" resultType="User">
    SELECT * FROM users
    WHERE 1=1<choose><when test="username != null and username != ''">
            AND username = #{username}</when><when test="email != null and email != ''">
            AND email = #{email}</when><otherwise>
            AND age > 18</otherwise></choose>
</select>

这个查询会依次检查条件，一旦某个 <when> 条件满足，就会使用对应的 SQL 片段，其他条件将被忽略。如果所有 <when> 条件都不满足，则使用 <otherwise> 中的 SQL 片段。

3.3 <where> 元素

<where> 元素用于简化 SQL 语句中的 WHERE 子句，它会自动处理 AND 和 OR 前缀。

示例：

<select id="findUser" parameterType="map" resultType="User">
    SELECT * FROM users<where><if test="username != null and username != ''">
            username = #{username}</if><if test="age != null and age > 0">
            AND age > #{age}</if></where>
</select>

如果第一个条件成立，<where> 元素会自动添加 WHERE 关键字；如果后面的条件以 AND 或 OR 开头，<where> 元素会自动去除这些前缀，避免 SQL 语法错误。

3.4 <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><if test="age != null">
            age = #{age}</if></set>
    WHERE id = #{id}
</update>

<set> 元素会自动添加 SET 关键字，并去除最后一个条件后的逗号，确保 SQL 语法正确。

3.5 <foreach> 元素

<foreach> 元素用于遍历集合，常用于 IN 条件或批量操作。

属性说明：

• collection：要遍历的集合，如 List、Array 或 Map。
• item：集合中的元素。
• index：索引，对于 List 和 Array 是位置索引，对于 Map 是键。
• open：开始符号，如 (。
• close：结束符号，如 )。
• separator：分隔符，如 ,。

示例 1：IN 条件

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

示例 2：批量插入

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

3.6 <trim> 元素

<trim> 元素是一个通用的格式化元素，可以用来定制 <where> 和 <set> 元素的功能。

属性说明：

• prefix：添加前缀。
• prefixOverrides：去除前缀。
• suffix：添加后缀。
• suffixOverrides：去除后缀。

替代 <where> 元素：

<trim prefix="WHERE" prefixOverrides="AND |OR ">
    ...
</trim>

替代 <set> 元素：

<trim prefix="SET" suffixOverrides=",">
    ...
</trim>

3.7 <sql> 和 <include> 元素

<sql> 元素用于定义可重用的 SQL 片段，<include> 元素用于引用这些片段。

示例：

<sql id="userColumns">
    id, username, email, age
</sql><select id="findUser" parameterType="int" resultType="User">
    SELECT <include refid="userColumns"/>
    FROM users
    WHERE id = #{id}
</select>

4.动态 SQL 工作流程

下面是一个动态 SQL 执行的流程图，展示了 MyBatis 如何处理动态 SQL：

SQL 执行请求
    |
    v
获取映射文件中的 SQL 模板
    |
    v
解析动态 SQL 元素和 OGNL 表达式
    |
    v
根据条件生成最终 SQL 语句
    |
    v
参数处理和类型转换
    |
    v
执行最终生成的 SQL 语句
    |
    v
返回结果

5.综合示例

下面是一个综合示例，展示如何使用多种动态 SQL 元素构建复杂查询：

<mapper namespace="com.example.mapper.UserMapper"><!-- 定义可重用的列 --><sql id="userColumns">
        id, username, email, age, gender</sql><!-- 复杂查询示例 --><select id="searchUsers" parameterType="map" resultType="User">
        SELECT <include refid="userColumns"/>
        FROM users<where><choose><when test="keyword != null and keyword != ''">
                    (username LIKE CONCAT('%', #{keyword}, '%')
                    OR email LIKE CONCAT('%', #{keyword}, '%'))</when><otherwise>
                    1=1</otherwise></choose><if test="ageRange != null and ageRange.size() == 2">
                AND age BETWEEN #{ageRange[0]} AND #{ageRange[1]}</if><if test="genders != null and genders.size() > 0">
                AND gender IN<foreach item="gender" collection="genders" open="(" separator="," close=")">
                    #{gender}</foreach></if></where><choose><when test="sortField != null and sortField != ''">
                ORDER BY ${sortField}<if test="sortOrder != null and sortOrder != ''">
                    ${sortOrder}</if></when><otherwise>
                ORDER BY id DESC</otherwise></choose><if test="offset != null and limit != null">
            LIMIT #{offset}, #{limit}</if></select><!-- 动态更新示例 --><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><if test="age != null">
                age = #{age},</if><if test="gender != null and gender != ''">
                gender = #{gender}</if></set>
        WHERE id = #{id}</update><!-- 批量插入示例 --><insert id="batchInsert" parameterType="list">
        INSERT INTO users (username, email, age, gender)
        VALUES<foreach item="user" collection="list" separator=",">
            (#{user.username}, #{user.email}, #{user.age}, #{user.gender})</foreach></insert>
</mapper>

6.动态 SQL 最佳实践

1. 保持表达式简洁：避免在 OGNL 表达式中编写复杂的逻辑，保持表达式简单易懂。

2. 合理使用 <where> 和 <set>：它们可以自动处理 SQL 语法问题，减少错误。

3. 使用 <sql> 和 <include> 提高复用性：将常用的 SQL 片段提取出来，便于维护。

4. 谨慎使用 ${}：${} 会直接替换参数，存在 SQL 注入风险，应尽量使用 #{}。

5. 避免过度复杂的动态 SQL：如果动态 SQL 过于复杂，考虑拆分成多个简单的 SQL 语句。

6. 测试动态 SQL：由于动态 SQL 的灵活性，建议编写单元测试确保各种条件下生成的 SQL 正确。

7.总结

MyBatis 的动态 SQL 功能通过 OGNL 表达式和各种动态元素，为开发者提供了强大而灵活的 SQL 构建能力。无论是简单的条件查询，还是复杂的批量操作，动态 SQL 都能轻松应对。通过合理使用动态 SQL，可以提高 SQL 的复用性和可维护性，减少重复代码，使数据库操作更加高效。

在实际开发中，需要根据业务需求选择合适的动态 SQL 元素，遵循最佳实践，避免陷入过度复杂的动态 SQL 陷阱。掌握动态 SQL 的使用，是成为一名高效的 MyBatis 开发者的关键一步。