MyBatis - 动态 SQL-Toy模板网

这篇具有很好参考价值的文章主要介绍了MyBatis - 动态 SQL。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

动态 SQL 是 MyBatis 提供的一个非常强大的功能，它可以让我们在运行时构建 SQL 语句。这意味着我们可以根据应用程序的需求来构建符合要求的 SQL。通常情况下，这是非常有用的，因为有时我们不知道要查询哪些表，或者要查询哪些列。此外，动态 SQL 还可以用来构建动态修改或删除语句。

1.if

if 标签可以实现判断逻辑，该标签有一个 test 属性定义成立条件。如果条件成立，那么包含在标签中的 SQL 语句将会被执行，否则这些语句将会被忽略。

下面是一个示例：

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

我们定义了一个 getUser 的 SQL 查询，并在查询中使用了 IF 条件语句。这个查询将会根据传入的参数选择是否加入用户名和电子邮件地址条件，从而查询符合条件的用户记录。

注意：为了是我们的 SQL 拼接不出错，我们添加了 WHERE 1=1 这样的语句。

2.choose

如果我们需要在两个或更多条件之间进行选择，我们可以使用 choose 标签。

它的语法如下：

<select id="getUser" resultType="User">
  SELECT * FROM users
  <choose>
    <when test='condition1'>
      WHERE column_name = #{column_name1}
    </when>
    <when test='condition2'>
      WHERE column_name = #{column_name2}
    </when>
    <otherwise>
      WHERE column_name = #{column_name3}
    </otherwise>
  </choose>
</select>

我们定义了一个 getUser 的 SQL 查询，并在查询中使用 choose 标签。这个查询首先会根据 condition1 的值是否成立进行判断。如果成立，那么查询结果只会包括 column_name1 的内容。否则，它会继续检查 condition2 是否成立。如果成立，那么查询结果只会包括 column_name2 的内容。否则，查询结果将会包括 column_name3 的内容。

TIP：可以简单类比为 Java 中的 Switch 语句。

3.where

上面的例子中我们为了 SQL 拼接不出错，添加了 where 1=1 这样的语句，其实可以使用 where 标签来实现查询条件，当标签内没有内容时会自动去除 where 关键字，同时还会去除开头多余的 and 关键字，帮助我们在 SQL 查询中简化条件逻辑。

它的语法如下：

SELECT * FROM table_name
<where>
  <if test="column_name1 != null">
    AND column_name1 = #{column_name1}
  </if>
  <if test="column_name2 != null">
    AND column_name2 = #{column_name2}
  </if>
  <if test="column_name1 != null">
    AND column_name3 = #{column_name3}
  </if>
</where>

4.set

当我们拼接更新字段的语句时，也会面临同样的问题，此时可以使用 set 标签来解决。

它的语法如下：

UPDATE table_name
<set>
  column_name1 = #{column_name1},
  column_name2 = #{column_name2},
  column_name3 = #{column_name3}，
  <if test="column_name4 != null">
    column_name4 = #{column_name4},
  </if>
</set>
WHERE id = #{id}

5.foreach

通过 foreach 我们可以实现一些循环拼接 SQL 的逻辑，它一般用于循环遍历一个集合，然后将集合中的元素插入到 SQL 语句中，从而生成多条 SQL 语句。

它的语法如下：

<foreach collection="list" item="item" index="index" separator=",">
    #{item}
</foreach>

下面是 foreach 标签常用属性：

list：表示要遍历的集合元素；
item：表示集合中的元素变量，即每次循环时，将集合中的某个元素赋值给该变量；
index：表示集合中元素的索引值，从0开始计数；
separator：表示单个元素之间的分隔符。
open：用于指定循环的开始语句字符；
close：用于指定循环的结束语句字符；

假设有一个列表，其中包含多个用户的 ID，我们想通过这个列表查询他们的姓名。使用 foreach，我们可以轻松地将这些用户 ID 插入到 SQL 语句中：

<select id="getUserListByIds" resultType="User">
    select * from user where id in
    <foreach collection="ids" item="item" index="index" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

