Mybatis常用标签与动态SQL详解

- 日理万妓 2023-10-06 15:19 46阅读 0赞

### Mybatis常用标签与动态SQL详解 ###

mybatis在工作中用到并不少, mybatis的动态SQL也写的并不少, 但是大多数时候只停留在那几个常用的标签上面，感觉有必要深入和全面了解一下mybatis常用标签，提高工作开发效率，去mybatis官网了解一番，结合自己工作中碰到的问题，写下这篇博客。

#### 1. mybatis查询常用标签 ####

##### 1.1 select标签 #####

**select元素的属性：**

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>命名空间中唯一的标识符，用来引用这条语句。</td> 
  </tr> 
  <tr> 
   <td>parameterType</td> 
   <td>参数的类全限定名或别名。非必填，默认值为未设置（unset）。</td> 
  </tr> 
  <tr> 
   <td>resultType</td> 
   <td>返回结果的类全限定名或别名。注意，如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型。resultType 和 resultMap 之间只能同时使用一个。</td> 
  </tr> 
  <tr> 
   <td>resultMap</td> 
   <td>对外部 resultMap 的命名引用。resultType 和 resultMap 之间只能同时使用一个。</td> 
  </tr> 
  <tr> 
   <td>flushCache</td> 
   <td>设置为true后, 语句被调用后清空本地缓存和二级缓存，默认值：false。</td> 
  </tr> 
  <tr> 
   <td>useCache</td> 
   <td>设置为 true 后，执行结果缓存到二级缓存中, 对 select 元素默认为 true。</td> 
  </tr> 
  <tr> 
   <td>timeout</td> 
   <td>驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。</td> 
  </tr> 
  <tr> 
   <td>fetchSize</td> 
   <td>让驱动程序每次批量返回的结果行数等于这个设置值。默认值为未设置（unset）（依赖驱动）。</td> 
  </tr> 
 </tbody> 
</table>

**应用实例：**

<select id="selectPerson" parameterType="int" resultType="hashmap">
      SELECT * FROM PERSON WHERE ID = #{id}
    </select>

这个语句名为 selectPerson，接受一个 int（或 Integer）类型的参数，并返回一个HashMap 类型的对象，其中的key是列名，value是结果行中的对应值。注意参数符号`#{id}`，默认情况下，使用 `#{}` 参数语法时，MyBatis 会创建 `PreparedStatement`参数占位符，并通过占位符安全地设置参数（就像使用`?`一样）

##### 1.2 insert, update 和 delete标签 #####

**Insert, Update, Delete 元素的属性**

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>命名空间中唯一的标识符，用来引用这条语句。</td> 
  </tr> 
  <tr> 
   <td>parameterType</td> 
   <td>参数的类全限定名或别名。非必填，默认值为未设置（unset）。</td> 
  </tr> 
  <tr> 
   <td>flushCache</td> 
   <td>设置为true后, 语句被调用后清空本地缓存和二级缓存，默认值：（对 insert、update 和 delete 语句）true。</td> 
  </tr> 
  <tr> 
   <td>timeout</td> 
   <td>驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。</td> 
  </tr> 
 </tbody> 
</table>

**应用实例：**

