2. 程式人生 > 程式設計 >Mybatis 動態SQL的幾種實現方法

Mybatis 動態SQL的幾種實現方法

阿新 • • 發佈：2020-11-06

案例sql指令碼

DROP DATABASE IF EXISTS `javacode2018`;
CREATE DATABASE `javacode2018`;

USE `javacode2018`;

DROP TABLE IF EXISTS t_user;
CREATE TABLE t_user(
 id int AUTO_INCREMENT PRIMARY KEY COMMENT '使用者id',name VARCHAR(32) NOT NULL DEFAULT '' COMMENT '使用者名稱',age SMALLINT NOT NULL DEFAULT 1 COMMENT '年齡'
) COMMENT '使用者表';
INSERT INTO t_user VALUES (1,'路人甲Java',30),(2,'張學友',50),(3,'劉德華',50);

if元素

相當於java中的if判斷，語法：

<if test="判斷條件">
需要追加的sql
</if>

test的值為一個判斷表示式，寫法上採用OGNL表示式的方式，OGNL在struts2中用的比較多，本文暫時對ognl不做詳細介紹，有興趣的可以去查一下相關資料。

當test成立的時候，if體內部的sql會被拼接上。

如：

<select id="getList1" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,name,age FROM t_user
  WHERE 1 = 1
  <if test="id!=null">
    AND id = #{id}
  </if>
  <if test="name!=null and name.toString()!=''">
    AND name = #{name}
  </if>
  <if test="age!=null">
    AND age = #{age}
  </if>
</select>

上面查詢使用者列表，引數為一個map，當map中id不為空的時候，將其作為條件查詢，如果name不為空，將name也作為條件，如果age不為空，將age也作為條件進行查詢

當只傳入id的時候，sql如下：

SELECT id,age FROM t_user WHERE 1 = 1 AND id = ?

當3個引數都傳了，sql如下：

SELECT id,age FROM t_user WHERE 1 = 1 AND id = ? AND name = ? AND age = ?

上面這種寫法相對於java程式碼看起來是不是清爽了很多，也更方便維護，大家注意一下sql中有個WHERE 1=1，如果沒有這個，上面單通過if元素就不好實現了，mybatis也有解決方案，稍後會說明。

choose/when/otherwise元素

這個相當於java中的if…else if…else，語法：

<choose>
  <when test="條件1">
    滿足條件1追加的sql
  </when>
  <when test="條件2">
    滿足條件2追加的sql
  </when>
  <when test="條件n">
    滿足條件n追加的sql
  </when>
  <otherwise>
    都不滿足追加的sql
  </otherwise>
</choose>

choose內部的條件滿足一個，choose內部的sql拼接就會結束。

otherwise屬於可選的，當所有條件都不滿足的時候，otherwise將起效。

如：

傳入id、name、age作為條件，按順序進行判斷，如果id不為空，將id作為條件，忽略其他條件，如果id為空，會判斷name是否為空，name不為空將name作為條件，如果name為空，再看看age是否為空，如果age不為空，將age作為條件。

<select id="getList2" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  WHERE 1 = 1
  <choose>
    <when test="id!=null">
      AND id = #{id}
    </when>
    <when test="name!=null and name.toString()!=''">
      AND name = #{name}
    </when>
    <when test="age!=null">
      AND age = #{age}
    </when>
  </choose>
</select>

如果id、name、age都傳了，sql如下：

SELECT id,age FROM t_user WHERE 1 = 1 AND id = ?

如果值傳遞了name、age，sql如下：

SELECT id,age FROM t_user WHERE 1 = 1 AND name = ?

name判斷在age前面，所以name條件先匹配上了。

where元素

上面2個案例的sql中都有where 1=1這部分程式碼，雖然可以解決問題，但是看起來不美觀，如果將where 1=1中1=1這部分幹掉，上面的兩個案例都會出問題，where後面會多一個AND符號，mybatis中已經考慮到這種問題了，屬於通用性的問題，mybatis中通過where 元素來解決，當使用where元素的時候，mybatis會將where內部拼接的sql進行處理，會將這部分sql前面的AND 或者 OR給去掉，並在前面追加一個where，我們使用where元素來對上面的案例1進行改造，如下：

<select id="getList1" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  <where>
    <if test="id!=null">
      AND id = #{id}
    </if>
    <if test="name!=null and name.toString()!=''">
      AND name = #{name}
    </if>
    <if test="age!=null">
      AND age = #{age}
    </if>
  </where>
</select>

where 1=1被替換成了where 元素。

