2. 程式人生 > >超全MyBatis動態SQL詳解

超全MyBatis動態SQL詳解

阿新 • • 發佈：2019-04-21
標簽 2.3 去除 mean not null 3.2 false foreach rtl

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

MyBatis通過 OGNL 來進行動態 SQL 的使用的。目前， 動態 SQL 支持以下幾種標簽：

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

對應的項目結構

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

2.1 在 WHERE 條件中使用 if 標簽

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

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

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

當只輸入性別時， 使用性別進行完全匹配

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

2.1.2 動態 SQL
接口函數

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

對應的動態 SQL

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

同時， 我們添加了 if 標簽來處理動態 SQL

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

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

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

查詢的條件只發送了

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

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

查詢的條件只發送了

where 1=1 and sex=?

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

查詢條件

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

結果如下

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

對應的結果

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

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

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 中含有內容時， 添加 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

  1. 多參數
    多參數請使用 @Param 來指定， 否則SQL中會很不方便

  2. 參數是Map
    指定為 Map 中的對應的 Key 即可。其實上面的 @Param 最後也是轉化為 Map 的。

  3. 參數是對象
    使用屬性.屬性即可。

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

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

結果

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

如在 selectByStudentSelective 方法中， 有如下


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

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



and name like #{nameLike}

更改後的查詢結果如下

7 代碼
使用示例：

https://github.com/homejim/mybatis-examples

超全MyBatis動態SQL詳解

相關推薦

超全MyBatis動態SQL詳解

標簽 2.3 去除 mean not null 3.2 false foreach rtl MyBatis 令人喜歡的一大特性就是動態 SQL。在使用 JDBC 的過程中， 根據條件進行 SQL 的拼接是很麻煩且很容易出錯的。MyBatis 動態 SQL 的出現， 解決了這

Mybatis 動態SQL詳解

id ：在名稱空間中唯一的識別符號，可以用來引用這條語句parameterType：將會傳入這條SQL語句的引數類的完全限定名或別名parameterMap：這是引用外部parameterMap的已經廢棄的方法，使用內聯引數對映和ParameterType屬性。resultType：從這條語句返回的期望型別的

Mybatis---動態SQL詳解(四)

（一）動態SQL簡介     使用JDBC對資料庫進行操作,通常需要根據需求手動的拼接SQL或重新編寫SQL語句，這是一項非常無聊和麻煩的操作，但是Mybatis提供了對SQL語句動態組裝的功能，恰好解決這一項麻煩的操作。 參考： Mybatis官方文件

Mybatis的動態SQL詳解

使用動態SQL完成多條件查詢 動態SQL是MyBatis的一個強大的特性。動態SQL基於OGNL的表示式。實現動態SQL的元素如下。 if：利用if實現簡單的條件選擇 choose(when,otherwise)：相當於Java中的switch語句，通常與when和otherwise搭配 where：簡化

Oracle中動態SQL詳解(EXECUTE IMMEDIATE)

Oracle中動態SQL詳解(EXECUTE IMMEDIATE) 2017年05月02日 18:35:48 悠悠傾我心 閱讀數：744 標籤： oracle動態sqloracle 更多

mybatis動態sql以及reslutType和resultMap詳解

全域性配置檔案,以及sql.properties <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration

MyBatis動態SQL————MyBatis動態SQL標簽的用法

efi 數組 cnblogs 朋友 正常 scm jdbc pojo 動態語言 1.MyBatis動態SQL MyBatis 的強大特性之一便是它的動態 SQL，即拼接SQL字符串。如果你有使用 JDBC 或其他類似框架的經驗，你就能體會到根據不同條件拼接 SQL 語句有多

4.mybatis動態SQL拼接/取值/OGNL

align log 值方法 enter png 動態 mybatis框架 -a ognl 4.mybatis動態SQL拼接/取值 一、mybatis框架的SQL拼接是采用OGNL表達式進行的，以下我會列出常用的取值方法。 圖片來源：慕課網 1.1常用的取值方法： 1.2特

MyBatis-動態SQL

convert 指定 app 數組 bject end sep name over 動態SQL是MyBatis的一個強大的特性。MyBatis 使用了基於強大的 OGNL（Object-Graph Navigation Language 的縮寫，它是一種功能強大的表達式語言

【codeup】1959: 全排列 及全排列算法詳解

MyBatis基礎：MyBatis動態SQL（3）

span column foreach param ati when nbsp base condition 1. 概述 　　MyBatis中動態SQL包括元素： 元素作用備註 if 判斷語句 單條件分支判斷 choose（when、othe

MyBatis之Mapper詳解及常用技巧

mybatis mapperselect先看一個簡單的案例:<select id="selectPerson" parameterType="int" resultType="hashmap"> SELECT * FROM PERSON WHERE ID = #{id} </selec

MyBatis動態SQL

lis array bat cti mybatis 映射 foreach 替代 進行 　MyBatis在SQL映射文件中可以使用靈活，智能的動態SQL來實現SQL映射。 　　if+set:完成更新操作 　　if+where：完成多條查詢 　　if+trim：完成多條件查詢（

MyBatis 動態SQL

互斥 pda 1.3 null del 復制代碼 條件 rri mybatis MyBatis動態SQL： 　　動態SQL是在運行時生成和執行SQL的編程方法 　　 動態是和靜態相對而言的。靜態SQL指的是在代碼編譯時刻就已經包含在代碼中的那些已經充分明確的固定的SQ

mybatis動態sql排序無效

ati 例如 str 但是 sql ron 們的 問題 生成 order by 字段，在用動態sql時會出現問題，排序無效，而且在日誌裏查詢不到，不能發現這個錯誤。 通常，咱們的動態sql一般都會用#代替$,因為#可以防止sql註入問題。 但是在order by的字段裏，如

mybatis 動態sql 插入報錯

method div exce 必須 字段 timeval blog ora eval 1. 值為null必須制定jdbcType 單條執行的話，可以考慮把值為null的字段去掉 2. 值的類型無法解析 比如oracle.sql.TIMESTAMP類型，需轉

mybatis動態SQL操作之插入學習筆記

動態SQL操作之插入學習筆記1 import java.util.ArrayList; import java.util.List; import org.apache.ibatis.session.SqlSession; import cn.itcast.javaee.mybatis.util.Myb

Spring Boot中使用MyBatis註解配置詳解（1）

sql type .org 實體 sch 整合 PE 匯總 同傳 之前在Spring Boot中整合MyBatis時，采用了註解的配置方式，相信很多人還是比較喜歡這種優雅的方式的，也收到不少讀者朋友的反饋和問題，主要集中於針對各種場景下註解如何使用，下面就對幾種常見的情況舉

mybatis動態sql之foreach標簽

別名 per HA 次數 .get type 對象傳遞 CI select foreach 元素的功能非常強大，它允許你指定一個集合，聲明可以在元素體內使用的集合項（item）和索引（index）變量。它也允許你指定開頭與結尾的字符串以及在叠代結果之間放置分隔符。這個元素是

MyBatis動態sql之${}和#{}區別

where 語句 替換字符串 客戶端 字符 註釋 tab reason mybatis 前言 ? 接觸mybatis也是在今年步入社會之後，想想也半年多了，缺沒時間去系統的學習，只知道大概，也是慚愧。 ? 不知道有多少剛畢業的同學和我一樣，到現在還沒仔仔細細去了解你每天都會