<insert id="insertAuthor" parameterType="User">
      insert into Author (id,username,password,email,bio)
      values (#{id},#{username},#{password},#{email},#{bio})
    </insert>
    
    <update id="updateAuthor" parameterType="User">
      update Author set
        username = #{username},
        password = #{password},
        email = #{email},
        bio = #{bio}
      where id = #{id}
    </update>
    
    <delete id="deleteAuthor">
      delete from Author where id = #{id}
    </delete>

##### 1.3 sql标签 #####

这个元素可以用来定义可重用的 SQL 代码片段，以便在其它语句中使用。 参数可以静态地（在加载的时候）确定下来，并且可以在不同的 include 元素中定义不同的参数值。比如：

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

这个 SQL 片段可以在其它语句中使用，例如：

<select id="selectUsers" resultType="map">
      select
        <include refid="userColumns"><property name="alias" value="t1"/></include>,
        <include refid="userColumns"><property name="alias" value="t2"/></include>
      from some_table t1
        cross join some_table t2
    </select>

也可以在 include 元素的 refid 属性或内部语句中使用属性值，例如：

<sql id="sometable">
      ${prefix}Table
    </sql>
    
    <sql id="someinclude">
      from
        <include refid="${include_target}"/>
    </sql>
    
    <select id="select" resultType="map">
      select
        field1, field2, field3
      <include refid="someinclude">
        <property name="prefix" value="Some"/>
        <property name="include_target" value="sometable"/>
      </include>
    </select>

##### 1.4 映射 #####

**1.4 简单映射：**

select查询的返回结果可以通过映射将表字段名与类属性名一一对应：

package com.someapp.model;
    @Data
    public class User {
        
      private int id;
      private String username;
      private String hashedPassword;
    }

<resultMap id="userResultMap" type="User">
      <id property="id" column="user_id" />
      <result property="username" column="user_name"/>
      <result property="password" column="hashed_password"/>
    </resultMap>
    
    <select id="selectUsers" resultMap="userResultMap">
      select id, username, hashedPassword
      from some_table
      where id = #{id}
    </select>

**1.4.2 复杂映射**

在实际开发中，有时候会碰到一些比较复杂的映射情况，由于复杂映射不是本文重点，需要的了解的请移步[Mybatis映射详解][Mybatis]。

#### 2. 动态SQL ####

##### 2.1 if #####

<select id="findActiveBlogWithTitleLike" resultType="Blog">
      SELECT * FROM BLOG
      WHERE state = ‘ACTIVE’
      <if test="title != null">
        AND title like #{title}
      </if>
    </select>

这条语句提供了可选的查找文本功能。如果不传入 “title”，那么所有处于 “ACTIVE” 状态的 BLOG 都会返回；如果传入了 “title” 参数，那么就会对 “title” 一列进行模糊查找并返回对应的 BLOG 结果。

##### 2.2 choose、when、otherwise #####

有时候，我们不想使用所有的条件，而只是想从多个条件中选择一个使用。针对这种情况，MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。

<select id="findActiveBlogLike"
         resultType="Blog">
      SELECT * FROM BLOG WHERE state = ‘ACTIVE’
      <choose>
        <when test="title != null">
          AND title like #{title}
        </when>
        <when test="author != null and author.name != null">
          AND author_name like #{author.name}
        </when>
        <otherwise>
          AND featured = 1
        </otherwise>
      </choose>
    </select>

##### 2.3 trim、where、set #####

<select id="findActiveBlogLike" resultType="Blog">
      SELECT * FROM BLOG
      <where>
        <if test="state != null">
             state = #{state}
        </if>
        <if test="title != null">
            AND title like #{title}
        </if>
        <if test="author != null and author.name != null">
            AND author_name like #{author.name}
        </if>
      </where>
    </select>

*where* 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且，若子句的开头为 “AND” 或 “OR”，*where* 元素也会将它们去除。

*prefixOverrides* 属性会忽略通过管道符分隔的文本序列（注意此例中的空格是必要的）。上述例子会移除所有 *prefixOverrides* 属性中指定的内容，并且插入 *prefix* 属性中指定的内容。

用于动态更新语句的类似解决方案叫做 *set*。*set* 元素可以用于动态包含需要更新的列，忽略其它不更新的列。比如：

<update id="updateAuthorIfNecessary">
      update Author
        <set>
          <if test="username != null">username=#{username},</if>
          <if test="password != null">password=#{password},</if>
          <if test="email != null">email=#{email},</if>
          <if test="bio != null">bio=#{bio}</if>
        </set>
      where id=#{id}
    </update>

这个例子中，*set* 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。

##### 2.4 foreach #####

动态 SQL 的另一个常见使用场景是对集合进行遍历（尤其是在构建 IN 条件语句的时候）。比如：

<select id="selectPostIn" resultType="domain.blog.Post">
      SELECT *
      FROM POST P
      WHERE ID in
      <foreach item="item" index="index" collection="list"
          open="(" separator="," close=")">
            #{item}
      </foreach>
    </select>

你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为集合参数传递给 *foreach*。当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。

[Mybatis]: https://blog.csdn.net/asxyxxx/article/details/121440014