當傳入id、name的時候，where內部的sql會變成這樣：

AND id = ? AND name = ?

mybatis會對上面這個sql進行處理，將前面的AND給去掉，並在前面追加一個where，變成了下面這樣

where id = ? AND name = ?

案例2也用where改造一下，變成了下面這樣：

<select id="getList2" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  <where>
    <choose>
      <when test="id!=null">
        AND id = #{id}
      </when>
      <when test="name!=null and name.toString()!=''">
        AND name = #{name}
      </when>
      <when test="age!=null">
        AND age = #{age}
      </when>
    </choose>
  </where>
</select>

這下看起來是不是舒服很多了。

set元素

現在我們想通過使用者id更新使用者資訊，引數為UserModel物件，物件中的屬性如果不為空，就進行更新，我們可以這麼寫：

<update id="update1" parameterType="com.javacode2018.chat05.demo8.model.UserModel">
  UPDATE t_user SET
  <if test="name!=null">
    name = #{name},</if>
  <if test="age!=null">
    age = #{age},</if>
  <where>
    <if test="id!=null">
      AND id = #{id}
    </if>
  </where>
</update>

我們來看一下，當所有屬性都傳值了，sql變成了下面這樣：

UPDATE t_user SET name = ?,age = ?,where id = ?

上面這個sql是有問題的，where前面多了一個逗號，得想辦法將這個逗號去掉，這個逗號屬於最後一個需要更新的欄位後面的逗號，屬於多餘的，mybatis中提供了set元素來解決這個問題，將上面的程式碼改成下面這樣：

<update id="update1" parameterType="com.javacode2018.chat05.demo8.model.UserModel">
  UPDATE t_user
  <set>
    <if test="name!=null">
      name = #{name},</if>
    <if test="age!=null">
      age = #{age},</if>
  </set>
  <where>
    <if test="id!=null">
      AND id = #{id}
    </if>
  </where>
</update>

我們將sql中的set去掉了，加了個set元素，set元素會對其內部拼接的sql進行處理，會將這部分sql前後的逗號給去掉並在前面加上set。

當傳入id和age的時候，生成的sql：

UPDATE t_user SET age = ? where id = ?

trim元素

這個元素的功能比較強大，先看一下他的語法：

<trim prefix="" prefixOverrides="" suffix="" suffixOverrides="">
</trim>

trim元素內部可以包含各種動態sql，如where、chose、sql等各種元素，使用trim包含的元素，mybatis處理過程：

1.先對trim內部的sql進行拼接，比如這部分sql叫做sql1

2.將sql1字串前面的部分中包含trim的prefixOverrides指定的部分給去掉，得到sql2

3.將sql2字串後面的部分中包含trim的suffixOverrides指定的部分給去掉，得到sql3

4.在sql3前面追加trim中prefix指定的值，得到sql4

5.在sql4後面追加trim中suffix指定的值，得到最終需要拼接的sql5

瞭解了這個過程之後，說明可以通過trim來代替where和set，我們使用trim來改造一下案例1，如下：

<select id="getList1" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  <trim prefix="where" prefixOverrides="and|or">
    <if test="id!=null">
      AND id = #{id}
    </if>
    <if test="name!=null and name.toString()!=''">
      AND name = #{name}
    </if>
    <if test="age!=null">
      AND age = #{age}
    </if>
  </trim>
</select>

注意上面的prefixOverrides的值的寫法，如果有多個需要覆蓋的之間用|進行分割，suffixOverrides寫法和prefixOverrides的寫法類似。

我們在用trim來改造一下上面的update中的，如下：

<update id="update1" parameterType="com.javacode2018.chat05.demo8.model.UserModel">
  UPDATE t_user
  <trim prefix="SET" prefixOverrides="," suffixOverrides=",">
    <if test="name!=null">
      name = #{name},</if>
  </trim>
  <where>
    <if test="id!=null">
      AND id = #{id}
    </if>
  </where>
</update>

上面的prefixOverrides和suffixOverrides都設定的是逗號，表示trim內部的sql前後的逗號會被去掉，最後會在前面拼接一個prefix指定的set。

大家有興趣的可以去看一下trim的java實現，程式碼下面這個類中：

org.apache.ibatis.scripting.xmltags.TrimSqlNode

實際上where和set的實現是繼承了TrimSqlNode，where對應的java程式碼：

public class WhereSqlNode extends TrimSqlNode {

 private static List<String> prefixList = Arrays.asList("AND ","OR ","AND\n","OR\n","AND\r","OR\r","AND\t","OR\t");

