MyBatis动态标签详解与应用实践举例

2026-01-26 09:28:57 作者：J_liaty

MyBatis的动态SQL功能通过一组强大的标签实现,使得根据业务条件构建灵活SQL查询变得简单高效,这些标签基于OGNL表达式,能够智能生成SQL,避免了手动拼接SQL的复杂性和风险,感兴趣的朋友跟随小编一起看看吧

引言

MyBatis作为一款优秀的持久层框架，其最强大的特性之一就是动态SQL功能。在实际开发中，我们经常需要根据不同的业务条件构建灵活的SQL查询，比如多条件搜索、动态更新字段、批量操作等场景。如果使用传统的JDBC方式手动拼接SQL，不仅代码冗余、维护困难，还容易出现SQL语法错误和注入风险。

MyBatis通过提供一组功能强大的动态标签，让我们能够以声明式的方式动态构建SQL语句，极大地提升了开发效率和代码质量。这些标签基于OGNL表达式实现，能够根据运行时条件智能生成SQL，避免了手动拼接SQL的复杂性和风险。

核心标签详解

1. <if> 标签

功能说明：
<if>标签是最基础的条件判断标签，根据test属性中的OGNL表达式结果决定是否包含对应的SQL片段。

完整示例：

<select id="findUserByCondition" resultType="User">
    SELECT * FROM user
    WHERE 1=1
    <if test="username != null and username != ''">
        AND username LIKE CONCAT('%', #{username}, '%')
    </if>
    <if test="age != null">
        AND age = #{age}
    </if>
    <if test="email != null and email != ''">
        AND email = #{email}
    </if>
</select>

注意事项：

数值类型判断时，只需要判断是否为null，不要判断是否等于空字符串
字符串类型需要同时判断null和空字符串
多个if标签拼接时要注意AND/OR的处理，建议配合where标签使用

2. <where> 标签

功能说明：
<where>标签智能处理WHERE子句，只有在内部有条件时才插入WHERE关键字，并且自动去除开头多余的AND或OR，避免了"WHERE 1=1"这种写法。

完整示例：

<select id="findUserSmart" resultType="User">
    SELECT * FROM user
    <where>
        <if test="username != null and username != ''">
            AND username LIKE CONCAT('%', #{username}, '%')
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
        <if test="status != null">
            AND status = #{status}
        </if>
    </where>
</select>

注意事项：

只能去除开头的AND/OR，无法处理末尾的多余字符
当所有条件都为空时，不会生成WHERE子句
内部的条件建议都加上AND或OR前缀

3. <choose>、<when>、<otherwise> 标签

功能说明：
这组标签类似于Java中的switch-case语句，实现多条件分支选择。按顺序判断when条件，一旦某个条件满足就执行对应分支，都不满足时执行otherwise。

完整示例：

<select id="findUserByPriority" resultType="User">
    SELECT * FROM user
    <where>
        <choose>
            <when test="username != null and username != ''">
                AND username = #{username}
            </when>
            <when test="email != null and email != ''">
                AND email = #{email}
            </when>
            <otherwise>
                AND status = 'ACTIVE'
            </otherwise>
        </choose>
    </where>
</select>

注意事项：

when条件是按顺序判断的，只执行第一个满足条件的分支
otherwise是可选的，类似于default分支
适合互斥条件的场景，避免多个if嵌套

4. <set> 标签

功能说明：
<set>标签专门用于UPDATE语句，智能处理SET关键字，自动去除末尾多余的逗号。

完整示例：

<update id="updateUserSelective" parameterType="User">
    UPDATE user
    <set>
        <if test="username != null and username != ''">
            username = #{username},
        </if>
        <if test="password != null and password != ''">
            password = #{password},
        </if>
        <if test="age != null">
            age = #{age},
        </if>
        <if test="email != null">
            email = #{email},
        </if>
        <if test="status != null">
            status = #{status},
        </if>
    </set>
    WHERE id = #{id}
</update>

注意事项：

每个if条件后都要加逗号
至少要有一个字段被更新，否则SQL语法错误
WHERE条件不要放在set标签内部

5. <trim> 标签

功能说明：
<trim>标签是最灵活的字符串处理标签，可以自定义添加或删除SQL片段的前缀、后缀。

属性说明：

prefix：添加前缀
suffix：添加后缀
prefixOverrides：去除指定的前缀字符
suffixOverrides：去除指定的后缀字符

完整示例：

<!-- 替代where标签 -->
<select id="findUserByTrim" resultType="User">
    SELECT * FROM user
    <trim prefix="WHERE" prefixOverrides="AND |OR ">
        <if test="username != null">
            AND username = #{username}
        </if>
        <if test="age != null">
            OR age = #{age}
        </if>
    </trim>
</select>
<!-- 替代set标签 -->
<update id="updateUserByTrim" parameterType="User">
    UPDATE user
    <trim prefix="SET" suffixOverrides=",">
        <if test="username != null">username = #{username},</if>
        <if test="age != null">age = #{age},</if>
        <if test="email != null">email = #{email},</if>
    </trim>
    WHERE id = #{id}
</update>

注意事项：

prefixOverrides中的多个字符之间要用空格分隔（如"AND |OR "）
可以实现where和set标签的所有功能
注意空格的处理，避免SQL语法错误

6. <foreach> 标签

功能说明：
<foreach>标签用于遍历集合，常用于IN查询、批量插入、批量删除等场景。

属性说明：

collection：集合参数名
item：当前迭代元素的变量名
index：当前迭代索引（可选）
open：遍历开始时的字符串
close：遍历结束时的字符串
separator：元素之间的分隔符

完整示例：

<!-- IN查询 -->
<select id="findUserByIds" resultType="User">
    SELECT * FROM user
    WHERE id IN
    <foreach collection="ids" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>
<!-- 批量插入 -->
<insert id="batchInsertUsers">
    INSERT INTO user (username, age, email) VALUES
    <foreach collection="users" item="user" separator=",">
        (#{user.username}, #{user.age}, #{user.email})
    </foreach>
</insert>
<!-- 批量删除 -->
<delete id="batchDeleteUsers">
    DELETE FROM user
    WHERE id IN
    <foreach collection="idList" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</delete>

注意事项：

List集合默认collection名为"list"或"collection"
数组默认collection名为"array"
使用@Param注解可以自定义collection名称
注意批量操作的数据量，避免SQL过长

7. <bind> 标签

功能说明：
<bind>标签用于创建一个变量并绑定到上下文中，常用于预处理参数，比如模糊查询的通配符拼接。

完整示例：

<select id="findUserByPattern" resultType="User">
    <bind name="pattern" value="'%' + username + '%'" />
    SELECT * FROM user
    WHERE username LIKE #{pattern}
</select>
<select id="findUserByDateRange" resultType="User">
    <bind name="startDate" value="startDate + ' 00:00:00'" />
    <bind name="endDate" value="endDate + ' 23:59:59'" />
    SELECT * FROM user
    WHERE create_time BETWEEN #{startDate} AND #{endDate}
</select>

注意事项：

可以使用OGNL表达式进行复杂的计算
创建的变量只在当前SQL语句中有效
适合复杂的字符串处理和日期处理

8. <sql> 和 <include> 标签

功能说明：
这组标签用于定义可重用的SQL片段，提高代码复用性和维护性。

完整示例：

<!-- 定义可复用的SQL片段 -->
<sql id="userBaseColumns">
    id, username, password, age, email, status, create_time, update_time
</sql>
<sql id="userBaseQuery">
    SELECT <include refid="userBaseColumns" />
    FROM user
</sql>
<!-- 使用SQL片段 -->
<select id="findAllUsers" resultType="User">
    <include refid="userBaseQuery" />
    WHERE status = 'ACTIVE'
</select>
<select id="findUserById" resultType="User">
    <include refid="userBaseQuery" />
    WHERE id = #{id}
</select>
<!-- 带参数的SQL片段 -->
<sql id="userCondition">
    <if test="username != null and username != ''">
        AND username LIKE CONCAT('%', #{username}, '%')
    </if>
    <if test="status != null">
        AND status = #{status}
    </if>
</sql>
<select id="searchUsers" resultType="User">
    <include refid="userBaseQuery" />
    <where>
        <include refid="userCondition" />
    </where>
</select>

注意事项：

SQL片段可以包含动态标签
可以嵌套使用include标签
合理提取公共SQL片段，避免过度抽象

综合案例

用户查询综合案例

下面是一个包含多个动态标签组合使用的完整示例，展示了实际开发中的应用场景：

<!-- 用户综合查询接口 -->
<select id="findUsersComprehensive" resultType="User">
    SELECT
        u.id, u.username, u.age, u.email, u.status,
        u.create_time, u.update_time
    FROM user u
    <where>
        <!-- 基础条件 -->
        <if test="username != null and username != ''">
            AND u.username LIKE CONCAT('%', #{username}, '%')
        </if>
        <!-- 状态多选 -->
        <if test="statusList != null and statusList.size() > 0">
            AND u.status IN
            <foreach collection="statusList" item="status" open="(" separator="," close=")">
                #{status}
            </foreach>
        </if>
        <!-- 年龄范围 -->
        <if test="minAge != null">
            AND u.age >= #{minAge}
        </if>
        <if test="maxAge != null">
            AND u.age <= #{maxAge}
        </if>
        <!-- 创建时间范围 -->
        <if test="startTime != null">
            AND u.create_time >= #{startTime}
        </if>
        <if test="endTime != null">
            AND u.create_time <= #{endTime}
        </if>
        <!-- 优先级选择 -->
        <choose>
            <when test="email != null and email != ''">
                AND u.email = #{email}
            </when>
            <when test="phone != null and phone != ''">
                AND u.phone = #{phone}
            </when>
        </choose>
        <!-- ID列表 -->
        <if test="userIds != null and userIds.size() > 0">
            AND u.id IN
            <foreach collection="userIds" item="id" open="(" separator="," close=")">
                #{id}
            </foreach>
        </if>
    </where>
    <!-- 动态排序 -->
    <if test="orderBy != null and orderBy != ''">
        ORDER BY ${orderBy}
        <if test="orderDirection != null and orderDirection != ''">
            ${orderDirection}
        </if>
    </if>
    <!-- 分页 -->
    <if test="pageSize != null and pageSize > 0">
        LIMIT #{offset}, #{pageSize}
    </if>
</select>
<!-- 用户动态更新接口 -->
<update id="updateUserSelective" parameterType="User">
    UPDATE user
    <set>
        <if test="username != null and username != ''">
            username = #{username},
        </if>
        <if test="password != null and password != ''">
            password = #{password},
        </if>
        <if test="age != null">
            age = #{age},
        </if>
        <if test="email != null and email != ''">
            email = #{email},
        </if>
        <if test="phone != null and phone != ''">
            phone = #{phone},
        </if>
        <if test="status != null">
            status = #{status},
        </if>
        <if test="updateTime != null">
            update_time = #{updateTime},
        </if>
    </set>
    WHERE id = #{id}
</update>
<!-- 批量插入用户 -->
<insert id="batchInsertUsers" parameterType="java.util.List">
    INSERT INTO user (username, password, age, email, phone, status, create_time, update_time)
    VALUES
    <foreach collection="list" item="user" separator=",">
        (
            #{user.username},
            #{user.password},
            #{user.age},
            #{user.email},
            #{user.phone},
            #{user.status},
            #{user.createTime},
            #{user.updateTime}
        )
    </foreach>
</insert>

最佳实践

1. 动态标签选择策略

场景	推荐标签	说明
简单条件判断	`<if>`	最基础的条件判断
多条件组合查询	`<where>` + `<if>`	智能处理WHERE和AND/OR
互斥条件选择	`<choose>` + `<when>`	避免多个if嵌套
动态更新字段	`<set>` + `<if>`	自动处理逗号和SET关键字
自定义字符串处理	`<trim>`	最灵活的字符串处理
集合遍历操作	`<foreach>`	IN查询、批量操作
参数预处理	`<bind>`	模糊查询、日期处理
SQL片段复用	`<sql>` + `<include>`	提取公共SQL

2. 性能优化建议

减少动态判断开销：

<!-- 不推荐：过度动态 -->
<select id="findUser">
    SELECT <if test="columns != null">${columns}</if> <if test="columns == null">*</if> FROM user
</select>
<!-- 推荐：明确字段 -->
<select id="findUser">
    SELECT id, username, email FROM user
    <where>
        <if test="username != null">
            AND username = #{username}
        </if>
    </where>
</select>

批量操作优化：

<!-- 推荐：分批次处理，避免SQL过长 -->
<insert id="batchInsertUsers">
    INSERT INTO user (username, email) VALUES
    <foreach collection="users" item="user" separator=",">
        (#{user.username}, #{user.email})
    </foreach>
</insert>
<!-- Java代码控制批次大小 -->
List<User> users = getUserList();
int batchSize = 500;
for (int i = 0; i < users.size(); i += batchSize) {
    List<User> batch = users.subList(i, Math.min(i + batchSize, users.size()));
    userMapper.batchInsertUsers(batch);
}

3. 安全性注意事项

防止SQL注入：

<!-- 危险：直接拼接用户输入 -->
<select id="findUserDangerous">
    SELECT * FROM user ORDER BY ${orderBy}
</select>
<!-- 安全：白名单校验 -->
<select id="findUserSafe">
    SELECT * FROM user
    <choose>
        <when test="orderBy == 'username'">ORDER BY username</when>
        <when test="orderBy == 'create_time'">ORDER BY create_time</when>
        <otherwise>ORDER BY id</otherwise>
    </choose>
</select>

避免全表操作风险：

<!-- 危险：可能导致全表更新 -->
<update id="updateUserDangerous">
    UPDATE user
    <set>
        <if test="status != null">status = #{status}</if>
    </set>
    <where>
        <if test="id != null">id = #{id}</if>
    </where>
</update>
<!-- 安全：确保WHERE条件 -->
<update id="updateUserSafe">
    UPDATE user
    <set>
        status = #{status}
    </set>
    WHERE id = #{id}
</update>

4. 代码可维护性

提取公共SQL片段：

<!-- 定义公共字段 -->
<sql id="userCommonFields">
    id, username, email, status, create_time
</sql>
<!-- 定义公共条件 -->
<sql id="userCommonCondition">
    status = 'ACTIVE'
    AND delete_flag = 0
</sql>
<!-- 使用公共片段 -->
<select id="findActiveUsers" resultType="User">
    SELECT <include refid="userCommonFields" />
    FROM user
    WHERE <include refid="userCommonCondition" />
</select>

注释复杂逻辑：

<!-- 用户查询：支持多条件动态组合
     1. username：模糊查询
     2. statusList：多状态选择
     3. 时间范围：create_time区间
     4. 排序：支持动态排序字段
-->
<select id="findUsersComplex" resultType="User">
    SELECT * FROM user
    <where>
        <if test="username != null and username != ''">
            AND username LIKE CONCAT('%', #{username}, '%')
        </if>
        <if test="statusList != null and statusList.size() > 0">
            AND status IN
            <foreach collection="statusList" item="status"
                     open="(" separator="," close=")">
                #{status}
            </foreach>
        </if>
    </where>
</select>

5. 参数校验建议

Java层校验：

public List<User> findUsers(UserQuery query) {
    // 参数校验
    if (query == null) {
        query = new UserQuery();
    }
    // 集合判空
    if (CollectionUtils.isEmpty(query.getStatusList())) {
        return Collections.emptyList();
    }
    // 分页参数校验
    if (query.getPageSize() != null && query.getPageSize() > 100) {
        query.setPageSize(100); // 限制最大页数
    }
    return userMapper.findUsers(query);
}

XML层安全判断：

<select id="findUsersSafe" resultType="User">
    SELECT * FROM user
    <where>
        <!-- 双重判空保护 -->
        <if test="username != null and username != ''">
            AND username = #{username}
        </if>
        <!-- 集合安全判断 -->
        <if test="statusList != null and statusList.size() > 0">
            AND status IN
            <foreach collection="statusList" item="status"
                     open="(" separator="," close=")">
                #{status}
            </foreach>
        </if>
    </where>
</select>

总结

MyBatis的动态标签为开发者提供了强大而灵活的SQL构建能力，通过合理使用这些标签，我们可以：

提升开发效率：避免手动拼接SQL的繁琐工作
增强代码可读性：声明式的SQL构建更直观易懂
保证SQL安全性：通过预编译防止SQL注入
提高维护性：SQL与业务逻辑分离，便于维护

在实际应用中，需要根据具体场景选择合适的动态标签，并遵循性能优化和安全性的最佳实践，避免过度使用动态标签导致的复杂性问题。

参考资料：

推荐阅读：

《MyBatis从入门到精通》- 动态SQL章节
《深入理解MyBatis技术原理与实战》- SQL映射详解
MyBatis-Plus官方文档 - 动态SQL增强功能

到此这篇关于MyBatis动态标签详解与应用实践的文章就介绍到这了,更多相关MyBatis动态标签内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

MyBatis动态标签详解与应用实践举例

引言

核心标签详解

1. <if> 标签

2. <where> 标签

3. <choose>、<when>、<otherwise> 标签

4. <set> 标签

5. <trim> 标签

6. <foreach> 标签

7. <bind> 标签

8. <sql> 和 <include> 标签

综合案例

用户查询综合案例

最佳实践

1. 动态标签选择策略

2. 性能优化建议

3. 安全性注意事项

4. 代码可维护性

5. 参数校验建议

总结

您可能感兴趣的文章: