MyBatis中常见标签的使用(动态SQL)

MyBatis 中的动态 SQL 允许你在 XML 映射文件中编写灵活的 SQL 查询语句，根据不同的条件动态生成不同的 SQL 语句。这样可以避免在 Java 代码中拼接 SQL 字符串，使得 SQL 查询更加清晰和易维护。本文章将介绍几个常见的标签并实现动态SQL

目录

一.标签

二.标签

三.标签

四.标签

五.标签

---

一.<if>标签

<if> 标签用于在 SQL 映射文件中根据条件来动态生成 SQL 语句的一部分。这使得我们可以根据不同的情况动态地包含或排除特定的 SQL 片段,示例如下:

    <select id="selectByCondition" resultType="User">
        SELECT * FROM users
        <where>
            <if test="username != null">
                AND username = #{username}
            </if>
            <if test="email != null">
                AND email = #{email}
            </if>
        </where>
    </select>

在<if>标签中,当test语句成立时才会将里面的语句拼接到SQL里面,从而实现动态的效果

二.<trim>标签

<trim> 可以帮助我们处理 SQL 语句中的前缀、后缀或者指定的字符

在标签中可以指定四个属性:

• prefix 属性定义了在整个 SQL 语句片段前添加的字符串。
• suffix 属性定义了在整个 SQL 语句片段后添加的字符串。
• prefixOverrides 属性指定了需要在 SQL 语句片段开头移除的前缀字符串。
• suffixOverrides 属性指定了需要在 SQL 语句片段末尾移除的后缀字符串。

示例:

    <insert id="insertUserByCondition">
    INSERT INTO userinfo
    <trim prefix="(" suffix=")" suffixOverrides=",">
        <if test="username !=null">
            username,
        </if>
        <if test="password !=null">
            `password`,
        </if>
        <if test="age != null">
            age,
        </if>
        <if test="gender != null">
            gender,
        </if>
        <if test="phone != null">
            phone,
        </if>
    </trim>
    VALUES
    <trim prefix="(" suffix=")" suffixOverrides=",">
        <if test="username !=null">
            #{username},
        </if>
        <if test="password !=null">
            #{password},
        </if>
        <if test="age != null">
            #{age},
        </if>
        <if test="gender != null">
            #{gender},
        </if>
        <if test="phone != null">
            #{phone}
        </if>
        </trim>
    </insert>

在示例中,指定添加了前缀 '(' 和后缀 ')' ,以及将最终SQL中多余的 ',' 去除 

三.<where>标签

<where> 标签通常用于动态生成 SQL 查询语句的 WHERE 子句。它可以帮助我们处理查询条件的拼接，并且根据条件动态生成 WHERE 子句，使得 SQL 查询语句更加灵活和易于维护。

示例:

    <select id="selectByCondition" resultType="User">
        SELECT * FROM users
        <where>
            <if test="username != null">
                AND username = #{username}
            </if>
            <if test="email != null">
                AND email = #{email}
            </if>
        </where>
    </select>

在示例中,如果username和email都为null,则<where>标签将不会生成where关键字,并且会处理多余的AND

四.<set>标签

和<where>标签的功能类似,示例如下:

    <update id="updateUser" parameterType="User">
        UPDATE users
        <set>
            <if test="username == null">
                username = #{username},
            </if>
            <if test="email == null">
                email = #{email},
            </if>
        </set>
        WHERE id = #{id}
    </update>

在示例中,如果username和email都为null,则<where>标签将不会生成set关键字,并且会处理多余的 ',' 

五.<foreach>标签

<foreach> 标签是 MyBatis 中用于遍历集合并生成动态 SQL 语句的标签之一。它通常用于在 SQL 语句中动态地拼接 IN 子句的值，可以非常方便地处理批量操作或者根据集合条件进行查询。

在使用时可以指定5个属性:

• collection：指定要遍历的集合的属性名。
• item：指定在遍历过程中当前元素的别名。
• open：指定遍历开始时的字符串，通常用于指定 IN 子句的开头部分。
• separator：指定每个元素之间的分隔符，通常用于指定 IN 子句中元素的分隔符。
• close：指定遍历结束时的字符串，通常用于指定 IN 子句的结束部分。

示例如下:

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

五.<include>标签

<include> 标签是 MyBatis 中用于代码重用和模块化的标签，它可以将 SQL 片段抽取出来并在多个地方进行重复使用。这样可以提高 SQL 映射文件的可维护性，并减少重复代码的编写。

示例如下:

<!-- 定义 SQL 片段 -->
<sql id="commonColumns">
    column1, column2, column3
</sql>

<!-- 在具体的 SQL 语句中使用 <include> 引用定义的 SQL 片段 -->
<select id="selectUser" resultType="User">
    SELECT
    <include refid="commonColumns"/>
    FROM user_table
    WHERE id = #{id}
</select>

<include> 标签的主要属性是 refid，它指定了要引用的 SQL 片段的 id。

---

到这里关于MyBatis的常见标签的介绍就结束了~