 public WhereSqlNode(Configuration configuration,SqlNode contents) {
  super(configuration,contents,"WHERE",prefixList,null,null);
 }

}

set對應的 java程式碼：

public class SetSqlNode extends TrimSqlNode {

 private static final List<String> COMMA = Collections.singletonList(",");

 public SetSqlNode(Configuration configuration,"SET",COMMA,COMMA);
 }

}

最後都是依靠TrimSqlNode來實現的。

foreach元素

相當於java中的迴圈，可以用來遍歷陣列、集合、map等。

語法

<foreach collection="需要遍歷的集合" item="集合中當前元素" index="" open="" separator="每次遍歷的分隔符" close="">
動態sql部分
</foreach>
  • collection：可以是一個List、Set、Map或者陣列
  • item：集合中的當前元素的引用
  • index：用來訪問當前元素在集合中的位置
  • separator：各個元素之間的分隔符
  • open和close用來配置最後用什麼字首和字尾將foreach內部所有拼接的sql給包裝起來。

案例：in多值查詢

我們對案例1做個改造，map中支援放入使用者的id列表（ArrayList），對應的key為idList，然後支援多個使用者id查詢，此時我們需要用in來查詢，實現如下：

<select id="getList1" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  <where>
    <if test="id!=null">
      AND id = #{id}
    </if>
    <if test="name!=null and name.toString()!=''">
      AND name = #{name}
    </if>
    <if test="age!=null">
      AND age = #{age}
    </if>
    <if test="idList!=null and idList.size()>=1">
      <foreach collection="idList" item="id" open="AND id in (" separator="," close=")">
        #{id}
      </foreach>
    </if>
  </where>
</select>

大家看一下上面idList那部分判斷，判斷這個引數不為空，並且size()大於1，表示這個集合不為空，然後會走if元素內部的foreach元素。

比如我們傳遞的idList對應的是[1,2]，最後產生的sql如下：

SELECT id,age FROM t_user WHERE id in ( ?,? )

案例：批量插入

傳入UserModel List集合，使用foreach實現批量插入，如下：

<insert id="insertBatch" parameterType="list">
  INSERT INTO t_user (id,age) VALUES
  <foreach collection="collection" separator="," item="item">
    (#{item.id},#{item.name},#{item.age})
  </foreach>
</insert>

測試用例

com.javacode2018.chat05.demo8.Demo8Test#insertBatch

@Test
public void insertBatch() throws IOException {
  try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<UserModel> userModelList = new ArrayList<>();
    for (int i = 0; i < 3; i++) {
      userModelList.add(UserModel.builder().id(10 + i).name("mybatis-" + i).age(20 + i).build());
    }
    int count = mapper.insertBatch(userModelList);
    log.info("{}",count);
  }
}

傳入了3個使用者資訊，執行輸出

39:52.241 [main] DEBUG c.j.c.d.m.UserMapper.insertBatch - ==> Preparing: INSERT INTO t_user (id,age) VALUES (?,?,?),(?,?)
39:52.317 [main] DEBUG c.j.c.d.m.UserMapper.insertBatch - ==> Parameters: 10(Integer),mybatis-0(String),20(Integer),11(Integer),mybatis-1(String),21(Integer),12(Integer),mybatis-2(String),22(Integer)
39:52.327 [main] DEBUG c.j.c.d.m.UserMapper.insertBatch - <== Updates: 3
39:52.327 [main] INFO c.j.chat05.demo8.Demo8Test - 3

sql/include元素

這兩2個元素一般進行配合使用，可以實現程式碼重用的效果。

sql元素可以用來定義一段動態sql，語法如下：

<sql id="sql片段id">
各種動態sql
</sql>

其他地方需要使用的時候需要通過include關鍵字進行引入：

<include refid="需要引入的sql片段的id"/>

注意：refid值的寫法，refid的值為mapper xml的namespace的值.sql的id，如果在同一個mapper中，namespace可以省略，直接寫對應的sql的id就可以了，如：

<include refid="findSql"/>
<include refid="com.javacode2018.chat05.demo8.mapper.UserMapper.findSql"/>

來個案例

下面定義2個查詢，他們的查詢條件一樣，最後將條件抽出來用sql元素定義了一個片段，然後進行共用。

