MyBatis從入門到入土——動態SQL

時間  2021-02-26
標籤 java sql 數據庫 編程 數組 mybatis app ide 測試 欄目 MyBatis 简体版
原文   原文鏈接

這是mybatis系列第10篇，沒看前文的建議先去【Java冢狐】公衆號中查看前文，方便理解和掌握。在上一篇中重點介紹了延遲加載、鑑別器以及繼承的相關知識。java

在這篇文章中咱們介紹mybatis一個比較強大的功能。這個功能就是動態sql，尤爲是在處理sql的拼接這塊簡直是咱們的福音，基本上sql拼接的全部的痛點，mybatis都幫咱們解決了。sql

那麼下面咱們來學一下mybatis中各類動態sql的用法。數據庫

建立數據庫

首先就是建立咱們演示用的數據庫，以下所示：編程

DROP DATABASE IF EXISTS `mybatisdemo`;
CREATE DATABASE `mybatisdemo`;
USE `mybatisdemo`;
DROP TABLE IF EXISTS user;
CREATE TABLE 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冢狐',18),(2,'java',100),(3,'冢狐',23);

if元素

首先介紹的就是動態sql的if元素，這個if元素至關於java中的if判斷。數組

其使用語法：mybatis

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

test的值爲一個判斷表達式，寫法上採用OGNL表達式的方式，當test成立的時候，if體內部的sql會被拼接上。app

如：ide

<select id="getList1" resultType="com.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM 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以下：ui

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

當3個參數都傳了，sql以下：

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

上面這種寫法相對於java代碼看起來是否是清爽了不少，也更方便維護，你們注意一下sql中有個WHERE 1=1，若是沒有這個，上面單經過if元素就很差實現了，mybatis也有解決方案，稍後會說明。

choose/when/otherwise元素

介紹了完相似於java的if，那確定有相應的if-else語句，那就是choose、when和otherwise，其具體語法：

<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.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM 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,name,age FROM t_user WHERE 1 = 1 AND id = ?

若是值傳遞了name、age，sql以下：

SELECT id,name,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.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM 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.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM 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.zhonghu.chat10.demo8.model.UserModel">
    UPDATE 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 user SET name = ?, age = ?, where id = ?

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

<update id="update1" parameterType="com.zhonghu.chat10.demo8.model.UserModel">
    UPDATE 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 user SET age = ? where id = ?

trim元素

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

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

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

  • 先對trim內部的sql進行拼接，好比這部分sql叫作sql1
  • 將sql1字符串前面的部分中包含trim的prefixOverrides指定的部分給去掉，獲得sql2
  • 將sql2字符串後面的部分中包含trim的suffixOverrides指定的部分給去掉，獲得sql3
  • 在sql3前面追加trim中prefix指定的值，獲得sql4
  • 在sql4後面追加trim中suffix指定的值，獲得最終須要拼接的sql5

瞭解了這個過程以後，說明能夠經過trim來代替where和set，咱們使用trim來改造一下案例1，以下：

<select id="getList1" resultType="com.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM 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.zhonghu.chat10.demo8.model.UserModel">
    UPDATE user
    <trim prefix="SET" prefixOverrides="," suffixOverrides=",">
        <if test="name!=null">
            name = #{name},
        </if>
        <if test="age!=null">
            age = #{age},
        </if>
    </trim>
    <where>
        <if test="id!=null">
            AND id = #{id}
        </if>
    </where>
</update>

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

實際上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,SqlNode contents) {
    super(configuration, contents, "SET", COMMA, null, 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.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM 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,name,age FROM t_user WHERE id in ( ? , ? )

案例：批量插入

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

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

測試用例

com.zhonghu.chat10.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 user (id,name,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.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,age FROM user
    <include refid="com.zhonghu.chat10.demo8.mapper.UserMapper.findSql" />
</select>
<select id="getList1Count" resultType="com.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT count(*) FROM 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.zhonghu.chat10.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,name,age FROM 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=18)]

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

#和$

#和$通常都是結合變量來使用，如：#{}、${}這種來進行使用。

#{}:爲參數佔位符？，即sql預編譯，至關於使用jdbc中的PreparedStatement中的sql佔位符，能夠防止sql注入

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

#{}的用法上面已經有不少案例了，此處咱們來一個${}的案例。

下面經過orderSql變量傳入任意的排序sql，以下：

<select id="getList1" resultType="com.zhonghu.chat10.demo8.model.UserModel" parameterType="map">
    SELECT id,name,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,name,age FROM 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, name=java冢狐, age=18), UserModel(id=2, name=java, age=100), UserModel(id=3, name=冢狐, age=23), 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的元素，諸如：if、choose、where、set、trim、foreach、bind等元素。針對每一個元素都詳細的舉了例子和代碼進行演示。

最後

  • 若是以爲看完有收穫，但願能關注一下，順便給我點個贊，這將會是我更新的最大動力，感謝各位的支持
  • 歡迎各位關注個人公衆號【java冢狐】，專一於java和計算機基礎知識，保證讓你看完有所收穫，不信你打我
  • 求一鍵三連：點贊、轉發、在看。
  • 若是看完有不一樣的意見或者建議，歡迎多多評論一塊兒交流。感謝各位的支持以及厚愛。

——我是冢狐，和你同樣熱愛編程。

歡迎關注公衆號「Java冢狐」獲取最新消息

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程