Mybatis Plus CRUD 接口

本文最后更新于：2024年9月8日 晚上

Mybatis Plus CRUD 接口

Service CRUD接口

说明

  • 通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆
  • 泛型 T 为任意实体对象。
  • 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的父类。
  • 对象 Wrapper 为条件构造器。

Save

1
2
3
4
5
6
// 插入一条记录（选择字段，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection<T> entityList);
// 插入（批量）
boolean saveBatch(Collection<T> entityList, int batchSize);
  • 参数说明。
类型 参数名 描述
T entity 实体对象
Collection entityList 实体对象集合
int batchSize 插入批次数量

SaveOrUpdate

1
2
3
4
5
6
7
8
// TableId 注解存在更新记录，否插入一条记录。
boolean saveOrUpdate(T entity);
// 根据updateWrapper尝试更新，否继续执行saveOrUpdate(T）方法。
boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper);
// 批量修改插入。
boolean saveOrUpdateBatch(Collection<T> entityList);
// 批量修改插入。
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);
  • 参数说明。
类型 参数名 描述
T entity 实体对象
Wrapper updateWrapper 实体对象封装操作类 UpdateWrapper
Collection entityList 实体对象集合
int batchSize 插入批次数量

Remove

1
2
3
4
5
6
7
8
// 根据 entity 条件，删除记录。
boolean remove(Wrapper<T> queryWrapper);
// 根据 ID 删除。
boolean removeById(Serializable id);
// 根据 columnMap 条件，删除记录。
boolean removeByMap(Map<String, Object> columnMap);
// 删除（根据ID 批量删除）
boolean removeByIds(Collection<? extends Serializable> idList);
  • 参数说明。
类型 参数名 描述
Wrapper queryWrapper 实体包装类 QueryWrapper
Serializable id 主键ID
Map<String, Object> columnMap 表字段 map 对象
Collection<? extends Serializable> idList 主键ID列表

Update

1
2
3
4
5
6
7
8
9
10
// 根据 UpdateWrapper 条件，更新记录需要设置sqlset
boolean update(Wrapper<T> updateWrapper);
// 根据 whereEntity 条件，更新记录。
boolean update(T entity, Wrapper<T> updateWrapper);
// 根据 ID 选择修改。
boolean updateById(T entity);
// 根据ID 批量更新。
boolean updateBatchById(Collection<T> entityList);
// 根据ID 批量更新。
boolean updateBatchById(Collection<T> entityList, int batchSize);
  • 参数说明。
类型 参数名 描述
Wrapper updateWrapper 实体对象封装操作类 UpdateWrapper
T entity 实体对象
Collection entityList 实体对象集合
int batchSize 更新批次数量

Get

1
2
3
4
5
6
7
8
9
10
// 根据 ID 查询。
T getById(Serializable id);
// 根据 Wrapper，查询一条记录，结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last("LIMIT 1")
T getOne(Wrapper<T> queryWrapper);
// 根据 Wrapper，查询一条记录。
T getOne(Wrapper<T> queryWrapper, boolean throwEx);
// 根据 Wrapper，查询一条记录。
Map<String, Object> getMap(Wrapper<T> queryWrapper);
// 根据 Wrapper，查询一条记录。
<V> V getObj(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);
  • 参数说明。
类型 参数名 描述
Serializable id 主键ID
Wrapper queryWrapper 实体对象封装操作类 QueryWrapper
boolean throwEx 有多个 result 是否抛出异常
T entity 实体对象
Function<? super Object, V> mapper 转换函数

List

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 查询所有。
List<T> list();
// 查询列表。
List<T> list(Wrapper<T> queryWrapper);
// 查询（根据ID 批量查询）
Collection<T> listByIds(Collection<? extends Serializable> idList);
// 查询（根据 columnMap 条件）
Collection<T> listByMap(Map<String, Object> columnMap);
// 查询所有列表。
List<Map<String, Object>> listMaps();
// 查询列表。
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
// 查询全部记录。
List<Object> listObjs();
// 查询全部记录。
<V> List<V> listObjs(Function<? super Object, V> mapper);
// 根据 Wrapper 条件，查询全部记录。
List<Object> listObjs(Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录。
<V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);
  • 参数说明。
类型 参数名 描述
Wrapper queryWrapper 实体对象封装操作类 QueryWrapper
Collection<? extends Serializable> idList 主键ID列表
Map<?String, Object> columnMap 表字段 map 对象
Function<? super Object, V> mapper 转换函数

