Mybatis 动态SQL <trim>标签

MyBatis 动态 SQL `<trim>` 标签教程

在 MyBatis 中，<trim> 标签是一种非常实用的标签，用于动态地拼接 SQL 语句。以下是 <trim> 标签的各种属性及其解释：

1. prefix 属性

作用：在生成的 SQL 语句前添加指定的内容。
解释：当你希望在动态 SQL 语句的开始处添加某个固定的前缀时，可以使用 prefix 属性。例如，在构建 WHERE 条件时，你通常希望在条件前添加 WHERE 关键字，这时就可以使用 prefix="WHERE"。

2. suffix 属性

作用：在生成的 SQL 语句后添加指定的内容。
解释：与 prefix 属性类似，suffix 属性用于在动态 SQL 语句的结尾处添加某个固定的后缀。例如，在构建 UPDATE 语句时，你可能希望在最后添加 WHERE 子句来指定更新条件，这时就可以使用 suffix="WHERE id = #{id}"（注意这里的后缀是一个示例，实际使用时可能需要根据具体需求进行调整）。

3. prefixOverrides 属性

作用：移除生成的 SQL 语句前不需要的内容。
解释：prefixOverrides 属性允许你指定一个或多个需要被移除的前缀。这在处理动态 WHERE 条件时特别有用，因为当条件不满足时，你可能会在 WHERE 关键字前意外地留下 AND 或 OR。使用 prefixOverrides="AND | OR" 可以确保这些多余的连接词被移除。

4. suffixOverrides 属性

作用：移除生成的 SQL 语句后不需要的内容。
解释：与 prefixOverrides 类似，suffixOverrides 属性允许你指定一个或多个需要被移除的后缀。这在处理动态 SET 子句时特别有用，因为当更新多个字段时，字段之间通常会用逗号分隔，但在最后一个字段后不需要逗号。使用 suffixOverrides="," 可以确保最后一个逗号被移除。

使用示例

以下是一个使用 <trim> 标签构建动态 WHERE 条件的示例：

<select id="getUserList" parameterType="map" resultType="User">
    SELECT * FROM user
    <trim prefix="WHERE" prefixOverrides="AND | OR">
        <if test="username != null and username != ''">
            AND username = #{username}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
        <!-- 可以添加更多的条件判断 -->
    </trim>
</select>

在这个示例中，<trim> 标签用于构建 WHERE 条件部分。如果传入的参数中有 username，则生成的 SQL 语句将包含 AND username = #{username}；如果传入的参数中有 age，则生成的 SQL 语句将包含 AND age = #{age}。prefix="WHERE" 确保了在有条件时添加 WHERE 关键字，而 prefixOverrides="AND | OR" 则确保了移除多余的 AND 或 OR。

综上所述，<trim> 标签通过其灵活的属性设置，可以方便地构建动态 SQL 语句，提高 SQL 语句的可读性和可维护性。

场景描述

在 MyBatis 中，<trim> 标签是动态 SQL 的一个强大工具，它允许你根据条件添加或移除 SQL 语句中的某些部分。与 <set> 和 <if> 标签类似，<trim> 标签也常用于构建更新语句或复杂的查询语句，但它提供了更多的灵活性，比如可以在语句的开始或结束处添加自定义的前缀或后缀，以及移除不需要的逗号或其他字符。

步骤

1. 创建 User 类

首先，我们需要一个 User 类来映射数据库中的用户信息。这个类在之前的教程中已经定义过，但为了完整性，这里再次给出。

public class User {
    private Integer id;
    private String username;
    private String password;
    private String gender;
    private String addr;

    // Getters and Setters
    // ...
}

2. 配置 MyBatis 映射文件（UserMapper.xml）

在 MyBatis 的映射文件中，我们将使用 <update> 标签来定义一个更新语句，并在其中使用 <trim> 和 <if> 标签来构建动态 SQL。

<mapper namespace="com.situ.mybatis.UserMapper">
    <!-- 动态更新用户信息，使用<trim>标签 -->
    <update id="updateUserByTrim" parameterType="User">
        update tb_user
        <trim prefix="set" suffixOverrides=",">
            <!-- 如果username不为空，则更新username字段 -->
            <if test="username != null and username != ''">
                username = #{username},
            </if>
            <!-- 如果password不为空，则更新password字段 -->
            <if test="password != null and password != ''">
                password = #{password},
            </if>
            <!-- 可以根据需要添加更多的字段判断 -->
            <if test="gender != null and gender != ''">
                gender = #{gender},
            </if>
            <if test="addr != null and addr != ''">
                addr = #{addr},
            </if>
        </trim>
        where id = #{id}
    </update>

</mapper>

注释说明：

<trim> 标签的 prefix 属性用于在动态 SQL 语句的开始处添加自定义的前缀，这里我们添加了 set 关键字。
suffixOverrides 属性用于指定需要移除的字符或字符序列。在这个例子中，我们移除了最后一个可能存在的逗号（,），以确保生成的 SQL 语句是有效的。
<if> 标签用于判断某个字段是否应该被包含在更新语句中。test 属性中的表达式用于评估字段的值是否满足条件。

3. 创建 UserMapper 接口

接下来，我们需要一个 UserMapper 接口来声明更新用户信息的方法。

public interface UserMapper {
    // 根据提供的User对象更新用户信息，使用<trim>标签
    int updateUserByTrim(User user);
}

4. 使用 UserMapper 更新用户信息

最后，我们可以在服务层或测试类中使用 UserMapper 来更新用户信息。

// 假设你已经有了SqlSessionFactory的初始化代码（省略）
@Test
    public void selectUserTrim() {
        User user = new User();
//      user.setPassword("cde");
        user.setUsername("四");
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userMapper.selectUserTrim(user);
        for(User u:userList) {
            System.out.println(u);
        }
    }

在这个例子中，通过 SqlSession 获取了 UserMapper 的实例，并调用了 updateUserByTrim 方法来执行更新操作。