MyBatis-Plus 條件構造器 Wrapper 的用法

前言

接口方法的參數中，會出現各種 Wrapper，比如 queryWrapper、updateWrapper 等。Wrapper 的作用就是用於定義各種各樣的條件（where）。所以不管是查詢、更新、刪除都會用到 Wrapper。

如 QueryWrapper 是 Mybatis Plus 中一個條件拼裝查詢器，作用是讓我們以 Java 對象的方式構建 where 之后的查詢條件，不用直接寫 SQL。

1. Wrapper的繼承關系：

Wrapper  條件構造抽象類
    -- AbstractWrapper 查詢條件封裝，用於生成 sql 中的 where 語句。
        -- QueryWrapper Entity 對象封裝操作類，用於查詢。
        -- UpdateWrapper Update 條件封裝操作類，用於更新。
        -- AbstractLambdaWrapper 使用 Lambda 表達式封裝 wrapper
            -- LambdaQueryWrapper 使用 Lambda 語法封裝條件，用於查詢。
            -- LambdaUpdateWrapper 使用 Lambda 語法封裝條件，用於更新。

2. 常用條件

比較大小： ( =, <>, >, >=, <, <= )

    eq(R column, Object val); // 等價於 =，例: eq("name", "老王") ---> name = '老王'
    ne(R column, Object val); // 等價於 <>，例: ne("name", "老王") ---> name <> '老王'
    gt(R column, Object val); // 等價於 >，例: gt("name", "老王") ---> name > '老王'
    ge(R column, Object val); // 等價於 >=，例: ge("name", "老王") ---> name >= '老王'
    lt(R column, Object val); // 等價於 <，例: lt("name", "老王") ---> name < '老王'
    le(R column, Object val); // 等價於 <=，例: le("name", "老王") ---> name <= '老王'

范圍：（between、not between、in、not in）

   between(R column, Object val1, Object val2); // 等價於 between a and b, 例： between("age", 18, 30) ---> age between 18 and 30
   notBetween(R column, Object val1, Object val2); // 等價於 not between a and b, 例： notBetween("age", 18, 30) ---> age not between 18 and 30
   in(R column, Object... values); // 等價於 字段 IN (v0, v1, ...),例: in("age",{1,2,3}) ---> age in (1,2,3)
   notIn(R column, Object... values); // 等價於 字段 NOT IN (v0, v1, ...), 例: notIn("age",{1,2,3}) ---> age not in (1,2,3)
   inSql(R column, Object... values); // 等價於 字段 IN (sql 語句), 例: inSql("id", "select id from table where id < 3") ---> id in (select id from table where id < 3)
   notInSql(R column, Object... values); // 等價於 字段 NOT IN (sql 語句)

模糊匹配：（like）

    like(R column, Object val); // 等價於 LIKE '%值%'，例: like("name", "王") ---> name like '%王%'
    notLike(R column, Object val); // 等價於 NOT LIKE '%值%'，例: notLike("name", "王") ---> name not like '%王%'
    likeLeft(R column, Object val); // 等價於 LIKE '%值'，例: likeLeft("name", "王") ---> name like '%王'
    likeRight(R column, Object val); // 等價於 LIKE '值%'，例: likeRight("name", "王") ---> name like '王%'

空值比較：（isNull、isNotNull）

    isNull(R column); // 等價於 IS NULL，例: isNull("name") ---> name is null
    isNotNull(R column); // 等價於 IS NOT NULL，例: isNotNull("name") ---> name is not null

分組、排序：（group、having、order）

    groupBy(R... columns); // 等價於 GROUP BY 字段, ...， 例: groupBy("id", "name") ---> group by id,name
    orderByAsc(R... columns); // 等價於 ORDER BY 字段, ... ASC， 例: orderByAsc("id", "name") ---> order by id ASC,name ASC
    orderByDesc(R... columns); // 等價於 ORDER BY 字段, ... DESC， 例: orderByDesc("id", "name") ---> order by id DESC,name DESC
    having(String sqlHaving, Object... params); // 等價於 HAVING ( sql語句 )， 例: having("sum(age) > {0}", 11) ---> having sum(age) > 11

