MyBatis-Plus Wrapper条件构造器查询大全

一、引言

那么那么那么今天来说下MP中强大的条件查询功能。

二、具体操作

首先来说说基本的查询吧，根据主键或者简单的查询条件进行查询。

    /**
     * 通过单个ID主键进行查询
     */
    @Test
    public void selectById() {
        User user = userMapper.selectById(1094592041087729666L);
        System.out.println(user);
    }
 
    /**
     * 通过多个ID主键查询
     */
    @Test
    public void selectByList() {
        List<Long> longs = Arrays.asList(1094592041087729666L, 1094590409767661570L);
        List<User> users = userMapper.selectBatchIds(longs);
        users.forEach(System.out::println);
    }
 
    /**
     * 通过Map参数进行查询
     */
    @Test
    public void selectByMap() {
        Map<String, Object> params = new HashMap<>();
        params.put("name", "张雨琪");
        List<User> users = userMapper.selectByMap(params);
        users.forEach(System.out::println);
    }

MyBatis-Plus还提供了Wrapper条件构造器，具体使用看如下代码：

/**
     * 名字包含雨并且年龄小于40
     * <p>
     * WHERE name LIKE '%雨%' AND age < 40
     */
    @Test
    public void selectByWrapperOne() {
        QueryWrapper<User> wrapper = new QueryWrapper();
        wrapper.like("name", "雨").lt("age", 40);
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 名字包含雨
     * 年龄大于20小于40
     * 邮箱不能为空
     * <p>
     * WHERE name LIKE '%雨%' AND age BETWEEN 20 AND 40 AND email IS NOT NULL
     */
    @Test
    public void selectByWrapperTwo() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.like("name", "雨").between("age", 20, 40).isNotNull("email");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 名字为王性
     * 或者年龄大于等于25
     * 按照年龄降序排序，年龄相同按照id升序排序
     * <p>
     * WHERE name LIKE '王%' OR age >= 25 ORDER BY age DESC , id ASC
     */
    @Test
    public void selectByWrapperThree() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.likeRight("name", "王").or()
                .ge("age", 25).orderByDesc("age").orderByAsc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 查询创建时间为2019年2月14
     * 并且上级领导姓王
     * <p>
     * WHERE date_format(create_time,'%Y-%m-%d') = '2019-02-14' AND manager_id IN (select id from user where name like '王%')
     */
    @Test
    public void selectByWrapperFour() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.apply("date_format(create_time,'%Y-%m-%d') = {0}", "2019-02-14")
                .inSql("manager_id", "select id from user where name like '王%'");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 查询王姓
     * 并且年龄小于40或者邮箱不为空
     * <p>
     * WHERE name LIKE '王%' AND ( age < 40 OR email IS NOT NULL )
     */
    @Test
    public void selectByWrapperFive() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.likeRight("name", "王").and(qw -> qw.lt("age", 40).or().isNotNull("email"));
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 查询王姓
     * 并且年龄大于20 、年龄小于40、邮箱不能为空
     * <p>
     * WHERE name LIKE ? OR ( age BETWEEN ? AND ? AND email IS NOT NULL )
     */
    @Test
    public void selectByWrapperSix() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.likeRight("name", "王").or(
                qw -> qw.between("age", 20, 40).isNotNull("email")
        );
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * (年龄小于40或者邮箱不为空) 并且名字姓王
     * WHERE ( age < 40 OR email IS NOT NULL ) AND name LIKE '王%'
     */
    @Test
    public void selectByWrapperSeven() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.nested(qw -> qw.lt("age", 40).or().isNotNull("email"))
                .likeRight("name", "王");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 查询年龄为30、31、32
     * WHERE age IN (?,?,?)
     */
    @Test
    public void selectByWrapperEight() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.in("age", Arrays.asList(30, 31, 32));
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
 
    /**
     * 查询一条数据
     * limit 1
     */
    @Test
    public void selectByWrapperNine() {
        QueryWrapper<User> wrapper = Wrappers.query();
        wrapper.in("age", Arrays.asList(30, 31, 32)).last("limit 1");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

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

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

MyBatis-Plus 自定义sql语句

原文链接

一、引言

MP自带的条件构造器虽然很强大，有时候也避免不了写稍微复杂一点业务的sql，那么那么今天说说MP怎么自定义sql语句吧。

二、配置

自定义的sql当然是写在XML文件中的啦，那么首先来定义xml文件的位置，在yml配置文件如下

mybatis-plus:
  # 如果是放在src/main/java目录下 classpath:/com/*/*/mapper/*Mapper.xml
  # 如果是放在resource目录 classpath:/mapper/**.xml
  mapper-locations: classpath:/mapper/**.xml

三、具体实现

使用注解实现：

在我们Mapper接口中定义自定义方法即可。

/**
 * @Auther: IT贱男
 * @Date: 2019/6/10 14:40
 * @Description: User对象持久层
 */
public interface UserMapper extends BaseMapper<User> {
 
    /**
     *
     * 如果自定义的方法还希望能够使用MP提供的Wrapper条件构造器，则需要如下写法
     *
     * @param userWrapper
     * @return
     */
    @Select("SELECT * FROM user ${ew.customSqlSegment}")
    List<User> selectByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper);
 
    /**
     * 和Mybatis使用方法一致
     * @param name
     * @return
     */
    @Select("SELECT * FROM user where name = #{name}")
    List<User> selectByName(@Param("name") String name);
 
}

使用xml文件实现：

使用xml一定要指定xml文件所在位置

/**
 * @Auther: IT贱男
 * @Date: 2019/6/10 14:40
 * @Description: User对象持久层
 */
public interface UserMapper extends BaseMapper<User> {
 
    /**
     *
     * 如果自定义的方法还希望能够使用MP提供的Wrapper条件构造器，则需要如下写法
     *
     * @param userWrapper
     * @return
     */
    List<User> selectByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper);
 
    /**
     * 和Mybatis使用方法一致
     * @param name
     * @return
     */
    List<User> selectByName(@Param("name") String name);
 
}

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
 
    <select id="selectByName" resultType="com.example.demo.model.User">
        SELECT * FROM user where name = #{name}
    </select>
 
    <select id="selectByMyWrapper" resultType="com.example.demo.model.User">
        SELECT * FROM user ${ew.customSqlSegment}
    </select>
 
