MyBatis-Plus 条件构造器（Wrapper）

一、Wrapper的继承关系：

Wrapper 条件构造抽象类
– AbstractWrapper 查询条件封装，用于生成 sql 中的 where 语句。
– QueryWrapper Entity 对象封装操作类，用于查询。
– UpdateWrapper Update 条件封装操作类，用于更新。
– AbstractLambdaWrapper 使用 Lambda 表达式封装 wrapper
– LambdaQueryWrapper 使用 Lambda 语法封装条件，用于查询。
– LambdaUpdateWrapper 使用 Lambda 语法封装条件，用于更新。

Wrapper抽象类继承关系

说明：很多文章提到MybatisPlus的EntityWrapper，在3.0版本以上就没了，改为了QueryWrapper。

二、常用条件

项目中遇到的wrapper

       LambdaQueryWrapper<MerchantApply> lambdaQueryWrapper = new LambdaQueryWrapper();
            lambdaQueryWrapper.eq(MerchantApply::getStatus, MerchantApplyEnums.STATUS.CONFIRM.getCode())
                    .eq(MerchantApply::getIsDelete, MerchantApplyEnums.DEL_FLAG.NOT_DELETE.getCode())
                    .and(wrapper ->{wrapper.eq(MerchantApply::getUniscid, uniscid)
                    .or().eq(MerchantApply::getApplicant, merchantInformation.getCreateBy());})
                    .last("limit 1");

            MerchantApply merchantApply = merchantApplyMapper.selectOne(lambdaQueryWrapper);
      

(status = ? AND is_delete = ? AND (uniscid = ? OR applicant = ?)) limit 1

==>  Preparing: SELECT id,applicant,applicant_cert_no,applicant_mobile,company_name,corporation,corporation_mobile,uniscid,license_id,module,industry_type,province,city,district,address,remark,organ_no,scene,is_delete,status,apply_platform,created_by,created_time,updated_by,updated_time FROM t_merchant_apply WHERE (status = ? AND is_delete = ? AND (uniscid = ? OR applicant = ?)) limit 1 
==> Parameters: 1(Integer), 0(Integer), 91110000168904142U(String), root(String)
<==    Columns: id, applicant, applicant_cert_no, applicant_mobile, company_name, corporation, corporation_mobile, uniscid, license_id, module, industry_type, province, city, district, address, remark, organ_no, scene, is_delete, status, apply_platform, created_by, created_time, updated_by, updated_time

动态wrapper

@userMapper
public class UserMapper extends Basemapper<User>{
@select （"select * from user ${ew.customSqlSegment}"）
List<User> selectUsers(@param (constants.WRAPPER) Wrapper queryWrapper);

}

public class userTest {
@Resource
private UserMapper userMapper;

List<User> list = userMapper.selectUsers(new QuryWrapper().eq("name","guang");
}

// sql
select * from user where name = 'z'

.select 的使用：
当遇到大表多数据时候，使用selece指定查询的列可以有效减少查询时间。
因为如果where查询时使用索引，可以加快查询时间，回表取值也是很快的。如果是普通的字段，使用.select可以也减少数据的io操作。
where使用主键

<==      Total: 33893
Releasing transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@9e092b5]
使用.select查询所用时间:315
不使用.select查询所用时间:4621

where 普通字段

<==      Total: 33893
Releasing transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@9e092b5]
使用.select查询所用时间:2395
不使用.select查询所用时间:4081

只查询需要的列

    @Test
    public void testSelectColumn() {
        LambdaQueryWrapper<User> userQueryWrapper = Wrappers.<User>lambdaQuery()
                .select(User::getId,User::getName).likeRight(User::getName, "梅");
        List<User> users = userMapper.selectList(userQueryWrapper);
        System.out.println(users);
        //结果[User(id=1, name=梅长苏, age=null, email=null, parentId=null, createTime=null)]
    }

只查询当前列使用LambdaQueryWrapper

 LambdaQueryWrapper<Dept> lambdaQueryWrapper = new LambdaQueryWrapper();
            lambdaQueryWrapper.select(Dept::getId).eq(Dept::getDelFlag, ONE).in(Dept::getParentId, idList);
            // 拿到当前商户所有的id
            List<Integer> idList = (List) deptMapper.selectObjs(lambdaQueryWrapper);

当要查询的字段较多的时候，可以采用排除法，排除不需要的字段

    @Test
    public void testSelectColumn2() {
        LambdaQueryWrapper<User> userQueryWrapper = Wrappers.<User>lambdaQuery()
                .likeRight(User::getName, "梅")
                .select(User.class,info->!info.getColumn().equals("name"));
        List<User> users = userMapper.selectList(userQueryWrapper);
        System.out.println(users);
        //[User(id=1, name=null, age=40, email=boss@qq.com, parentId=null, createTime=Fri Jan 11 14:20:20 CST 2019)]
    }

【比较大小： ( =, <>, >, >=, <, <= )】

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

三、 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);
   }

当前数据

SQL执行情况

四、UpdateWrapper

4.1基本语法：
set

set(String column, Object val)
set(boolean condition, String column, Object val)
SQL SET 字段
例: set(“name”, “老李头”)
例: set(“name”, “”)—>数据库字段值变为空字符串
例: set(“name”, null)—>数据库字段值变为null
setSql

setSql(String sql)
设置 SET 部分 SQL
例: setSql(“name = ‘老李头’”)

4.2 测试
4.2.1 测试代码

@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);
}

4.2.2 更新前的第4条数据：
老数据

4.2.3 执行测试代码：

SQL日志

4.2.4 更新后的第4条数据：
image.png

4.3 其他更新方法
仿照JPA更新过程，在JPA里面更新一般是先select取出数据，然后通过set方法修改entity的值，再save到数据库。
MP也提供类似的方式，见代码：

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

4.3.1 执行测试代码：

==> Preparing: UPDATE user SET name=?, age=?, email=? WHERE id=?
> Parameters: Oliver(String), 88(Integer), winspace@erbadagang.com(String), 4(Long)
< Updates: 1
4.3.2 更新后的第4条数据：

image.png