MyBatis trim标签核心用法代码实战

更新时间：2026年03月09日 09:52:04 作者：老赵全栈实战

MyBatis的<trim>标签用于动态SQL拼接,处理SQL前后缀和多余关键字,避免语法错误,提升代码可维护性,本文给大家介绍MyBatis trim标签核心用法代码实战,感兴趣的朋友跟随小编一起看看吧

📅 今日知识点

核心主题：MyBatis<trim>标签基本使用、动态SQL拼接、WHERE条件优化
适用场景：动态查询条件构建、批量更新语句、灵活的SQL片段组装
一句话总结：<trim>标签智能处理SQL前后缀和多余关键字，让动态SQL更优雅、更可靠

🧩 核心原理（简化版）

<trim>标签通过配置前缀、后缀、去除关键字，自动处理动态SQ 的拼接逻辑
核心逻辑：根据标签内容是否为空，智能添加或删除指定的SQL片段
核心价值：替代手动拼接SQL，避免语法错误（如多余的AND、OR、SET），提升代码可维护性

💻 代码实战（可直接复制运行）

1. 环境配置

<!-- Maven依赖（Spring Boot项目默认包含） -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.3.0</version>
</dependency>
<!-- 或使用 MyBatis Plus（兼容原生 MyBatis） -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3</version>
</dependency>

2. 核心用法示例

示例一：动态 WHERE 条件查询

// 实体类
@Data
public class User {
    private Long id;
    private String username;
    private String email;
    private Integer age;
    private Integer status;
}

