【 MyBatis-Plus 】：BaseMapper 接口

1、BaseMapper 接口

上一篇我们了解了BaseMapper 接口，那么现在我们具体去了解 BaseMapper 接口的这些方法

2、增删改语句

2.1、关于添加语句的方法

BaseMapper 中只定义了一种关于添加语句的方法

/*
  插入一条记录 
  @param entity 实体对象 
*/ 
int insert(T entity);

具体使用方法：

User user = new User(); 
//进行一些数据填充  user.setXXX(XXX)等

// userMapper 接口是 一个 Mapper 接口，继承了 BaseMapper<User> 接口
//返回的result是受影响的行数
int result = this.userMapper.insert(user); 

在使用添加方法时，需要注意的是：如果实体类映射的数据表有主键，且主键是自增长，那么想要在实体类上对该字段设置为自增主键。在完成添加操作之后，某些自动生成的数据会回填到对象中，例如主键自增长自动生成的主键会回填给对应的字段。

2.2、关于更新语句的方法

BaseMapper 中定义了两种关于更新语句的方法，一种是以主键为更新条件，一种是自定义更新条件。

/*
 根据 ID 修改 
 @param entity 实体对象
*/
int updateById(@Param(Constants.ENTITY) T entity);

具体使用方法：

User user = new User(); 
//进行一些数据填充  user.setXXX(XXX)等

// userMapper 接口继承了 BaseMapper<User> 接口
//返回的result是受影响的行数
//根据id更新，只更新 user 中不为 null 的字段
int result = this.userMapper.updateById(user); 

这个方法只有一个判断条件，更新的字段与实体类数据的填充有关，SQL 语句为update set XXXX where 主键 = ?

/*
 根据 whereEntity 条件，更新记录 
 @param entity 实体对象 (可以为 null)
 @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
 */
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

2.3、关于删除语句的方法

BaseMapper 中定义了四种关于删除语句的方法。

• 根据主键删除：

  /*** 
    根据 ID 删除
  * @param id 主键ID
  */
  int deleteById(Serializable id);
  

  // userMapper 接口继承了 BaseMapper<User> 接口
  //返回的result是受影响的行数
  int result = this.userMapper.deleteById(1); 
  

  在传入参数的时候，参数类型和主键类型有关。
• 根据自定义条件删除：

  /*
    根据 columnMap 条件，删除记录 
  * @param columnMap 表字段 map 对象 
  */
  int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
  

  Map<String, Object> columnMap = new HashMap<>(); 
  //进行一些数据填充，columnMap.put("数据库字段名",值);
  
  //将columnMap中的元素设置为删除的条件，多个之间为and关系
  //delete from user where XXX AND XXX AND XXX
  //返回的result是受影响的行数
  int result = this.userMapper.deleteByMap(columnMap); 
  

  使用这种方法时，不需要使用实体类的属性，Map 中的键直接传入表的字段名。
• 根据自定义条件删除：

  /*
    根据 entity 条件，删除记录 *
  * @param wrapper 实体对象封装操作类（可以为 null）
  */
  int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
  

• 根据主键批量删除：

  /*
   删除（根据ID 批量删除）
  *@param idList 主键ID列表(不能为 null 以及 empty) 
  */
  int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
  

  //根据主键集合批量删除
  //返回的result是受影响的行数
  int result = this.userMapper.deleteBatchIds(Arrays.asList(1L,10L,20L)); 
  

2.4、关于查询语句的方法

BaseMapper 中定义了多种查询操作，包括根据id查询、批量查询、查询单条数据、查询列表、分页查询等操作

• 根据 id 查询：

  /*
    根据 ID 查询 
  * @param id 主键ID 
  */
  T selectById(Serializable id);
  

  //根据id查询数据 
  //返回的 user 是查询到的数据
  User user = this.userMapper.selectById();
  

• 根据 id 批量查询：

  /*
   查询（根据ID 批量查询）
  @param idList 主键ID列表(不能为 null 以及 empty) 
  */
  List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
  

  //根据id查询数据 
  //返回的 User 对象的集合
  List<User> users = this.userMapper.selectBatchIds(Arrays.asList(2L, 3L, 10L));
  

• 只查询一条数据： 根据条件查询一条数据，如果结果超过一条会报错

  /***
     根据 entity 条件，查询一条记录 
  * @param queryWrapper 实体对象封装操作类（可以为 null） 
  */
  T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  

• 查询总记录数： 根据条件查询查询总记录数，返回一个整数

  /*** 
   根据 Wrapper 条件，查询总记录数 
  * @param queryWrapper 实体对象封装操作类（可以为 null） 
  */ 
  Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  

• 批量查询：

  /*
    根据 entity 条件，查询全部记录
  @param queryWrapper 实体对象封装操作类（可以为 null） 
  */ 
  List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  
  
  /*** 
    根据 columnMap 条件，查询全部记录
  * @param columnMap 表字段 map 对象 
  */ 
  List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
  

• 分页查询： 想要使用分页查询必须先对分页插件进行配置。

  //Spring boot方式
  //在 Spring boot 启动类上添加
  //直接添加不需要修改
  @Bean
  public MybatisPlusInterceptor mybatisPlusInterceptor() {
      MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
      interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
      return interceptor;
  }
  

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

  //两个参数的意思，查询第几页和每页的条数
  Page<Order> page = new Page<>(1,1);
  //根据条件查询数据
  IPage<Order> iPage = this.orderMapper.selectPage(page, queryWrapper);
  System.out.println("数据总条数：" + iPage.getTotal());
  System.out.println("总页数：" + iPage.getPages());
  System.out.println("查询到的数据：" + iPage.getRecords());
  

2.5、条件构造器

在上述方法中，有些方法的形参是Wrapper。Wrapper就是 MyBatis-Plus 中的条件构造器，用于生成 sql 的 where 条件。具体内容请查看(传送门)