【Mabatis-Plus】之 Wapper 详解

客官°小女子只卖身不卖艺 2023-03-01 12:26 93阅读 0赞

## Wapper 介绍 ##

--------------------

在 Mybatis-Plus（MP） 中，简单的查询可以使用 MP 已经封装好的 API 来实现，但复杂的查询语句可以通过 MP 提供的 wrapper 来进行封装。

### Wrapper 继承体系 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Fpd2FuZ3Rpbmd5dW4_size_16_color_FFFFFF_t_70]

Wrapper ： 条件构造抽象类，最顶端父类

*  AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件
 *   *  QueryWrapper ： Entity 对象封装操作类，不是用lambda语法
     *  UpdateWrapper ： Update 条件封装，用于Entity对象更新操作
 *  AbstractLambdaWrapper ： Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。
 *   *  LambdaQueryWrapper ：看名称也能明白就是用于Lambda语法使用的查询Wrapper
     *  LambdaUpdateWrapper ： Lambda 更新封装Wrapper

## Wrapper 实战 ##

--------------------

下面我们通过代码实战来讲解如果使用 wrapper 来封装复杂的查询语句。具体的实战环境搭建可以参考我们另一篇博客：[【MyBatista Plus】之 CRUD 实战][MyBatista Plus_ CRUD]

### 1、ge、gt、le、lt、isNull、isNotNull ###

@Test
    public void testWrapperDelete() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrappe.isNull("name")
                   .ge("age", 12)
                   .isNotNull("email");
        int result = userMapper.delete(queryWrapper);
        System.out.println("delete return count = " + result);
    }

**注意**：QueryWrapper 条件构造器的方法入参中的 column 均表示数据库字段

执行并观察控制台 sql 输出语句可以看到翻译后的语句为：

UPDATE user SET deleted=1 WHERE deleted=0 AND name IS NULL AND age >= ? AND email IS NOT NULL

当然，由于配置了逻辑删除，所以这里的删除变成了更新操作了。

### 2、eq、ne ###

@Test
    public void testSelectOne() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("name", "Tom");
        User user = userMapper.selectOne(queryWrapper);
        System.out.println(user);
    }

\*\*注意：\*\*seletOne返回的是一条实体记录，当出现多条时会报错

翻译后的 sql 语句为：

SELECT id,name,age,email,create_time,update_time,deleted,version 
    FROM user WHERE deleted=0 AND name = ?

### 3、between、notBetween ###

@Test
    public void testSelectCount() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.between("age", 20, 30);
        Integer count = userMapper.selectCount(queryWrapper);
        System.out.println(count);
    }

**注意**：这两个函数的参数值是包含边界两边大小的，也就是说，20 和 30 是包含在内的。

执行翻译后的 sql 语句为：

SELECT id,name,age,email,create_time,update_time,version,deleted 
    FROM user WHERE deleted=0 AND age BETWEEN ? AND ?

### 4、allEq ###

@Test
    public void testSelectList() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        
        // 使用 map 来封装所有 eq 条件
        Map<String, Object> map = new HashMap<>();
        map.put("id", 2);
        map.put("name", "Jack");
        map.put("age", 20);
        
        queryWrapper.allEq(map);
        List<User> users = userMapper.selectList(queryWrapper);
        users.forEach(System.out::println);
    }

执行翻译后的 sql 语句为：

SELECT id,name,age,email,create_time,update_time,deleted,version 
    FROM user WHERE deleted=0 AND name = ? AND id = ? AND age = ?

### 5、like、notLike、likeLeft、likeRight ###

@Test
    public void testSelectMaps() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.notLike("name", "e")
                   .likeRight("email", "t");
        List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);//返回值是Map列表
        maps.forEach(System.out::println);
    }

执行翻译后的 sql 语句为：

==>  Preparing: SELECT id,name,age,email,create_time,update_time,version,deleted FROM user WHERE deleted=0 AND name NOT LIKE ? AND email LIKE ? 
    ==> Parameters: %e%(String), t%(String)
    <==    Columns: id, name, age, email, create_time, update_time, version, deleted
    <==        Row: 2, Jack, 20, test2@baomidou.com, null, null, 1, 0
    <==      Total: 1

从中不难看出，like 和 notLike 翻译为了 %xx%，而 leftLike 翻译为了 %xx，rightLike 翻译为了 xx%。

### 6、in、notIn、inSql、notinSql、exists、notExists ###

**in、notIn**：

*  in(“age”, \{1,2,3\}) ： age in (1,2,3)
 *  notIn(“age”, \{1,2,3\}) ： age not in (1,2,3)

