Spring+SpringMVC+MyBatis深入学习及搭建(五)——动态sql

目录#

动态SQL概述
常用动态SQL标签
- <if>标签
- <choose>、<when>、<otherwise>标签
- <trim>、<where>、<set>标签
- <foreach>标签
动态SQL使用场景
动态SQL最佳实践
示例代码
总结
参考

1. 动态SQL概述#

MyBatis的动态SQL允许开发者根据不同的条件（如参数是否为空、参数的值等）来动态地拼接SQL语句。这使得我们可以在一个Mapper接口方法中处理多种不同的查询或操作情况，而不需要为每种情况编写单独的SQL语句。它基于OGNL（Object-Graph Navigation Language）表达式来实现条件判断和数据处理。

2. 常用动态SQL标签#

`<if>`标签#

功能：用于简单的条件判断，根据条件决定是否包含某段SQL代码。
示例：假设我们有一个查询用户的方法，根据用户姓名和年龄进行查询（姓名和年龄可能为空）。

<select id="selectUser" resultType="User">
    SELECT * FROM user
    <where>
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </where>
</select>

这里通过<if>标签判断name和age是否为空，不为空时才将对应的条件加入SQL。

`<choose>`、`<when>`、`<otherwise>`标签#

功能：类似于Java中的switch-case-default语句，从多个条件中选择一个满足的条件执行对应的SQL代码。
示例：

<select id="selectUserByCondition" resultType="User">
    SELECT * FROM user
    <where>
        <choose>
            <when test="name != null and name != ''">
                name = #{name}
            </when>
            <when test="age != null">
                age = #{age}
            </when>
            <otherwise>
                1=1
            </otherwise>
        </choose>
    </where>
</select>

当name不为空时执行第一个<when>中的SQL，否则判断age，都不满足时执行<otherwise>（这里1=1是为了保证SQL语法正确，可根据实际情况调整）。

`<trim>`、`<where>`、`<set>`标签#

<where>标签：
- 功能：自动处理SQL语句中的WHERE关键字，当有条件满足时添加WHERE，并处理多个条件之间的AND或OR连接（去除多余的AND或OR）。
- 示例：同上面<if>标签示例中的<where>部分。
<set>标签：
- 功能：用于更新语句，自动处理SET关键字，当有字段需要更新时添加SET，并处理多个字段之间的逗号（去除多余的逗号）。
- 示例：

<update id="updateUser" parameterType="User">
    UPDATE user
    <set>
        <if test="name != null and name != ''">
            name = #{name},
        </if>
        <if test="age != null">
            age = #{age}
        </if>
    </set>
    WHERE id = #{id}
</update>

<trim>标签：
- 功能：可以更灵活地处理SQL语句的前后缀和去除多余的字符。它有prefix（前缀）、suffix（后缀）、prefixOverrides（去除前缀）、suffixOverrides（去除后缀）等属性。
- 示例：

<select id="selectUserTrim" resultType="User">
    SELECT * FROM user
    <trim prefix="WHERE" prefixOverrides="AND |OR ">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </trim>
</select>

这里prefix="WHERE"表示添加WHERE前缀，prefixOverrides="AND |OR "表示去除前面多余的AND或OR。

`<foreach>`标签#

功能：用于遍历集合（如List、数组等），构建SQL中的IN语句或批量操作语句。
示例：

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

这里collection指定集合参数（假设方法参数是List<Integer> ids），item指定集合元素变量名，open、separator、close分别指定IN语句的括号开始、元素分隔符、括号结束。

3. 动态SQL使用场景#

查询场景：根据不同的查询条件（如用户输入的部分条件）动态构建查询SQL，避免编写大量相似的查询方法。
更新场景：根据传入对象的属性是否有值来决定更新哪些字段。
批量操作场景：如批量插入、批量删除（通过IN语句结合<foreach>标签）等。

4. 动态SQL最佳实践#

避免过度复杂的嵌套：虽然动态SQL功能强大，但过度嵌套会使SQL语句难以阅读和维护，尽量保持逻辑简洁。
参数校验：在使用动态SQL时，对传入的参数进行必要的校验（如非空判断），防止SQL注入等安全问题（MyBatis本身对#{}占位符有一定的安全处理，但仍需注意）。
代码复用：对于一些通用的动态SQL片段，可以使用<sql>标签定义，然后通过<include>标签引用，提高代码复用性。

<sql id="userColumns">
    id, name, age
</sql>
 
<select id="selectUserSimple" resultType="User">
    SELECT <include refid="userColumns"/> FROM user
</select>

5. 示例代码#

假设我们有一个User实体类：

public class User {
    private Integer id;
    private String name;
    private Integer age;
    // 省略getter和setter
}

对应的Mapper接口：

public interface UserMapper {
    User selectUser(User user);
    User selectUserByCondition(User user);
    int updateUser(User user);
    List<User> selectUserByIds(List<Integer> ids);
}

以及上述提到的Mapper XML文件中的SQL语句实现。

在Spring配置中（假设使用Spring整合MyBatis），配置好SqlSessionFactory和MapperScannerConfigurer等相关Bean后，就可以在Service层调用这些Mapper方法了。

6. 总结#

MyBatis的动态SQL是其强大特性之一，通过合理使用<if>、<choose>、<trim>、<foreach>等标签，可以大大提高SQL语句的灵活性和可维护性。在实际开发中，根据不同的业务场景选择合适的动态SQL标签组合，遵循最佳实践，能够写出高效、易读的数据库操作代码。

7. 参考#

MyBatis官方文档
《MyBatis从入门到精通》相关书籍

希望本文能帮助读者深入理解和应用MyBatis的动态SQL功能，在实际项目中更好地进行数据库操作开发。

目录#