其中 ids 是用户 ID 列表，在 foreach 语句中将其遍历并插入到 SQL 语句中。这将生成类似于以下的 SQL 语句：

select * from user where id in (1, 2, 3, 4)

6.基于注解编写

上面我们都是默认使用 MyBatis XML 映射的方式进行动态 SQL 的讲解，其实动态 SQL 也支持注解的方式。

从最简单的查询开始，假设我们有一个名为 StudentMapper 的接口，并且我们希望根据不同的条件来查询用户列表。

@Select("select * from student where id = #{id}")
Student selectById(Long id);

@Select("select * from student where name = #{name}")
Student selectByName(String name);

针对这种情况，我们就可以使用动态 SQL 来进行优化了。接下来，我们将扩展查询功能，以便能够根据不同的条件进行动态查询。在这种情况下，我们可以使用 @SelectProvider 注解来指定一个动态 SQL 提供者类。

@SelectProvider(type = StudentSqlProvider.class, method = "selectById")
Student selectById(Long id);

@SelectProvider(type = StudentSqlProvider.class, method = "selectByName")
Student selectByName(String name);

上面我们通过 @SelectProvider 注解的 type 属性指定了动态 SQL 提供者类为 StudentSqlProvider，并通过 method 属性指定了其中处理对应情况的方法名。

对此我们便可以提供一个内部类 StudentSqlProvider 来进行具体实现了：

class StudentSqlProvider {
    public String selectById(Long id) {
        return "select * from student where id = " + id;
    }

    public String selectByName(String name) {
        return "select * from student where name = '" + name + "'";
    }
}

接下来我们加入动态 SQL，再来进行进一步的优化：

class StudentSqlProvider {
    public String selectById(Long id) {
        return new SQL() {{
            SELECT("*");
            FROM("student");
            WHERE("id = #{id}");
        }}.toString();
    }

    public String selectByName(String name) {
        return new SQL() {{
            SELECT("*");
            FROM("student");
            WHERE("name = #{name}");
        }}.toString();
    }
}

在上面的代码中，我们定义了一个名为 UserSqlProvider 的类，其中包含了动态 SQL 查询的实现。这些方法返回一个动态生成的 SQL 语句，MyBatis 将在运行时执行该语句。

除了简单的查询条件外，有时我们需要使用条件判断和循环来构建更复杂的查询语句。在 MyBatis 注解中，我们可以使用 OGNL 表达式来实现这些逻辑。

OGNL（Object-Graph Navigation Language）是一种强大的表达式语言，用于在对象图中导航和操作对象的属性和方法。在 MyBatis 中，OGNL 表达式用于在注解中编写动态 SQL 查询的条件判断和循环逻辑。OGNL 表达式使用点号 . 来访问对象的属性和方法。例如，user.name 表示访问 user 对象的 name 属性，user.getName() 表示调用 user 对象的 getName() 方法。

例如，我们现在将上述两个方法再进一步优化，合并为一个方法：

@SelectProvider(type = StudentSqlProvider.class, method = "getStudentByCondition")
Student selectByCondition(Student student);

然后再次修改对应的动态 SQL 提供者类：

class StudentSqlProvider {
    public String getStudentByCondition(Student student) {
        SQL sql = new SQL().SELECT("*").FROM("student");
        if (student.getId() != null) {
            sql.WHERE("id = #{id}");
        }
        if (student.getName() != null) {
            sql.WHERE("name = #{name}");
        }
        return sql.toString();
    }
}

在上述代码中，我们将根据不同的条件动态构建 SQL 查询语句，从而实现动态 SQL 的效果。

对于动态 SQL 的注解，一共提供有如下 4 个：

注解名	说明
`@SelectProvider`	用于指定一个动态 SQL 提供者类，该类负责根据方法参数生成动态 SQL 语句。
`@InsertProvider`	用于指定一个动态 SQL 提供者类，该类负责根据方法参数生成动态插入语句。
`@UpdateProvider`	用于指定一个动态 SQL 提供者类，该类负责根据方法参数生成动态更新语句。
`@DeleteProvider`	用于指定一个动态 SQL 提供者类，该类负责根据方法参数生成动态删除语句。