【Spring 篇】深入探讨MyBatis映射文件中的动态SQL

Dear 丶 2024-04-27 15:56 4阅读 0赞

![在这里插入图片描述][00284c26956d4b778c232f61e9bac424.png]

MyBatis，这个名字在Java开发者的世界中犹如一道光芒，照亮着持久层操作的道路。而在MyBatis的映射文件中，动态SQL则是一个让人爱-hate的存在。有时候，你感叹它的灵活性，有时候，你可能会为它的繁琐而头痛。但别担心，我们将在本文中一起揭开动态SQL的神秘面纱，带你领略它的魅力。

最近想搞私域，欢迎各位大佬光临😀😀😀，大家有什么需求都会尽量帮忙！

![在这里插入图片描述][bd12a74a5325462096f95dfbf15952e0.png]

### 背景 ###

MyBatis的映射文件是定义SQL语句的地方，而动态SQL则是在这里展现威力的地方。为了更好地理解动态SQL，让我们先从MyBatis映射文件的基础开始。

#### 映射文件基础 ####

在MyBatis中，我们通过XML文件定义SQL语句，这些XML文件通常被称为映射文件。一个简单的映射文件示例如下：

<mapper namespace="com.example.UserMapper">
    
      
      <select id="selectAllUsers" resultType="User">
        SELECT * FROM users
      </select>
    
      
      <select id="selectUserById" resultType="User" parameterType="int">
        SELECT * FROM users WHERE id = #{id}
      </select>
    
      
      <insert id="insertUser" parameterType="User">
        INSERT INTO users (username, password) VALUES (#{username}, #{password})
      </insert>
    
      
      <update id="updateUser" parameterType="User">
        UPDATE users SET username = #{username}, password = #{password} WHERE id = #{id}
      </update>
    
      
      <delete id="deleteUser" parameterType="int">
        DELETE FROM users WHERE id = #{id}
      </delete>
    
    </mapper>

在这个映射文件中，我们定义了查询所有用户、根据用户ID查询用户、插入用户、更新用户和删除用户的SQL语句。每个SQL语句都有一个唯一的`id`，指定了该语句在Java代码中的调用标识。`resultType`用于指定查询结果的类型，而`parameterType`用于指定传入参数的类型。

### 动态SQL的诞生 ###

MyBatis早期版本中，静态SQL是唯一的选择。这意味着你必须在映射文件中写死所有的SQL语句，不管什么条件都一样。但是，随着项目的复杂性增加，开发者们迫切需要一种能够根据不同条件灵活生成SQL语句的机制。

这就是动态SQL的诞生原因。动态SQL允许我们在映射文件中使用一些特殊的标签，根据条件的不同动态生成SQL语句。这为我们提供了更大的灵活性，使得我们能够根据需要构建不同的SQL查询。

### 初识动态SQL ###

让我们从最简单的动态SQL标签开始，逐步深入了解它们的用法。

#### if标签 ####

`<if>`标签是动态SQL中最常用的标签之一。它允许我们在SQL语句中包含条件判断，根据条件的真假来动态生成SQL语句的一部分。

考虑一个场景：我们要查询用户列表，但是有时候我们只想查询特定状态的用户。这时候，我们可以使用`<if>`标签来动态添加条件：

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

在这个例子中，`<if>`标签检查了参数`status`是否不为null。如果不为null，就会动态添加`AND status = #{status}`到SQL语句中。这样，我们就可以根据需要选择性地添加条件。

#### choose、when、otherwise标签 ####

有时候我们需要在多个条件中选择一个执行，这时候就可以使用`<choose>`、`<when>`和`<otherwise>`标签组合起来使用。看一个例子：

<select id="selectUsersWithCondition" resultType="User">
      SELECT * FROM users
      <where>
        <choose>
          <when test="status != null">
            AND status = #{status}
          </when>
          <when test="username != null">
            AND username = #{username}
          </when>
          <otherwise>
            AND age > 18
          </otherwise>
        </choose>
      </where>
    </select>

在这个例子中，`<choose>`标签下的`<when>`标签会按顺序检查条件，当第一个条件为真时，执行相应的SQL语句；如果所有条件都为假，就执行`<otherwise>`标签下的SQL语句。这样，我们可以根据不同的条件来构建不同的查询。

#### trim标签 ####

`<trim>`标签提供了更灵活的文本处理能力。它通常用于处理SQL语句的前缀和后缀，使得我们可以根据条件来动态添加或删除这些部分。

考虑一个更新用户信息的场景，我们希望根据传入的参数动态更新用户的字段：

<update id="updateUserDynamic" parameterType="User">
      UPDATE users
      <set>
        <trim prefix="SET" suffixOverrides=",">
          <if test="username != null">
            username = #{username},
          </if>
          <if test="password != null">
            password = #{password},
          </if>
          <if test="email!= null">
            email = #{email},
          </if>
        </trim>
      </set>
      WHERE id = #{id}
    </update>

在这个例子中，`<trim>`标签被用于动态生成`SET`关键字后的更新语句。它的`prefix`属性指定了前缀，`suffixOverrides`属性指定了在所有子元素生成的文本中需要去除的后缀。这样，我们就能够根据传入的参数动态生成更新语句，只更新有值的字段。

#### foreach标签 ####

`<foreach>`标签用于处理集合类型的参数，通常用于在SQL语句中遍历集合生成对应的语句块。例如，我们想要根据一组用户ID查询用户列表：

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

在这个例子中，`<foreach>`标签用于遍历名为`idList`的集合，生成类似于`IN (1, 2, 3)`的语句块。这样，我们可以根据传入的ID列表动态生成查询条件。

### 实战演练 ###

为了更好地理解动态SQL的使用，让我们通过一个实际的例子来演示如何在映射文件中应用动态SQL。

假设我们有一个`User`实体类，包含了用户的ID、用户名、密码、邮箱和状态等信息。我们希望根据不同的查询条件，动态生成SQL语句。

首先，定义`User`实体类：

// User.java
    
    public class User {
        
      private Long id;
      private String username;
      private String password;
      private String email;
      private Integer status;
    
      // 省略 getter 和 setter 方法
    }

接下来，我们定义一个`UserMapper`接口和对应的映射文件`UserMapper.xml`：

// UserMapper.java
    
    public interface UserMapper {
        
      List<User> selectUsersByCondition(User user);
    
      // 省略其他方法
    }

<mapper namespace="com.example.UserMapper">
    
      <select id="selectUsersByCondition" resultType="User">
        SELECT * FROM users
        <where>
          <if test="id != null">
            AND id = #{id}
          </if>
          <if test="username != null">
            AND username = #{username}
          </if>
          <if test="password != null">
            AND password = #{password}
          </if>
          <if test="email != null">
            AND email = #{email}
          </if>
          <if test="status != null">
            AND status = #{status}
          </if>
        </where>
      </select>
    
      
    
    </mapper>

在这个例子中，我们定义了一个`selectUsersByCondition`方法，接受一个`User`对象作为参数。在映射文件中，通过使用`<where>`标签和多个`<if>`标签，我们能够根据`User`对象的属性是否为null来动态生成查询条件。这样，我们就可以根据传入的条件选择性地查询用户列表。

### 小结 ###

动态SQL是MyBatis中一个强大而灵活的特性，通过使用一系列的标签，我们能够根据不同的条件动态生成SQL语句，使得我们的数据库操作更加灵活和可扩展。在本文中，我们深入探讨了动态SQL的各种标签，包括`<if>`、`<choose>`、`<trim>`、`<foreach>`等，通过实际的例子演示了它们的用法。希望本文能够帮助你更好地理解和使用MyBatis中的动态SQL，让你在项目开发中更加游刃有余。如果你是MyBatis的初学者，相信你已经对动态SQL有了更清晰的认识，让它成为你数据库操作的得力助手。

<table> 
 <tbody> 
  <tr> 
   <td> <strong><font>作者信息</font></strong><br> <br> <font> 作者 ： 繁依Fanyi</font><br> <font>CSDN：</font> <a href="https://blog.csdn.net/qq_21484461?spm=1000.2115.3001.5343" rel="nofollow"><font>https://techfanyi.blog.csdn.net</font></a><br> <font>掘金：</font><a href="https://juejin.cn/user/4154386571867191" rel="nofollow"><font>https://juejin.cn/user/4154386571867191</font></a> </td> 
  </tr> 
 </tbody> 
</table>

[00284c26956d4b778c232f61e9bac424.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/d2bcb1c2dd81439cba8702e365a34ebd.png
[bd12a74a5325462096f95dfbf15952e0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/4d68bd26d4064b0e9bfa4f116f8e6b97.png