24. 如何在MyBatis中复用SQL片段？`<sql>`标签和`<include>`标签如何使用？

PangHu大约 3 分钟

在MyBatis中，开发者经常会遇到需要在多个地方复用相同的SQL片段的情况。为了减少代码重复并提高SQL的可维护性，MyBatis提供了<sql>标签和<include>标签来实现SQL片段的复用。

1. `<sql>` 标签

<sql> 标签用于定义一个可以复用的SQL片段。你可以在MyBatis的XML映射文件中使用<sql>标签定义公共的SQL片段，然后通过<include>标签在其他SQL语句中引入该片段。

1.1 `<sql>` 标签的定义

<sql id="userColumns">
    id, username, email, phone
</sql>

id：是<sql>标签的唯一标识符，其他地方通过<include>标签引用该id来使用这个SQL片段。
内容：是你希望复用的SQL片段，可以是列名、条件、表名等。

2. `<include>` 标签

<include> 标签用于在其他SQL语句中引入通过<sql>标签定义的SQL片段。通过<include>标签引用的SQL片段会被直接嵌入到SQL语句中执行。

2.1 `<include>` 标签的使用

<select id="findAllUsers" resultType="User">
    SELECT <include refid="userColumns" /> FROM users
</select>

refid：是引用的<sql>标签的id属性值，表示要包含的SQL片段。
使用：在SQL语句中，通过<include>标签将<sql>标签定义的SQL片段引入。MyBatis在生成最终SQL时，会将<include>标签替换为对应的SQL片段。

3. 动态传递参数到SQL片段中

<include>标签不仅可以直接引用SQL片段，还可以通过传递动态参数来增强复用性。这在需要根据不同条件拼接SQL片段时非常有用。

3.1 动态传递参数

<sql id="userColumns">
    id, username, email
    <if test="includePhone">
        , phone
    </if>
</sql>

<select id="findAllUsersWithOptionalPhone" resultType="User">
    SELECT <include refid="userColumns">
                <property name="includePhone" value="true"/>
           </include>
    FROM users
</select>

<property> 标签：可以在<include>标签中使用<property>来向SQL片段传递参数，这些参数可以在<sql>标签内的动态SQL（如<if>）中使用。
解释：
- 这里的<sql>标签定义了一个包含动态条件的SQL片段，如果includePhone参数为true，则会将phone列包含在SQL查询中。
- 在引用这个SQL片段时，通过<include>标签中的<property>标签传递includePhone参数的值。

4. 实际示例

4.1 定义可复用的条件片段

<sql id="userCondition">
    <where>
        <if test="username != null">
            username = #{username}
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
</sql>

<where> 标签：自动处理条件开头的AND或OR，如果没有条件，会去掉WHERE子句。

4.2 在查询语句中引用条件片段

<select id="findUsersByCondition" resultType="User">
    SELECT <include refid="userColumns" /> FROM users
    <include refid="userCondition" />
</select>

<include> 标签：将之前定义的userColumns和userCondition引入到完整的SQL查询中。

4.3 带动态排序的查询

<sql id="dynamicOrderBy">
    ORDER BY
    <choose>
        <when test="orderBy == 'username'">
            username ASC
        </when>
        <when test="orderBy == 'email'">
            email ASC
        </when>
        <otherwise>
            id DESC
        </otherwise>
    </choose>
</sql>

<select id="findUsersWithDynamicOrder" resultType="User">
    SELECT <include refid="userColumns" /> FROM users
    <include refid="userCondition" />
    <include refid="dynamicOrderBy" />
</select>

动态排序：通过<choose>和<when>标签，动态生成ORDER BY子句，根据传入的orderBy参数进行排序。

5. 优点总结

提高代码复用性：
- 将通用的SQL片段提取出来定义在一个地方，可以在多个SQL语句中引用，减少重复代码，提高代码的可维护性。
减少维护成本：
- 如果需要修改某个SQL片段，只需要修改一次定义的SQL片段，引用该片段的所有SQL语句都会自动更新。
动态生成SQL：
- 可以通过动态传递参数的方式，根据不同的查询条件或排序规则生成不同的SQL语句，增强了SQL的灵活性。

总结

MyBatis中的<sql>标签和<include>标签提供了一种强大的方式来复用和动态生成SQL片段。通过这些标签，开发者可以更高效地管理复杂的SQL查询，减少代码重复，提高代码的可维护性。特别是在处理大型项目时，这种方式显得尤为重要和实用。