</mapper>

测试测试：

    /**
     * 自定义sql查询语句
     */
    @Test
    public void selectByMySelect() {
        List<User> users = userMapper.selectByName("王天风");
        users.forEach(System.out::println);
    }
 
    /**
     * 自定义sql使用Wrapper
     */
    @Test
    public void selectByMyWrapper() {
        QueryWrapper<User> wrapper = new QueryWrapper();
        wrapper.like("name", "雨").lt("age", 40);
        List<User> users = userMapper.selectByMyWrapper(wrapper);
        users.forEach(System.out::println);
    }

四、回答评论区提问

提问一：能否提供自定义Update语句与Wrapper的整合使用呢？

/**
 * <p>
 * 用户 Mapper 接口
 * </p>
 *
 * @author IT贱男
 * @since 2019-06-14
 */
public interface UserMapper extends BaseMapper<User> {
 
 
    /**
     * 自定Wrapper修改
     *
     * @param userWrapper 条件构造器
     * @param user        修改的对象参数
     * @return
     */
 
    int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user);
 
}

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
 
    <update id="updateByMyWrapper">
        UPDATE user SET email = #{user.email} ${ew.customSqlSegment}
    </update>
 
</mapper>

   @Test
    public void updateByMyWrapper() {
        // 条件构造器
        QueryWrapper<User> wrapper = new QueryWrapper();
        wrapper.eq("name", "admin");
 
        // 修改后的对象
        User user = new User();
        user.setEmail("Test@email.com");
 
        userMapper.updateByMyWrapper(wrapper, user);
 
    }

MyBatis-Plus 通用IService使用介绍

原文链接

一、引言

MP除了通用的Mapper还是通用的Servcie层，这也减少了相对应的代码工作量，把通用的接口提取到公共。其实按照MP的这种思想，可以自己也实现一些通用的Controller。

二、IService使用

service层需要继承IService，当然实现层也要继承对应的实现类。

/**
 * <p>
 * 用户 服务类
 * </p>
 *
 * @author IT贱男
 * @since 2019-06-14
 */
public interface UserService extends IService<User> {
 
}

/**
 * <p>
 * 用户 服务实现类
 * </p>
 *
 * @author IT贱男
 * @since 2019-06-14
 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
 
}

这里小编基本的增删改查就不一一演示了，演示几个特殊一点的方法。

getOne()，这个是方法返回结果不止一条则会抛出异常，如果想默认取第一条结果，可以给这方法传第二个参数为false。

  @Test
    public void getOne() {
        User one = userService.getOne(Wrappers.<User>lambdaQuery().eq(User::getAge, 31),false);
        System.out.println(one);
    }

saveOrUpdateBatch()，批量新增或者修改方法,判断ID是否存在，如果ID不存在执行新增，如果ID存在先执行查询语句，查询结果为空就新增，否则修改。

   @Test
    public void saveOrUpdateBatch() {
        User user1 = new User();
        user1.setName("兔子");
        user1.setAge(18);
 
        User user2 = new User();
        user2.setId(1088250446457389060L);
        user2.setName("乌龟");
        user2.setAge(18);
 
        List<User> users = Arrays.asList(user1, user2);
 
        boolean b = userService.saveOrUpdateBatch(users);
        System.out.println(b);
    }

接下来说一下基于lambda的相关操作

 /**
     * lombda查询
     */
    @Test
    public void lambdaQuery(){
        List<User> list = userService.lambdaQuery().eq(User::getAge, 18).list();
        list.forEach(System.out::println);
    }
 
    /**
     * lombda修改
     */
    @Test
    public void lambdaUpdate(){
        boolean update = userService.lambdaUpdate().eq(User::getAge, 18).set(User::getAge, 31).update();
        System.out.println(update);
    }
 
    /**
     * lombda删除
     */
    @Test
    public void lambdaRemoce(){
        boolean remove = userService.lambdaUpdate().eq(User::getAge, 18).remove();
        System.out.println(remove);
    }