**inSql、notinSql：可以实现子查询**

*  inSql(“age”, “1,2,3,4,5,6”) ： age in (1,2,3,4,5,6)
 *  inSql(“id”, “select id from table where id < 3”) ：id in (select id from table where id < 3)

@Test
    public void testSelectObjs() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        // queryWrapper.in("id", 1, 2, 3);
        queryWrapper.inSql("id", "select id from user where id < 3");
        List<Object> objects = userMapper.selectObjs(queryWrapper);//返回值是Object列表
        objects.forEach(System.out::println);
    }

执行翻译后的 sql 语句为：

SELECT id,name,age,email,create_time,update_time,deleted,version
    FROM user WHERE deleted=0 AND id IN (select id from user where id < 3)

### 7、or、and ###

@Test
    public void testUpdateWrapper() { 
        // 修改值
        User user = new User();
        user.setAge(99);
        user.setName("Andy");
        
        // 修改条件
        UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
        userUpdateWrapper.like("name", "h")
        				.or()
        				.between("age", 20, 30);
        int result = userMapper.update(user, userUpdateWrapper);
        System.out.println(result);
    }

**注意**：这里使用的是 **UpdateWrapper**，不调用 or 则默认为使用 and 连。

对应 sql 语句为：

UPDATE user SET name=?, age=?, update_time=? WHERE deleted=0 AND name LIKE ? OR age BETWEEN ? AND ?

### 8、嵌套or、嵌套and ###

@Test
    public void testUpdate2() { 
        //修改值
        User user = new User();
        user.setAge(99);
        user.setName("Andy");
        
        //修改条件
        UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
        userUpdateWrapper
        		.like("name", "h")
        		.or(i -> i.eq("name", "李白").ne("age", 20));
        
        int result = userMapper.update(user, userUpdateWrapper);
    	System.out.println(result);
    }

这里使用了 **lambda表达式**，or 中的表达式最后翻译成sql时会被加上圆括号:

UPDATE user SET name=?, age=?, update_time=?
    WHERE deleted=0 AND name LIKE ?
    OR ( name = ? AND age <> ? )

### 9、orderBy、orderByDesc、orderByAsc ###

@Test
    public void testSelectListOrderBy() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(queryWrapper);
        users.forEach(System.out::println);
    }

执行翻译后的 sql 语句为：

SELECT id,name,age,email,create_time,update_time,deleted,version
    FROM user WHERE deleted=0 ORDER BY id DESC

### 10、last ###

直接拼接到 sql 的最后

**注意**：只能调用一次,多次调用以最后一次为准 有 **sql 注入的风险**,请谨慎使用

@Test
    public void testSelectListLast() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.last("limit 1");
        List<User> users = userMapper.selectList(queryWrapper);
        users.forEach(System.out::println);
    }

执行翻译后的 sql 语句为：

SELECT id,name,age,email,create_time,update_time,deleted,version
    FROM user WHERE deleted=0 limit 1

### 11、指定要查询的列 ###

@Test
    public void testSelectListColumn() { 
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        // 调用 QueryWrapper 的 select 函数指定要查询的列
        queryWrapper.select("id", "name", "age");
        List<User> users = userMapper.selectList(queryWrapper);
        users.forEach(System.out::println);
    }

执行翻译后的 sql 语句为：

SELECT id,name,age FROM user WHERE deleted=0

### 12、set、setSql ###

@Test
    public void testWrapperSet() { 
        // 修改值
        User user = new User();
        user.setAge(19);
    
        // 修改条件
        UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
        updateWrapper.likeRight("name", "wa")
            .set("name", "Bob")                // 使用set设置修改的字段
            .setSql("email = 'bob@163.com'");  // 子查询
    
        int result = userMapper.update(user, updateWrapper);
    }

set、setSql 这两个是属于 UpdateWrapper 中的函数，updateWrapper 会同时把 setAge()、set() 和 setSql() 一起组合到最终的 sql 语句中：

UPDATE user SET age=?, update_time=?, name=?,email = 'bob@163.com' WHERE deleted=0 AND name LIKE ?

这里的 sql 语句之所以会出现 update\_time=? 是因为该字段配置了自动填充为 update 操作。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Fpd2FuZ3Rpbmd5dW4_size_16_color_FFFFFF_t_70]: /images/20230208/afe550f65fd849a19e00c369d0470723.png
[MyBatista Plus_ CRUD]: https://blog.csdn.net/aiwangtingyun/article/details/107552769