<!-- Mapper XML文件 -->
<mapper namespace="com.example.mapper.UserMapper">
    <!-- 基础结果映射 -->
    <resultMap id="BaseResultMap" type="com.example.entity.User">
        <id column="id" property="id"/>
        <result column="username" property="username"/>
        <result column="email" property="email"/>
        <result column="age" property="age"/>
        <result column="status" property="status"/>
    </resultMap>
    <!-- 动态查询：使用 trim 处理 WHERE 条件 -->
    <select id="selectByCondition" parameterType="com.example.entity.User" resultMap="BaseResultMap">
        SELECT * FROM user
        <trim prefix="WHERE" prefixOverrides="AND|OR">
            <!-- 如果 username 不为空，添加条件 -->
            <if test="username != null and username != ''">
                AND username LIKE CONCAT('%', #{username}, '%')
            </if>
            <!-- 如果 email 不为空，添加条件 -->
            <if test="email != null and email != ''">
                AND email = #{email}
            </if>
            <!-- 如果 age 不为空，添加条件 -->
            <if test="age != null">
                AND age > #{age}
            </if>
            <!-- 如果status不为空，添加条件 -->
            <if test="status != null">
                AND status = #{status}
            </if>
        </trim>
        ORDER BY id DESC
    </select>
</mapper>

// Mapper接口
@Mapper
public interface UserMapper {
    List<User> selectByCondition(@Param("user") User user);
}
// 测试代码
@SpringBootTest
public class UserMapperTest {
    @Autowired
    private UserMapper userMapper;
    @Test
    public void testSelectByCondition() {
        // 测试1：只有 username 条件
        User condition1 = new User();
        condition1.setUsername("john");
        List<User> result1 = userMapper.selectByCondition(condition1);
        System.out.println("查询结果1: " + result1.size());
        // 测试2：多个条件组合
        User condition2 = new User();
        condition2.setUsername("alice");
        condition2.setAge(18);
        condition2.setStatus(1);
        List<User> result2 = userMapper.selectByCondition(condition2);
        System.out.println("查询结果2: " + result2.size());
        // 测试3：无条件（返回所有）
        User condition3 = new User();
        List<User> result3 = userMapper.selectByCondition(condition3);
        System.out.println("查询结果3: " + result3.size());
    }
}

生成的SQL示例：

-- 测试1：只有 username 条件（自动去除开头的 AND）
SELECT * FROM user
WHERE username LIKE CONCAT('%', 'john', '%')
ORDER BY id DESC
-- 测试2：多个条件组合
SELECT * FROM user
WHERE username LIKE CONCAT('%', 'alice', '%')
  AND age > 18
  AND status = 1
ORDER BY id DESC
-- 测试3：无条件（不生成 WHERE 子句）
SELECT * FROM user
ORDER BY id DESC

示例二：动态 UPDATE 语句

<!-- 动态更新：使用 trim 处理 SET 关键字 -->
<update id="updateSelective" parameterType="com.example.entity.User">
    UPDATE user
    <trim prefix="SET" suffixOverrides=",">
        <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="status != null">
            status = #{status},
        </if>
    </trim>
    WHERE id = #{id}
</update>

// 测试代码
@Test
public void testUpdateSelective() {
    // 准备数据
    User user = new User();
    user.setId(1L);
    user.setUsername("updated_user");
    user.setEmail("new@example.com");
    // 只更新 username 和 email，age 和 status 保持不变
    int rows = userMapper.updateSelective(user);
    System.out.println("更新行数：" + rows);
}

生成的SQL示例：

-- 只更新非空字段（自动去除末尾的逗号）
UPDATE user
SET username = 'updated_user',
    email = 'new@example.com'
WHERE id = 1

3. trim标签属性详解（4个核心，记牢即可）

<!-- 1. prefix：在trim标签内容前添加的前缀 -->
<trim prefix="WHERE">
    <!-- 内容 -->
</trim>
<!-- 生成：WHERE (内容) -->
<!-- 2. suffix：在 trim 标签内容后添加的后缀 -->
<trim suffix="ORDER BY id">
    <!-- 内容 -->
</trim>
<!-- 生成：(内容) ORDER BY id -->
<!-- 3. prefixOverrides：要去除的前缀（支持正则表达式，用 | 分隔） -->
<trim prefix="WHERE" prefixOverrides="AND|OR">
    <if test="condition1">AND col1 = val1</if>
    <if test="condition2">AND col2 = val2</if>
</trim>
<!-- 生成：WHERE col1 = val1 AND col2 = val2 -->
<!-- 4. suffixOverrides：要去除的后缀（支持正则表达式，用 | 分隔） -->
<trim prefix="SET" suffixOverrides=",">
    <if test="col1 != null">col1 = val1,</if>
    <if test="col2 != null">col2 = val2,</if>
</trim>
<!-- 生成：SET col1 = val1, col2 = val2 -->

⚠️ 避坑指南（简洁重点）

1.核心坑1：prefixOverrides未正确配置导致SQL语法错误

<!-- ❌ 错误写法：忘记配置 prefixOverrides -->
<select id="selectBad" resultMap="BaseResultMap">
    SELECT * FROM user
    <trim prefix="WHERE">
        <if test="username != null">
            AND username = #{username}  <!-- 第一个条件前有 AND -->
        </if>
    </trim>
</select>
<!-- 生成错误SQL：SELECT * FROM user WHERE AND username = ? -->
<!-- ✅ 正确写法：配置 prefixOverrides="AND|OR" -->
<select id="selectGood" resultMap="BaseResultMap">
    SELECT * FROM user
    <trim prefix="WHERE" prefixOverrides="AND|OR">
        <if test="username != null">
            AND username = #{username}
        </if>
    </trim>
</select>
<!-- 生成正确SQL：SELECT * FROM user WHERE username = ? -->

2.核心坑2：suffixOverrides未去除多余逗号

<!-- ❌ 错误写法：忘记配置 suffixOverrides -->
<update id="updateBad">
    UPDATE user
    <trim prefix="SET">
        <if test="username != null">
            username = #{username},  <!-- 最后一个字段后有逗号 -->
        </if>
    </trim>
    WHERE id = #{id}
</update>
<!-- 生成错误SQL：UPDATE user SET username = ?, -->
<!-- ✅ 正确写法：配置 suffixOverrides="," -->
<update id="updateGood">
    UPDATE user
    <trim prefix="SET" suffixOverrides=",">
        <if test="username != null">
            username = #{username},
        </if>
    </trim>
    WHERE id = #{id}
</update>
<!-- 生成正确SQL：UPDATE user SET username = ? WHERE id = ? -->

3.核心坑3：trim嵌套使用时的注意事项

<!-- ✅ 复杂场景：trim 可以嵌套使用 -->
<select id="selectComplex" resultMap="BaseResultMap">
    SELECT * FROM user
    <trim prefix="WHERE" prefixOverrides="AND|OR">
        <!-- 外层 trim 处理 WHERE -->
        <if test="query != null">
            <!-- 内层 trim 处理分组条件 -->
            <trim prefix="(" prefixOverrides="AND|OR" suffix=")">
                <if test="query.username != null">
                    AND username LIKE #{query.username}
                </if>
                <if test="query.email != null">
                    AND email LIKE #{query.email}
                </if>
            </trim>
        </if>
        <if test="status != null">
            AND status = #{status}
        </if>
    </trim>
</select>
<!-- 生成SQL：SELECT * FROM user WHERE (username LIKE ? AND email LIKE ?) AND status = ? -->

4.核心坑4：trim vs where/set标签选择

<!-- trim 标签：最灵活，可自定义前后缀和去除规则 -->
<trim prefix="WHERE" prefixOverrides="AND|OR" suffix="LIMIT 10">
    <!-- 复杂场景 -->
</trim>
<!-- where 标签：trim的简化版，固定处理WHERE和AND/OR -->
<where>
    <if test="condition1">AND col1 = val1</if>
    <if test="condition2">AND col2 = val2</if>
</where>
<!-- 等价于：<trim prefix="WHERE" prefixOverrides="AND|OR"> -->
<!-- set 标签：trim的简化版，固定处理SET和逗号 -->
<set>
    <if test="col1 != null">col1 = val1,</if>
    <if test="col2 != null">col2 = val2,</if>
</set>
<!-- 等价于：<trim prefix="SET" suffixOverrides=","> -->
<!-- 最佳实践：简单场景用 where/set，复杂场景用 trim -->

✅ 今日总结

<trim>标签核心是"智能拼接"，自动处理 SQL 前后缀和多余关键字，避免语法错误
4个核心属性：prefix（前缀）、suffix（后缀）、prefixOverrides（去前缀）、suffixOverrides（去后缀）
实用性强：动态查询、批量更新、复杂条件组装等场景都能大幅提升 SQL 可维护性
最佳实践：简单场景用 <where>/<set>简化版，复杂场景用 <trim>完整版

到此这篇关于MyBatis trim标签核心用法代码实战的文章就介绍到这了,更多相关MyBatis trim标签用法内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

详解Spring集成Redis的两种方式
在工作中，我们用到分布式缓存的时候，第一选择就是Redis，今天介绍一下SpringBoot如何集成Redis的，具有一定的参考价值，感兴趣的可以了解一下
2021-09-09
Spring使用注解实现Bean的自动装配
大家好，本篇文章主要讲的是Spring使用注解实现Bean的自动装配，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下
2022-02-02
Java数据结构之查找
本文主要介绍了Java数据结构中查找的相关知识。具有很好的参考价值。下面跟着小编一起来看下吧
2017-03-03
Spring引入外部属性文件配置数据库连接的步骤详解
这篇文章主要介绍了Spring引入外部属性文件配置数据库连接的步骤详解,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
SpringBoot实现登录校验(JWT令牌)
JWT全称为JSON Web Token，是一种用于身份验证的开放标准，本文主要介绍了SpringBoot实现登录校验(JWT令牌)，具有一定的参考价值，感兴趣的可以了解一下
2023-12-12
在Action中以Struts2的方式输出JSON数据的实例
下面小编就为大家带来一篇在Action中以Struts2的方式输出JSON数据的实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-11-11
基于Java实现遍历文件目录并去除中文文件名
这篇文章主要为大家详细介绍了如何使用Java实现遍历文件目录并去除中文文件名,文中的示例代码讲解详细,有需要的小伙伴可以参考一下
2024-03-03
Java直接内存和堆内存的关系
在Java编程中,内存管理是一个重要的话题,本文介绍了Java中两种主要内存类型：堆内存和直接内存,堆内存是JVM管理的主要内存区域,感兴趣的朋友跟随小编一起看看吧
2024-09-09
Java反射概念与使用实例代码
JAVA反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法,下面这篇文章主要给大家介绍了关于Java反射概念与使用的相关资料,需要的朋友可以参考下
2021-11-11
例题详解Java dfs与记忆化搜索和分治递归算法的使用
递归指函数调用自身。常用的递归算法有dfs（深度优先搜索）、记忆化搜索和分治，接下来将用几个算法题来带你熟练掌握它
2022-04-04