拼接、嵌套 sql：（or、and、nested、apply）

   or(); // 等價於 a or b， 例：eq("id",1).or().eq("name","老王") ---> id = 1 or name = '老王'
   or(Consumer<Param> consumer); // 等價於 or(a or/and b)，or 嵌套。例: or(i -> i.eq("name", "李白").ne("status", "活着")) ---> or (name = '李白' and status <> '活着')
   and(Consumer<Param> consumer); // 等價於 and(a or/and b)，and 嵌套。例: and(i -> i.eq("name", "李白").ne("status", "活着")) ---> and (name = '李白' and status <> '活着')
   nested(Consumer<Param> consumer); // 等價於 (a or/and b)，普通嵌套。例: nested(i -> i.eq("name", "李白").ne("status", "活着")) ---> (name = '李白' and status <> '活着')
   apply(String applySql, Object... params); // 拼接sql（若不使用 params 參數，可能存在 sql 注入），例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08") ---> date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
   last(String lastSql); // 無視優化規則直接拼接到 sql 的最后，可能存若在 sql 注入。
   exists(String existsSql); // 拼接 exists 語句。例: exists("select id from table where age = 1") ---> exists (select id from table where age = 1)

QueryWrapper 條件：

    select(String... sqlSelect); // 用於定義需要返回的字段。例： select("id", "name", "age") ---> select id, name, age
    select(Predicate<TableFieldInfo> predicate); // Lambda 表達式，過濾需要的字段。
    lambda(); // 返回一個 LambdaQueryWrapper

UpdateWrapper 條件：

    set(String column, Object val); // 用於設置 set 字段值。例: set("name", null) ---> set name = null
    setSql(String sql); // 用於設置 set 字段值。例: setSql("name = '老李頭'") ---> set name = '老李頭'
    lambda(); // 返回一個 LambdaUpdateWrapper

3. QueryWrapper 示例

    @Test
    public void testQueryWrapper() {
        // Step1：創建一個 QueryWrapper 對象
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();

        // Step2： 構造查詢條件
        queryWrapper
                .select("id", "name", "age")
                .lt("age", 23)//小於23歲
                .like("name", "i");//name包括i字母

        // Step3：執行查詢
        userMapper
                .selectList(queryWrapper)
                .forEach(System.out::println);
    }

4. UpdateWrapper

基本語法：

set

set(String column, Object val)
set(boolean condition, String column, Object val)

例: set("name", "老李頭")
例: set("name", "")--->數據庫字段值變為空字符串
例: set("name", null)--->數據庫字段值變為null

setSql

setSql(String sql)

設置 SET 部分 SQL

例: setSql("name = '老李頭'")

5. UpdateWrapper 示例

    @Test
    public void testUpdateWrapper() {
        int reduceAge = 2;
        User user = new User();

        // 更新用戶數據的wrapper
        UpdateWrapper<User> updateWrapper = new UpdateWrapper<User>();
        //修改數據的語句
        updateWrapper.set("email", "[e-mail]");//使email字段的值更新為“[e-mail]”
        updateWrapper.setSql("age = age - " + reduceAge);//自定義的sql語句
        //條件
        updateWrapper.eq("id", 4);
        userMapper.update(user, updateWrapper);
    }

6. UpdateWrapper 其他更新方法

先 select 取出數據，然后通過 set 方法修改 entity 的值，再 save 到數據庫。

    @Test
    public void testUpdateById() {
        User user = userMapper.selectById(4);
        user.setAge(88);
        userMapper.updateById(user);
    }

參考資源

1. Mybatis-Plus Wrapper 官網教程

2. https://www.jianshu.com/p/c5537559ae3a

每天學習一點點，每天進步一點點。