MyBatis動態SQL(認真看看, 以後寫SQL就爽多了)

(給Java技術江湖加星標,提高Java技能)

轉自:博客園,作者:阿進得寫字檯 www.cnblogs.com/homejim/p/9909657.html

0 一起來學習 mybatis

你想不想來學習 mybatis? 學習其使用和源碼呢?

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

MyBatis通過 OGNL 來進行動態 SQL 的使用的。

目前, 動態 SQL 支持以下幾種標籤

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234714836-1175828725.png)

1 數據準備

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



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='學生表';

對應的項目結構

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234715083-1075473964.jpg)

2 if 標籤

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

2.1 在 WHERE 條件中使用 if 標籤

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

2.1.1 查詢條件

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

  1. 當只輸入用戶名時, 使用用戶名進行模糊檢索;

  2. 當只輸入性別時, 使用性別進行完全匹配;

  3. 當用戶名和性別都存在時, 用這兩個條件進行查詢匹配查詢。

2.1.2 動態 SQL

接口函數



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

對應的動態 SQL





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

同時, 我們添加了 if 標籤來處理動態 SQL




      and name like concat('%', #{name}, '%')
    
    
      and sex=#{sex}
    

此 if 標籤的 test 屬性值是一個符合 OGNL 的表達式, 表達式可以是 true 或 false。如果表達式返回的是數值, 則0爲 false, 非 0 爲 true;

2.1.3 測試



@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 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 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 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();
    }

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

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234715217-788671330.jpg)

查詢的條件只發送了



where 1=1 and sex=?

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

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234715361-108674566.png)

查詢條件



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 student
    
      
        `name` = #{name,jdbcType=VARCHAR},
      
      
        phone = #{phone,jdbcType=VARCHAR},
      
      
        email = #{email,jdbcType=VARCHAR},
      
      
        sex = #{sex,jdbcType=TINYINT},
      
      
        locked = #{locked,jdbcType=TINYINT},
      
      
        gmt_created = #{gmtCreated,jdbcType=TIMESTAMP},
      
      
        gmt_modified = #{gmtModified,jdbcType=TIMESTAMP},
      
    
    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();
    }

結果如下

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234715518-867713191.png)

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

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

2.3.1 插入條件

只有非空屬性才插入。

2.3.2 動態SQL

接口方法



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

對應的SQL




    insert into student
    
      
        student_id,
      
      
        `name`,
      
      
        phone,
      
      
        email,
      
      
        sex,
      
      
        locked,
      
      
        gmt_created,
      
      
        gmt_modified,
      
    
    
      
        #{studentId,jdbcType=INTEGER},
      
      
        #{name,jdbcType=VARCHAR},
      
      
        #{phone,jdbcType=VARCHAR},
      
      
        #{email,jdbcType=VARCHAR},
      
      
        #{sex,jdbcType=TINYINT},
      
      
        #{locked,jdbcType=TINYINT},
      
      
        #{gmtCreated,jdbcType=TIMESTAMP},
      
      
        #{gmtModified,jdbcType=TIMESTAMP},
      
    
  

這個 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("[email protected]");
        student.setLocked((byte) 0);

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

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

對應的結果

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234715675-423055613.jpg)

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





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 獲取,結果

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234715842-1142206725.jpg)

沒有 ID 則根據 name 獲取

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234716006-1588860457.jpg)

沒有 ID 和 name, 返回 null

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234716168-1348655089.png)

4 trim(set、where)

這三個其實解決的是類似的問題。如我們在寫前面的[在 WHERE 條件中使用 if 標籤] SQL 的時候, where 1=1 這個條件我們是不希望存在的。

4.1 where

4.1.1 查詢條件

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

  1. 當只輸入用戶名時, 使用用戶名進行模糊檢索;

  2. 當只輸入性別時, 使用性別進行完全匹配

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

不使用 where 1=1。

4.1.2 動態 SQL

很顯然, 我們要解決這幾個問題

  • 當條件都不滿足時:此時 SQL 中應該要不能有 where , 否則導致出錯

  • 當 if 有條件滿足時:SQL 中需要有 where, 且第一個成立的 if 標籤下的 and | or 等要去掉

這時候, 我們可以使用 where 標籤。

接口方法



/**
     * 根據輸入的學生信息進行條件檢索
     * 1\. 當只輸入用戶名時, 使用用戶名進行模糊檢索;
     * 2\. 當只輸入郵箱時, 使用性別進行完全匹配
     * 3\. 當用戶名和性別都存在時, 用這兩個條件進行查詢匹配的用
     */
    List selectByStudentSelectiveWhereTag(Student student);

對應的 SQL





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 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 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 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

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234716332-638289909.jpg)

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

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234716489-408606837.jpg)

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

4.2 set

set 標籤也類似, 在 [2.2 在 UPDATE 更新列中使用 if 標籤] 中, 如果我們的方法 updateByPrimaryKeySelective 沒有使用

4.3 trim

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

4.3.1 trim 來表示 where

如以上的 where 標籤, 我們也可以寫成






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

4.3.2 trim 來表示 set

相應的, set 標籤可以如下表示






表示當 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 selectByStudentIdList(List ids);

對應 SQL





5.1.3 測試



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

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

        List 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();
    }

結果

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234716673-776025400.jpg)

5.2 foreach 實現批量插入

可以通過foreach來實現批量插入。

5.2.1 動態SQL

接口方法



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

對應的SQL




    insert into student(name, phone, email, sex, locked)
    values
    
      (
      #{student.name}, #{student.phone},#{student.email},
      #{student.sex},#{student.locked}
      )
    
  

5.2.2 測試



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

        List students = new LinkedList<>();
        Student stu1 = new Student();
        stu1.setName("批量01");
        stu1.setPhone("13888888881");
        stu1.setLocked((byte) 0);
        stu1.setEmail("[email protected]");
        stu1.setSex((byte) 1);
        students.add(stu1);

        Student stu2 = new Student();
        stu2.setName("批量02");
        stu2.setPhone("13888888882");
        stu2.setLocked((byte) 0);
        stu2.setEmail("[email protected]");
        stu2.setSex((byte) 0);
        students.add(stu2);

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

結果

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234716848-2050334606.png)

6 bind 標籤

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

如在 selectByStudentSelective 方法中, 有如下




      and name like concat('%', #{name}, '%')
    

在 MySQL 中, 該函數支持多參數, 但在 Oracle 中只支持兩個參數。那麼我們可以使用 bind 來讓該 SQL 達到支持兩個數據庫的作用




     
     and name like #{nameLike}


更改後的查詢結果如下

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234717003-1934982608.jpg)

關注公衆號【Java技術江湖】後回覆“PDF”即可領取200+頁的《Java工程師面試指南》

強烈推薦,幾乎涵蓋所有Java工程師必知必會的知識點,不管是複習還是面試,都很實用。

![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234717179-1058447447.jpg)
![](https://img2018.cnblogs.com/blog/1813823/202001/1813823-20200102234717334-1795318590.gif)
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章