<sql id="findSql">
  <where>
    <if test="id!=null">
      AND id = #{id}
    </if>
    <if test="name!=null and name.toString()!=''">
      AND name = #{name}
    </if>
    <if test="age!=null">
      AND age = #{age}
    </if>
    <if test="idList!=null and idList.size()>=1">
      <foreach collection="idList" item="id" open="AND id in (" separator="," close=")">
        #{id}
      </foreach>
    </if>
  </where>
</sql>

<select id="getList1" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  <include refid="com.javacode2018.chat05.demo8.mapper.UserMapper.findSql" />
</select>

<select id="getList1Count" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT count(*) FROM t_user
  <include refid="findSql" />
</select>

bind元素

bind元素允許我們通過ognl表示式在上下文中自定義一個變數，最後在動態sql中可以使用這個變數。

語法

<bind name="變數名稱" value="ognl表示式">

案例

對sql、include中的案例進行擴充套件，新增一個按照使用者名稱模糊查詢，使用者名稱在map中對應的key為likeName，主要修改上面sql片段部分，在sql中加入下面部分：

<if test="likeName!=null and likeName.trim()!=''">
 <bind name="nameLike" value="'%'+likeName.trim()+'%'" />
 AND name like #{nameLike}
</if>

先判斷傳入的引數likeName是否不為空字串，然後使用bind元素建立了一個變數nameLike，值為'%'+likeName.trim()+'%'。

對應的測試用例：

com.javacode2018.chat05.demo8.Demo8Test#getModelList
@Test
public void getModelList() throws IOException {
  try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    Map<String,Object> paramMap = new HashMap<>();
    paramMap.put("likeName","java");
    List<UserModel> userModelList = mapper.getList1(paramMap);
    log.info("{}",userModelList);
  }
}

執行輸出：

06:25.633 [main] DEBUG c.j.c.d.mapper.UserMapper.getList1 - ==> Preparing: SELECT id,age FROM t_user WHERE name like ?
06:25.671 [main] DEBUG c.j.c.d.mapper.UserMapper.getList1 - ==> Parameters: %java%(String)
06:25.690 [main] DEBUG c.j.c.d.mapper.UserMapper.getList1 - <== Total: 1
06:25.691 [main] INFO c.j.chat05.demo8.Demo8Test - [UserModel(id=1,name=路人甲Java,age=31)]

注意輸出中的第二部分，引數的值為%java%。

#和$

#和KaTeX parse error: Expected 'EOF',got '#' at position 15: 一般都是結合變數來使用，如：#̲{}、{}這種來進行使用。

#{}:為引數佔位符？，即sql預編譯，相當於使用jdbc中的PreparedStatement中的sql佔位符，可以防止sql注入

${}:為字串替換， 即字串拼接，不能訪問sql注入。

#{}的用法上面已經有很多案例了，此處我們來一個${}的案例。

下面通過orderSql變數傳入任意的排序sql，如下：

<select id="getList1" resultType="com.javacode2018.chat05.demo8.model.UserModel" parameterType="map">
  SELECT id,age FROM t_user
  <if test="orderSql">
    ${orderSql}
  </if>
</select>

傳入值：

orderSql = "order by id asc,age desc"

最後執行產生的sql如下：

