MyBatis動態SQL

時間 2019-11-16

標籤 mybatis 動態 sql 欄目 MyBatis 简体版

原文原文鏈接

MyBatis 使人喜歡的一大特性就是動態 SQL。在使用 JDBC 的過程當中，根據條件進行 SQL 的拼接是很麻煩且很容易出錯的。 MyBatis 動態 SQL 的出現，解決了這個麻煩。javascript

MyBatis經過 OGNL 來進行動態 SQL 的使用的。目前，動態 SQL 支持如下幾種標籤：php

1 數據準備

爲了後面的演示，建立了一個 Maven 項目 mybatis-dynamic, 建立了對應的數據庫和表java

DROP TABLE IF EXISTS `student`;

CREATE TABLE `student` (
  `student_id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '編號',
  `name` varchar(20) DEFAULT NULL COMMENT '姓名',
  `phone` varchar(20) DEFAULT NULL COMMENT '電話',
  `email` varchar(50) DEFAULT NULL COMMENT '郵箱',
  `sex` tinyint(4) DEFAULT NULL COMMENT '性別',
  `locked` tinyint(4) DEFAULT NULL COMMENT '狀態(0:正常,1:鎖定)',
  `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '存入數據庫的時間',
  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改的時間',
  `delete` int(11) DEFAULT NULL,
  PRIMARY KEY (`student_id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='學生表';

</pre>

對應的項目結構

![image](http://upload-images.jianshu.io/upload_images/15607355-99155f0f95251850?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

### 2 if 標籤

if 標籤是咱們最常使用的。 在查詢、刪除、更新的時候極可能會使用到。 必須結合 test 屬性聯合使用。

#### 2.1 在 WHERE 條件中使用 if 標籤

這是常見的一種現象， 咱們在進行按條件查詢的時候， 可能會有多種狀況。

##### 2.1.1 查詢條件

根據輸入的學生信息進行條件檢索

*   當只輸入用戶名時， 使用用戶名進行模糊檢索；

*   當只輸入性別時， 使用性別進行徹底匹配

*   當用戶名和性別都存在時， 用這兩個條件進行查詢匹配查詢

##### 2.1.2 動態 SQL

接口函數

<pre style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: 0.544000029563904px; orphans: auto; text-indent: 0px; text-transform: none; widows: 1; word-spacing: 0px; -webkit-text-stroke-width: 0px; font-size: 15px; color: rgb(62, 62, 62); line-height: inherit; text-align: start; background-color: rgb(255, 255, 255);">

    /** * 根據輸入的學生信息進行條件檢索 * 1. 當只輸入用戶名時， 使用用戶名進行模糊檢索； * 2. 當只輸入郵箱時， 使用性別進行徹底匹配 * 3. 當用戶名和性別都存在時， 用這兩個條件進行查詢匹配的用 * @param student * @return */
        List<Student> selectByStudentSelective(Student student);

</pre>

對應的動態 SQL

<pre style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: 0.544000029563904px; orphans: auto; text-indent: 0px; text-transform: none; widows: 1; word-spacing: 0px; -webkit-text-stroke-width: 0px; font-size: 15px; color: rgb(62, 62, 62); line-height: inherit; text-align: start; background-color: rgb(255, 255, 255);">

  <select id="selectByStudentSelective" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
    where 1=1
    <if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>
  </select>

複製代碼

在此 SQL 語句中， where 1=1 是多條件拼接時的小技巧，後面的條件查詢就能夠都用 and 了。web

同時，咱們添加了 if 標籤來處理動態 SQL面試

<if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>

</pre>

此 if 標籤的 test 屬性值是一個符合 OGNL 的表達式， 表達式能夠是 true 或 false。 若是表達式返回的是數值， 則0爲 false, 非 0 爲 true;

##### 2.1.3 測試

<pre style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: 0.544000029563904px; orphans: auto; text-indent: 0px; text-transform: none; widows: 1; word-spacing: 0px; -webkit-text-stroke-width: 0px; font-size: 15px; color: rgb(62, 62, 62); line-height: inherit; text-align: start; background-color: rgb(255, 255, 255);">

     @Test
    public void selectByStudent() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        Student search = new Student();
        search.setName("明");

        System.out.println("只有名字時的查詢");
        List<Student> studentsByName = studentMapper.selectByStudentSelective(search);
        for (int i = 0; i < studentsByName.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(studentsByName.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        search.setName(null);
        search.setSex((byte) 1);
        System.out.println("只有性別時的查詢");
        List<Student> studentsBySex = studentMapper.selectByStudentSelective(search);
        for (int i = 0; i < studentsBySex.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(studentsBySex.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        System.out.println("姓名和性別同時存在的查詢");
        search.setName("明");
        List<Student> studentsByNameAndSex = studentMapper.selectByStudentSelective(search);
        for (int i = 0; i < studentsByNameAndSex.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(studentsByNameAndSex.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

只有名字時的查詢，發送的語句和結果sql

查詢的條件只發送了數據庫

where 1=1 and name like concat('%', ?, '%') 

複製代碼

只有性別時的查詢，發送的語句和結果數組

查詢的條件只發送了bash

where 1=1 and sex=? 

複製代碼

姓名和性別同時存在的查詢，發送的語句和結果mybatis

image.gif

查詢條件

where 1=1 and name like concat('%', ?, '%') and sex=? 

複製代碼

2.2 在 UPDATE 更新列中使用 if 標籤

有時候咱們不但願更新全部的字段，只更新有變化的字段。

2.2.1 更新條件

只更新有變化的字段，空值不更新。

2.2.1 動態 SQL

接口方法

/** * 更新非空屬性 */
    int updateByPrimaryKeySelective(Student record);

複製代碼

對應的 SQL

<update id="updateByPrimaryKeySelective" parameterType="com.homejim.mybatis.entity.Student">
    update student
    <set>
      <if test="name != null">
        `name` = #{name,jdbcType=VARCHAR},
      </if>
      <if test="phone != null">
        phone = #{phone,jdbcType=VARCHAR},
      </if>
      <if test="email != null">
        email = #{email,jdbcType=VARCHAR},
      </if>
      <if test="sex != null">
        sex = #{sex,jdbcType=TINYINT},
      </if>
      <if test="locked != null">
        locked = #{locked,jdbcType=TINYINT},
      </if>
      <if test="gmtCreated != null">
        gmt_created = #{gmtCreated,jdbcType=TIMESTAMP},
      </if>
      <if test="gmtModified != null">
        gmt_modified = #{gmtModified,jdbcType=TIMESTAMP},
      </if>
    </set>
    where student_id = #{studentId,jdbcType=INTEGER}

複製代碼

2.2.3 測試

@Test
    public void updateByStudentSelective() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        Student student = new Student();
        student.setStudentId(1);
        student.setName("明明");
        student.setPhone("13838438888");
        System.out.println(studentMapper.updateByPrimaryKeySelective(student));

        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

結果以下

2.3 在 INSERT 動態插入中使用 if 標籤

咱們插入數據庫中的一條記錄，不是每個字段都有值的，而是動態變化的。在這時候使用 if 標籤，可幫咱們解決這個問題。

2.3.1 插入條件

只有非空屬性才插入。

2.3.2 動態SQL

接口方法

/** * 非空字段才進行插入 */
    int insertSelective(Student record);

複製代碼

對應的SQL

<insert id="insertSelective" parameterType="com.homejim.mybatis.entity.Student">
    insert into student
    <trim prefix="(" suffix=")" suffixOverrides=",">
      <if test="studentId != null">
        student_id,
      </if>
      <if test="name != null">
        `name`,
      </if>
      <if test="phone != null">
        phone,
      </if>
      <if test="email != null">
        email,
      </if>
      <if test="sex != null">
        sex,
      </if>
      <if test="locked != null">
        locked,
      </if>
      <if test="gmtCreated != null">
        gmt_created,
      </if>
      <if test="gmtModified != null">
        gmt_modified,
      </if>
    </trim>
    <trim prefix="values (" suffix=")" suffixOverrides=",">
      <if test="studentId != null">
        #{studentId,jdbcType=INTEGER},
      </if>
      <if test="name != null">
        #{name,jdbcType=VARCHAR},
      </if>
      <if test="phone != null">
        #{phone,jdbcType=VARCHAR},
      </if>
      <if test="email != null">
        #{email,jdbcType=VARCHAR},
      </if>
      <if test="sex != null">
        #{sex,jdbcType=TINYINT},
      </if>
      <if test="locked != null">
        #{locked,jdbcType=TINYINT},
      </if>
      <if test="gmtCreated != null">
        #{gmtCreated,jdbcType=TIMESTAMP},
      </if>
      <if test="gmtModified != null">
        #{gmtModified,jdbcType=TIMESTAMP},
      </if>
    </trim>
  </insert>
複製代碼

這個 SQL 你們應該很熟悉，畢竟是自動生成的。

2.3.3 測試

@Test
    public void insertByStudentSelective() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        Student student = new Student();
        student.setName("小飛機");
        student.setPhone("13838438899");
        student.setEmail("xiaofeiji@qq.com");
        student.setLocked((byte) 0);

        System.out.println(studentMapper.insertSelective(student));

        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

對應的結果

SQL 中，只有非空的字段才進行了插入。

3 choose 標籤

choose when otherwise 標籤能夠幫咱們實現 if else 的邏輯。一個 choose 標籤至少有一個 when, 最多一個otherwise。

下面是一個查詢的例子。

3.1 查詢條件

假設 name 具備惟一性，查詢一個學生

當 studen_id 有值時，使用 studen_id 進行查詢；
當 studen_id 沒有值時，使用 name 進行查詢；
不然返回空

3.2 動態SQL

接口方法

/** * - 當 studen_id 有值時， 使用 studen_id 進行查詢； * - 當 studen_id 沒有值時， 使用 name 進行查詢； * - 不然返回空 */
    Student selectByIdOrName(Student record);

複製代碼

對應的SQL

<select id="selectByIdOrName" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
    where 1=1
    <choose>
      <when test="studentId != null">
        and student_id=#{studentId}
      </when>
      <when test="name != null and name != ''">
        and name=#{name}
      </when>
      <otherwise>
        and 1=2
      </otherwise>
    </choose>
  </select>
複製代碼

3.3 測試

@Test
    public void selectByIdOrName() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        Student student = new Student();
        student.setName("小飛機");
        student.setStudentId(1);

        Student studentById = studentMapper.selectByIdOrName(student);
        System.out.println("有 ID 則根據 ID 獲取");
        System.out.println(ToStringBuilder.reflectionToString(studentById, ToStringStyle.MULTI_LINE_STYLE));

        student.setStudentId(null);
        Student studentByName = studentMapper.selectByIdOrName(student);
        System.out.println("沒有 ID 則根據 name 獲取");
        System.out.println(ToStringBuilder.reflectionToString(studentByName, ToStringStyle.MULTI_LINE_STYLE));

        student.setName(null);
        Student studentNull = studentMapper.selectByIdOrName(student);
        System.out.println("沒有 ID 和 name, 返回 null");
        Assert.assertNull(studentNull);

        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

有 ID 則根據 ID 獲取，結果

沒有 ID 則根據 name 獲取

沒有 ID 和 name, 返回 null

4 trim(set、where)

這三個其實解決的是相似的問題。如咱們在寫前面的[在 WHERE 條件中使用 if 標籤] SQL 的時候， where 1=1 這個條件咱們是不但願存在的。

4.1 where

4.1.1 查詢條件

根據輸入的學生信息進行條件檢索。

當只輸入用戶名時，使用用戶名進行模糊檢索；
當只輸入性別時，使用性別進行徹底匹配
當用戶名和性別都存在時，用這兩個條件進行查詢匹配查詢

不使用 where 1=1。

4.1.2 動態 SQL

很顯然，咱們要解決這幾個問題

當條件都不知足時：此時 SQL 中應該要不能有 where ，不然致使出錯
當 if 有條件知足時： SQL 中須要有 where，且第一個成立的 if 標籤下的 and | or 等要去掉
這時候，咱們能夠使用 where 標籤。

接口方法

/** * 根據輸入的學生信息進行條件檢索 * 1. 當只輸入用戶名時， 使用用戶名進行模糊檢索； * 2. 當只輸入郵箱時， 使用性別進行徹底匹配 * 3. 當用戶名和性別都存在時， 用這兩個條件進行查詢匹配的用 */
    List<Student> selectByStudentSelectiveWhereTag(Student student);
複製代碼

對應的 SQL

<select id="selectByStudentSelectiveWhereTag" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
   <where>
    <if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>
   </where>
  </select>
複製代碼

4.1.3 測試

@Test
    public void selectByStudentWhereTag() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        Student search = new Student();
        search.setName("明");

        System.out.println("只有名字時的查詢");
        List<Student> studentsByName = studentMapper.selectByStudentSelectiveWhereTag(search);
        for (int i = 0; i < studentsByName.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(studentsByName.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        search.setSex((byte) 1);
        System.out.println("姓名和性別同時存在的查詢");
        List<Student> studentsBySex = studentMapper.selectByStudentSelectiveWhereTag(search);
        for (int i = 0; i < studentsBySex.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(studentsBySex.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        System.out.println("姓名和性別都不存在時查詢");
        search.setName(null);
        search.setSex(null);
        List<Student> studentsByNameAndSex = studentMapper.selectByStudentSelectiveWhereTag(search);
        for (int i = 0; i < studentsByNameAndSex.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(studentsByNameAndSex.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

只有名字時的查詢, 有 where

姓名和性別同時存在的查詢，有 where

姓名和性別都不存在時查詢, 此時， where 不會再出現了。

4.2 set

set 標籤也相似，在 [2.2 在 UPDATE 更新列中使用 if 標籤] 中，若是咱們的方法 updateByPrimaryKeySelective 沒有使用

4.3 trim

set 和 where 其實都是 trim 標籤的一種類型，該兩種功能均可以使用 trim 標籤進行實現。

4.3.1 trim 來表示 where

如以上的 where 標籤，咱們也能夠寫成

<trim prefix="where" prefixOverrides="AND |OR">
</trim>

複製代碼

表示當 trim 中含有內容時，添加 where，且第一個爲 and 或 or 時，會將其去掉。而若是沒有內容，則不添加 where。

4.3.2 trim 來表示 set

相應的， set 標籤能夠以下表示

<trim prefix="SET" suffixOverrides=",">
</trim>
複製代碼

表示當 trim 中含有內容時，添加 set，且最後的內容爲 , 時，會將其去掉。而沒有內容，不添加 set

4.3.3 trim 的幾個屬性

prefix: 當 trim 元素包含有內容時，增長 prefix 所指定的前綴
prefixOverrides: 當 trim 元素包含有內容時，去除 prefixOverrides 指定的前綴
suffix: 當 trim 元素包含有內容時，增長 suffix 所指定的後綴
suffixOverrides：當 trim 元素包含有內容時，去除 suffixOverrides 指定的後綴

5 foreach 標籤

foreach 標籤能夠對數組， Map 或實現 Iterable 接口。

foreach 中有如下幾個屬性：

collection: 必填，集合/數組/Map的名稱.
item: 變量名。即從迭代的對象中取出的每個值
index: 索引的屬性名。當迭代的對象爲 Map 時，該值爲 Map 中的 Key.
open: 循環開頭的字符串
close: 循環結束的字符串
separator: 每次循環的分隔符

其餘的比較好理解， collection 中的值應該怎麼設定呢？

跟接口方法中的參數相關。

1. 只有一個數組參數或集合參數

默認狀況：集合collection=list，數組是collection=array

推薦：使用 @Param 來指定參數的名稱，如咱們在參數前@Param("ids")，則就填寫 collection=ids

2. 多參數

多參數請使用 @Param 來指定，不然SQL中會很不方便

3. 參數是Map

指定爲 Map 中的對應的 Key 便可。其實上面的 @Param 最後也是轉化爲 Map 的。

4. 參數是對象

使用屬性.屬性便可。

5.1 在 where 中使用 foreach

在 where條件中使用，如按id集合查詢，按id集合刪除等。

5.1.1 查詢條件

咱們但願查詢用戶 id 集合中的全部用戶信息。

5.1.2 動態 SQL

函數接口

/** * 獲取 id 集合中的用戶信息 * @param ids * @return */
    List<Student> selectByStudentIdList(List<Integer> ids);

複製代碼

對應 SQL

<select id="selectByStudentIdList" resultMap="BaseResultMap">
    select
    <include refid="Base_Column_List" />
    from student
    where student_id in
    <foreach collection="list" item="id" open="(" close=")" separator="," index="i">
      #{id}
    </foreach>
  </select>

複製代碼

5.1.3 測試

@Test
    public void selectByStudentIdList() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        List<Integer> ids = new LinkedList<>();
        ids.add(1);
        ids.add(3);

        List<Student> students = studentMapper.selectByStudentIdList(ids);
        for (int i = 0; i < students.size(); i++) {
            System.out.println(ToStringBuilder.reflectionToString(students.get(i), ToStringStyle.MULTI_LINE_STYLE));
        }

        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

結果

5.2 foreach 實現批量插入

能夠經過foreach來實現批量插入。

5.2.1 動態SQL

接口方法

/** * 批量插入學生 */
    int insertList(List<Student> students);

複製代碼

對應的SQL

<insert id="insertList">
    insert into student(name, phone, email, sex, locked)
    values
    <foreach collection="list" item="student" separator=",">
      (
      #{student.name}, #{student.phone},#{student.email},
      #{student.sex},#{student.locked}
      )
    </foreach>
  </insert>

複製代碼

5.2.2 測試

@Test
    public void insertList() {
        SqlSession sqlSession = null;
        sqlSession = sqlSessionFactory.openSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);

        List<Student> students = new LinkedList<>();
        Student stu1 = new Student();
        stu1.setName("批量01");
        stu1.setPhone("13888888881");
        stu1.setLocked((byte) 0);
        stu1.setEmail("13888888881@138.com");
        stu1.setSex((byte) 1);
        students.add(stu1);

        Student stu2 = new Student();
        stu2.setName("批量02");
        stu2.setPhone("13888888882");
        stu2.setLocked((byte) 0);
        stu2.setEmail("13888888882@138.com");
        stu2.setSex((byte) 0);
        students.add(stu2);

        System.out.println(studentMapper.insertList(students));
        sqlSession.commit();
        sqlSession.close();
    }

複製代碼

結果

6 bind 標籤

bind 標籤是經過 OGNL 表達式去定義一個上下文的變量，這樣方便咱們使用。

如在 selectByStudentSelective 方法中，有以下

<if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>

複製代碼

在 MySQL 中，該函數支持多參數，但在 Oracle 中只支持兩個參數。那麼咱們能夠使用 bind 來讓該 SQL 達到支持兩個數據庫的做用

<if test="name != null and name !=''">
     <bind name="nameLike" value="'%'+name+'%'"/>
     and name like #{nameLike}
</if>

複製代碼

更改後的查詢結果以下

以爲不錯請點贊支持，歡迎留言或進個人我的羣855801563領取【架構資料專題目合集90期】、【BATJTMD大廠JAVA面試真題1000+】，本羣專用於學習交流技術、分享面試機會，拒絕廣告，我也會在羣內不按期答題、探討。

相關標籤/搜索

動態SQL

動態

springmvc+mybatis+sql

springmvc4+mybatis+sql

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。