MyBatis-Plus中的BaseMapper和Wrapper用法

一、MyBatis-Plus的基本操作（BaseMapper）

注：此测试运行于springboot环境中

新建UserMaper.java接口，并继承 mybatis-plus的BaseMapper：

public interface UserMapper extends BaseMapper<User> {
}

在测试中自动注入UserMapper。

@Autowired
private UserMapper userMapper;

1.1 插入操作

@Test
public void testInsert(){
    User user = new User();
    user.setUserName("ray");
    user.setName("雷东宸");
    user.setAge(18);
    user.setMail("123456789@qq.com");
    user.setPassword("123456");
    int result = this.userMapper.insert(user);  // 数据库受影响的行数
    System.out.println("result => " + result);
}

1.2 更新操作

@Test
public void testUpdateById(){
    User user = new User();
    user.setId(7L);  // 根据id跟新,L表示long类型
    user.setAge(19);  // 更新的字段
    int result = this.userMapper.updateById(user);
    System.out.println("result => " + result);
}

1.3 删除操作

@Test
public void testDeleteByMap(){
    Map<String, Object> map = new HashMap<>();
    map.put("user_name", "ray");
    map.put("password", "123456");
    // 根据map删除数据，不同条件之间是and关系
    this.userMapper.deleteByMap(map);
}

1.4 查找操作

@Test
public void testSelectBatchIds(){
    this.userMapper.selectBatchIds(Arrays.asList(2L,3L,4L));
}

二、MyBatis-Plus的常用进阶操作（Wrapper）

数据库基本数据（以下操作均基于此数据）：

2.1 dao实体类的相关注解

@Data
@TableName("tb_user") 
public class User {
 
    @TableId(type = IdType.AUTO)  
    private Long id;
 
    private String userName;
 
    @TableField(select = false)  
    private String password;
 
    private String name;
    private Integer age;
 
    @TableField(value = "email")  
    private String mail;
 
    @TableField(exist = false)  
    private String address;
}ess;
}

在这里，我们就可以看到mybatis-plus中给我提供了很多便捷的注解：

@TableName（"tb_user"）：因为在mybatis-plus中，默认找的数据库表名是“数据库名.实体名”。但是我们的数据库表名tb_user与其不一致，因此需要重新指定在数据库中的表名。

@TableId (type=IdType.AUTO)：若type=IdType.AUTO则表示id自增长。

@TableField（select=false）：表示查询时不返回该字段值，用来保护用户的密码信息。

@TableField（value="email"）：因为mail与我们数据库中存储的email字段并不匹配（不是常规的驼峰命名），直接查询会导致查询失败。可以使用value字段重新指定。

@TableField（exist=false）：假如该字段我们后期可能会插入数据库，但目前数据库还不存在该信息，那么我们就可以使用exist字段先不查询该字段以防报错。

2.2 DB策略配置

springboot开发中，在Application.properties可以添加如下配置：

2.2.1 idType（全局id自增长）

实体中id自增长（替代@TableId注解）：

mybatis-plus.global-config.db-config.id-type=auto

这样在上面的实体类User中，当我们需要很多自增长的字段时，我们就不需要一个一个去配置@TableId（type=IdType.AUTO）。

2.2.2 tablePrefix（全局表名前缀）

映射数据库表名（替代@TableName注解）：

mybatis-plus.global-config.db-config.table-prefix=tb_

我们数据库中的表为tb_User，那么我们加一个前缀 tb_ 就可以实现自动映射。

2.3 条件构造器wrapper（重要！！！）

条件构造器wrapper就是用来封装CRUD方法参数条件的一个接口，它的继承关系如下：

当然也可以打开源码包查看：

说明: QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类用于生成 sql的 where 条件, entity 属性也用于生成 sql 的 where 条件。

注意: entity 生成的 where 条件与使用各个 api 生成 的 where 条件没有任何关联行为 。

2.3.1 allEq

利用条件构造器QuerryWrapper中的allEq去查找数据库对象，allEq方法中封装的时map对象。

用法：

allEq(Map<R, V> params)

allEq(Map<R, V> params, boolean null2IsNull)

allEq(boolean condition, Map<R, V> params, boolean null2IsNull)

测试代码：

@Test
public void testAllEq() {
    Map<String, Object> params = new HashMap<>();
    params.put("name", "李四");
    params.put("age", "20");
    params.put("password", null);
 
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.allEq(params, false);  // 第二个参数false表示null值不作为查询条件
 
    List<User> users = this.userMapper.selectList(wrapper);
    for (User user: users) {
        System.out.println(user);
    }
}

测试结果：

2.3.2 基本的比较操作

利用条件构造器的比较方法操作数据库。

测试代码举例：

@Test
public void testEq() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("password", "123456")            // 密码等于 123456
            .ge("age", 20)                      // 年龄大于等于20
            .in("name", "李四", "王五", "赵六");  // 在李四，王五，赵六中去查找
    List<User> users = this.userMapper.selectList(wrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

运行结果：

2.3.3 模糊查询

模糊查询操作数据库

测试代码：

@Test
public void testWrapper() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.like("name", "李");   //Parameters: %李%(String)
    List<User> users = this.userMapper.selectList(wrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

运行结果：

2.3.4 排序

对从数据库中的数据排序。

测试代码：

@Test
public void testWrapper() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.orderByDesc("age");      // 按照年龄倒叙排序
    List<User> users = this.userMapper.selectList(wrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

运行结果：

2.3.5 逻辑查询

测试代码：

@Test
public void testWrapper() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","李四").or().eq("age", 24);  // 查找 姓名是李四 或者 年龄是24
    List<User> users = this.userMapper.selectList(wrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

运行结果：

2.3.6 select

在MP查询中，默认查询所有的字段，如果有需要也可以通过select方法进行指定字段。

测试代码：

@Test
public void testWrapper() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name", "李四")
            .or()
            .eq("age", 24)
            .select("id", "name", "age");
    List<User> users = this.userMapper.selectList(wrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

2.4 分页查询（IPage）

基于 MyBatis 的物理分页 ，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询。

/**
* 根据 entity 条件，查询全部记录（并翻页）
*
* @param page 分页查询条件（可以为 RowBounds.DEFAULT）
* @param queryWrapper 实体对象封装操作类（可以为 null）
*/
IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);

2.4.1 编写分页插件

这段代码可以固定的就这么写。

@Configuration
@MapperScan("com.example.mybatisplus.mapper")  // 设置mapper接口的扫描包
public class MybatisPlusConfig {
 
    @Bean  // 配置分页插件
    public MybatisPlusInterceptor paginationInnerInterceptor(){
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // PaginationInnerInterceptor为分页拦截器
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}}

2.4.2 编写测试方法

@Test
public void testSelectPage() {
    Page<User> page = new Page<>(2, 2);  // 查询第二页，每页显示2条数据
    QueryWrapper<User> wrapper = new QueryWrapper<>();
 
    // 设置查询条件
    wrapper.like("email", "itcast");
 
    IPage<User> iPage = this.userMapper.selectPage(page, wrapper);
    System.out.println("数据总条数：" + iPage.getTotal());
    System.out.println("数据总页数：" + iPage.getPages());
    System.out.println("当前页数：" + iPage.getCurrent());
 
    List<User> records = iPage.getRecords();
    for (User record : records) {
        System.out.println(record);
    }
}}
}