Page

1
2
3
4
5
6
7
8
// 无条件分页查询。
IPage<T> page(IPage<T> page);
// 条件分页查询。
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
// 无条件分页查询。
IPage<Map<String, Object>> pageMaps(IPage<T> page);
// 条件分页查询。
IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper);
  • 参数说明。
类型 参数名 描述
IPage page 翻页对象
Wrapper queryWrapper 实体对象封装操作类 QueryWrapper

Count

1
2
3
4
// 查询总记录数。
int count();
// 根据 Wrapper 条件，查询总记录数。
int count(Wrapper<T> queryWrapper);
  • 参数说明。
类型 参数名 描述
Wrapper queryWrapper 实体对象封装操作类 QueryWrapper

Chain

query

1
2
3
4
5
6
7
8
// 链式查询普通。
QueryChainWrapper<T> query();
// 链式查询 lambda 式，注意：不支持 Kotlin
LambdaQueryChainWrapper<T> lambdaQuery();

// 示例：
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();

update

1
2
3
4
5
6
7
8
// 链式更改普通。
UpdateChainWrapper<T> update();
// 链式更改 lambda 式，注意：不支持 Kotlin
LambdaUpdateChainWrapper<T> lambdaUpdate();

// 示例：
update().eq("column", value).remove();
lambdaUpdate().eq(Entity::getId, value).update(entity);

Mapper CRUD 接口

说明

  • 通用 CRUD 封装BaseMapper接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器。
  • 泛型 T 为任意实体对象。
  • 参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键。
  • 对象 Wrapper 为条件构造器。

insert

1
2
// 插入一条记录。
int insert(T entity);
  • 参数说明。
类型 参数名 描述
T entity 实体对象

实例

1
2
3
4
5
6
7
8
9
@Test
public void testInsert(){
    User user = new User(); user.setName("test");
    user.setAge(3);
    user.setEmail("123456@qq.com");
    int result = userMapper.insert(user); // 自动生成id
    System.out.println(result); // 受影响的行数。
    System.out.println(user); // id会自动回填。
}

delete

1
2
3
4
5
6
7
8
// 根据 entity 条件，删除记录。
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根据 ID 删除。
int deleteById(Serializable id);
// 根据 columnMap 条件，删除记录。
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
  • 参数说明。
类型 参数名 描述
Wrapper wrapper 实体对象封装操作类（可以为 null)
Collection<? extends Serializable> idList 主键ID列表（不能为 null 以及 empty)
Serializable id 主键ID
Map<String, Object> columnMap 表字段 map 对象

实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Test
public void testDeleteById(){
    userMapper.deleteById(1240620674645544965L);
}

@Test
public void testDeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L,124062067464554496 2L));
}

@Test
public void testDeleteMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","test");
    userMapper.deleteByMap(map);
}

update

  • 所有的sql都是通过条件自动拼接动态sql
1
2
3
4
// 根据 whereEntity 条件，更新记录。
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
// 根据 ID 修改。
int updateById(@Param(Constants.ENTITY) T entity);
  • 参数说明。
类型 参数名 描述
T entity 实体对象（set 条件值，可为 null)
Wrapper updateWrapper 实体对象封装操作类（可以为 null，里面的 entity 用于生成 where 语句）

实例

1
2
3
4
5
6
7
8
9
10
11
@Test
public void testUpdate(){
    User user = new User();

    user.setId(6L);
    user.setName("test");
    user.setAge(18);

    int i = userMapper.updateById(user);
    System.out.println(i);
}

select

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// 根据 ID 查询。
T selectById(Serializable id);
// 根据 entity 条件，查询一条记录。
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 查询（根据ID 批量查询）
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根据 entity 条件，查询全部记录。
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 查询（根据 columnMap 条件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根据 Wrapper 条件，查询全部记录。
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录，注意：只返回第一个字段的值。
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 entity 条件，查询全部记录（并翻页）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询总记录数。
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  • 参数说明。
类型 参数名 描述
Serializable id 主键ID
Wrapper queryWrapper 实体对象封装操作类（可以为 null)
Collection<? extends Serializable> idList 主键ID列表（不能为 null 以及 empty)
Map<String, Object> columnMap 表字段 map 对象
IPage page 分页查询条件（可以为 RowBounds.DEFAULT)

实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user); }

    @Test
    public void testSelectByBatchId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println); }

    @Test
    public void testSelectByBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","test");
    map.put("age",3);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}