高效 MyBatis SQL 写法_实用代码

在当今的软件开发领域，数据库操作是一项至关重要的任务。MyBatis 作为一款出类拔萃的持久层框架，宛如一把利刃，极大程度地简化了数据库操作流程，让开发者从繁琐的 SQL 编码中解脱出来。不过，在实际的开发工作里，XML 配置的编写有时会显得繁琐复杂，就像在迷宫中寻找出路一样让人头疼。本文旨在分享一些 MyBatis 动态 SQL 的优质编写方法，帮助开发者提升开发效率，同时减少错误的发生。

一、if + where 标签的组合运用

在构建动态 SQL 查询时，where 标签扮演着重要的角色，它能够自动处理 AND 或 OR 关键字多余的问题，避免 SQL 语句出现语法错误。下面是一个具体的示例：

xml

<select id="getStudentList_whereIf" resultMap="resultMap_studentEntity" parameterType="StudentEntity">
    SELECT * FROM STUDENT_TBL ST
    <where>
        <if test="studentName != null">
            ST.STUDENT_NAME LIKE CONCAT('%', #{studentName}, '%')
        </if>
        <if test="studentSex != null">
            AND ST.STUDENT_SEX = #{studentSex}
        </if>
    </where>
</select>

在这个示例中，<where> 标签会根据 <if> 标签的判断结果动态生成合适的 WHERE 子句。如果 studentName 不为空，就会添加相应的 LIKE 条件；如果 studentSex 也不为空，会正确地添加 AND 关键字，避免出现多余的 AND 或语法错误。

二、if + set 标签实现更新操作

当我们需要对数据库中的记录进行更新时，set 标签就派上用场了，它专门用于动态生成 UPDATE 语句中的 SET 部分。以下是示例代码：

xml

<update id="updateStudent_if_set" parameterType="StudentEntity">
    UPDATE STUDENT_TBL
    <set>
        <if test="studentName != null">
            STUDENT_NAME = #{studentName},
        </if>
        <if test="studentSex != null">
            STUDENT_SEX = #{studentSex},
        </if>
    </set>
    WHERE STUDENT_ID = #{studentId}
</update>

<set> 标签会自动处理逗号的问题，即使某些字段不需要更新，也不会出现 SQL 语法错误。它会根据 <if> 标签的判断结果，动态地生成需要更新的字段列表。

三、灵活使用 trim 标签

trim 标签具有强大的灵活性，它可以替代 where 和 set 标签，为 SQL 生成提供更多的可能性。示例如下：

xml

<select id="getStudentList_if_trim" resultMap="resultMap_studentEntity">
    SELECT * FROM STUDENT_TBL ST
    <trim prefix="WHERE" prefixOverrides="AND |OR ">
        <if test="studentName != null">
            ST.STUDENT_NAME LIKE CONCAT('%', #{studentName}, '%')
        </if>
        <if test="studentSex != null">
            AND ST.STUDENT_SEX = #{studentSex}
        </if>
    </trim>
</select>

<trim> 标签的 prefix 属性用于指定前缀，prefixOverrides 属性用于去除多余的关键字。在这个例子中，它模拟了 <where> 标签的功能，自动处理多余的 AND 或 OR 关键字。

四、foreach 标签实现批量操作

在进行批量查询或插入操作时，foreach 标签是一个非常实用的工具，它常用于 IN 条件中的批量操作。示例代码如下：

xml

<select id="getStudentListByClassIds_foreach_array" resultMap="resultMap_studentEntity">
    SELECT * FROM STUDENT_TBL ST
    WHERE ST.CLASS_ID IN
    <foreach collection="array" item="classId" open="(" separator="," close=")">
        #{classId}
    </foreach>
</select>

<foreach> 标签会遍历集合中的元素，根据指定的属性生成合适的 SQL 语句。在这个例子中，它将数组中的元素用逗号分隔，生成 IN 条件所需的格式。

五、复用 SQL 片段

为了提高代码的可读性和维护性，我们可以通过 <sql> 标签定义可复用的 SQL 片段。示例如下：

xml

<sql id="studentColumns">
    STUDENT_ID, STUDENT_NAME, STUDENT_SEX, STUDENT_BIRTHDAY
</sql>

<select id="getStudentList" resultMap="resultMap_studentEntity">
    SELECT
    <include refid="studentColumns"/>
    FROM STUDENT_TBL
</select>

在这个示例中，我们定义了一个名为 studentColumns 的 SQL 片段，然后在查询语句中使用 <include> 标签引用该片段，避免了代码的重复编写。

六、forEach 标签的详细使用

forEach 标签不仅可以用于批量操作，还常用于循环遍历集合，生成动态 SQL。它有几个核心属性需要我们了解：

item：表示集合中元素的别名，方便在 SQL 语句中引用。
index：表示集合中元素的索引。
collection：指定集合对象，这是必须设置的属性。
open：循环开始时的符号，例如 (。
separator：元素之间的分隔符，例如 ,。
close：循环结束时的符号，例如 )。

以下是一个具体的示例：

java

public List<Entity> queryById(List<String> userIds);

对应的 XML 配置如下：

xml

<select id="queryById" resultMap="BaseResultMap">
    SELECT * FROM entity
    WHERE id IN
    <foreach collection="userIds" item="userId" index="index" open="(" separator="," close=")">
        #{userId}
    </foreach>
</select>

需要注意的是，collection 属性的值取决于传入参数的类型。如果传入的是 List，该属性的值为 list；如果是数组，则为 array；如果是多个参数，就需要将其封装为 Map。

七、模糊查询与 concat 函数

在进行模糊查询时，我们可以使用 concat 函数动态拼接 SQL 语句。示例如下：

xml

<select id="queryByName" resultMap="BaseResultMap" parameterType="Entity">
    SELECT * FROM entity
    <where>
        <if test="name != null">
            name LIKE concat('%', #{name}, '%')
        </if>
    </where>
</select>

在这个例子中，使用 concat 函数将通配符 % 和传入的参数拼接在一起，实现了动态的模糊查询。

八、choose 标签实现多条件判断

choose 标签类似于 Java 中的 switch 语句，用于实现多条件判断。示例如下：

xml

<select id="getUserList_choose" resultMap="resultMap_user" parameterType="User">
    SELECT * FROM User u
    <where>
        <choose>
            <when test="username != null">
                u.username LIKE CONCAT('%', #{username}, '%')
            </when>
            <when test="sex != null">
                AND u.sex = #{sex}
            </when>
            <otherwise>
                AND u.status = 'ACTIVE'
            </otherwise>
        </choose>
    </where>
</select>

<choose> 标签会依次判断 <when> 标签的条件，一旦某个条件成立，就会执行对应的 SQL 语句，若所有 <when> 条件都不成立，则执行 <otherwise> 标签中的语句。

九、selectKey 标签用于主键生成

在插入数据时，有时候我们需要自动生成主键。selectKey 标签就可以帮助我们实现这一功能。示例如下：

xml

<insert id="createStudentAutoKey" parameterType="StudentEntity" keyProperty="studentId">
    <selectKey keyProperty="studentId" resultType="String" order="BEFORE">
        SELECT nextval('student')
    </selectKey>
    INSERT INTO STUDENT_TBL (student_id, student_name, student_sex, student_birthday)
    VALUES (#{studentId}, #{studentName}, #{studentSex}, #{studentBirthday})
</insert>

<selectKey> 标签会在插入数据之前或之后执行指定的 SQL 语句，生成主键值并赋值给指定的属性。

十、if 标签实现动态条件

if 标签是最常用的动态 SQL 标签之一，它用于动态生成 SQL 条件。示例如下：

xml

<select id="getStudentList_if" resultMap="resultMap_studentEntity" parameterType="StudentEntity">
    SELECT * FROM STUDENT_TBL ST
    <where>
        <if test="studentName != null">
            ST.STUDENT_NAME LIKE CONCAT('%', #{studentName}, '%')
        </if>
        <if test="studentSex != null">
            AND ST.STUDENT_SEX = #{studentSex}
        </if>
    </where>
</select>

<if> 标签会根据条件的判断结果决定是否将对应的 SQL 语句添加到最终的查询中。

总结

通过合理运用 MyBatis 的这些动态 SQL 标签，开发者能够显著提升代码的可读性和可维护性，同时减少因手动编写复杂 SQL 而可能出现的错误。在实际开发中，根据具体的业务需求灵活选择合适的标签和方法，将有助于我们更高效地完成数据库操作任务。