20:32.138 [main] DEBUG c.j.c.d.mapper.UserMapper.getList1 - ==> Preparing: SELECT id,age FROM t_user order by id asc,age desc
20:32.173 [main] DEBUG c.j.c.d.mapper.UserMapper.getList1 - ==> Parameters:
20:32.196 [main] DEBUG c.j.c.d.mapper.UserMapper.getList1 - <== Total: 6
20:32.197 [main] INFO c.j.chat05.demo8.Demo8Test - [UserModel(id=1,age=31),UserModel(id=2,name=張學友,age=50),UserModel(id=3,name=劉德華,UserModel(id=10,name=mybatis-0,age=20),UserModel(id=11,name=mybatis-1,age=21),UserModel(id=12,name=mybatis-2,age=22)]

mybatis會對$包含部分進行sql替換。

到此這篇關於Mybatis 動態SQL的幾種實現方法的文章就介紹到這了,更多相關Mybatis 動態SQL內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！

相關推薦

Mybatis 動態SQL的幾種實現方法

案例sql指令碼 DROP DATABASE IF EXISTS `javacode2018`; CREATE DATABASE `javacode2018`; USE `javacode2018`;

MyBatis動態SQL foreach標籤實現批量插入的方法示例

需求:查出給定id的記錄: <select id=\"getEmpsByConditionForeach\" resultType=\"comtestbeansEmployee\">

【Java】Bean複製幾種實現方法效能比較

【引言】 在專案開發過程中，會遇到將某個已有若干屬性值的Bean複製給另一個具有相同屬性名的Bean，除了一個一個屬性去set方法之外，其實可以通過呼叫一些工具類下的方法直接copy，這樣就避免了一個一個去set屬性值，

Python 二維矩陣 行列轉置的幾種實現方法

最近在讀寫 MySQL 資料的過程中，碰到了需要處理 二維矩陣資料 行列轉置 的問題，比如將：

js讀取本地json格式檔案資料的幾種實現方法，內有vue讀取json示例程式碼。

目錄方法一：通過getJSON實現方法二：使用原生js實現方法三：使用AJAX實現在vue中實現獲取json格式檔案並編輯可能出現的問題

介面服務中的冪等性設計和防重保證，詳細分析冪等性的幾種實現方法

什麼是冪等性 冪等性定義: 一次和多次請求某一個資源對於資源本身應該具有同樣的結果

Java多執行緒的幾種實現方法?說明它們的異同.

說起java多執行緒程式設計，大家都不陌生，下面我就總結下java裡實現多執行緒的集中方法：繼承Thread類,實現Runnable介面,使用Callable和Future建立執行緒,使用執行緒池建立（使用java.util.concurrent.Executor介面

JS 中深拷貝的幾種實現方法

JS 中深拷貝的幾種實現方法1、使用遞迴的方式實現深拷貝//使用遞迴的方式實現陣列、物件的深拷貝function deepClone1(obj) {//判斷拷貝的要進行深拷貝的是陣列還是物件，是陣列的話進行陣列拷貝，物件的話進行物件拷

sql server deadlock跟蹤的4種實現方法

前言 最近寫程式常會遇到deadlock victim，每次一臉懵逼。研究了下怎麼跟蹤，寫下來記錄下。文中介紹的非常詳細，對大傢俱有一定的參考學習價值，下面話不多說了，來一起看看詳細的介紹吧

Mybatis4 之Mybatis動態sql的實現程式碼

1.什麼是動態SQL 傳統的使用JDBC的方法，相信大家在組合複雜的的SQL語句的時候，需要去拼接，稍不注意哪怕少了個空格，都會導致錯誤。Mybatis的動態SQL功能正是為了解決這種問題， 其通過 if,choose,when,otherwise

MyBatis動態SQL實現配置過程解析

動態SQL 什麼是動態SQL： ​ 動態SQL就是根據不同的條件生成不同的SQL語句 if choose（when，otherwise）

Mybatis傳遞多個引數的三種實現方法

方案一 　　Dao層的函式方法 　　 1 Public User selectUser(String name,String area); 　　對應的Mapper.xml

MyBatis批量新增資料2種實現方法

1.通過for each標籤拼接sql（數量較少的時候使用） 　　a.拼接values（） 　　public int addPersons(@Param(\"persons\") List<Person> persons);//介面

CSS幾種簡單方法實現文字豎向排版

下面介紹幾種使用css實現文字豎向排版的方法： 辦公資源網址導航 https://www.wode007.com 熊貓辦公https://www.wode007.com/sites/73654.html

Mybatis動態SQL的實現示例

場景 在實際應用開發過程中，我們往往需要寫複雜的 SQL 語句，需要拼接，而拼接SQL語句又稍微不注意，由於引號，空格等缺失可能都會導致錯誤。

幾種實現tab欄切換的方法

目錄1.利用v-if（uni例項）2.利用display控制3.面向物件(html例項) tab欄一個重要的思想是排他：就是隻顯示自己點選的tab欄，其它的tab欄都不要顯示。

分散式Session的幾種實現方式

SpringBoot 分散式session 在如今伺服器叢集的情況下，使用者登入會話狀態的儲存也從單機的變成了分散式要求的，下面詳細說一下幾種分散式session儲存方案。

C#在foreach遍歷刪除集合中元素的三種實現方法

前言 在foreach中刪除元素時，每一次刪除都會導致集合的大小和元素索引值發生變化，從而導致在foreach中刪除元素時會丟擲異常。

詳解SpringBoot中RestTemplate的幾種實現

RestTemplate的多種實現 使用JDK預設的http library 使用Apache提供的httpclient 使用Okhttp3

MongoDB釋放空閒空間的幾種常用方法

前言 當我們從MongoDB中刪除文件或集合時，MongoDB並不會將已經佔用了的磁碟空間釋放，它會一直維護已經佔用了磁碟空間的資料檔案，儘管資料檔案中可能存在大大小小的空記錄列表（empty record list）。當客戶端程式