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", "winspace@erbadagang.com");//使email字段的值更新为“winspace@erbadagang.com”
        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

每天学习一点点，每天进步一点点。