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 关键字前意外地留下 ANDOR。使用 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" 则确保了移除多余的 ANDOR

综上所述,<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 方法来执行更新操作。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容