CRUD 接口

Service CRUD 接口

说明:

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

Save

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

SaveOrUpdate

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

Remove

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

Update

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

Get

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

List

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

Page

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

Count

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

Chain

query

  1. // 链式查询 普通
  2. QueryChainWrapper<T> query();
  3. // 链式查询 lambda 式。注意：不支持 Kotlin
  4. LambdaQueryChainWrapper<T> lambdaQuery(); 
  6. // 示例：
  7. query().eq("column", value).one();
  8. lambdaQuery().eq(Entity::getId, value).list();

update

  1. // 链式更改 普通
  2. UpdateChainWrapper<T> update();
  3. // 链式更改 lambda 式。注意：不支持 Kotlin 
  4. LambdaUpdateChainWrapper<T> lambdaUpdate();
  6. // 示例：
  7. update().eq("column", value).remove();
  8. lambdaUpdate().eq(Entity::getId, value).update(entity);

Mapper CRUD 接口

说明:

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

Insert

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

Delete

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

Update

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

Select

  1. // 根据 ID 查询
  2. T selectById(Serializable id);
  3. // 根据 entity 条件，查询一条记录
  4. T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  6. // 查询（根据ID 批量查询）
  7. List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
  8. // 根据 entity 条件，查询全部记录
  9. List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  10. // 查询（根据 columnMap 条件）
  11. List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
  12. // 根据 Wrapper 条件，查询全部记录
  13. List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  14. // 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
  15. List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  17. // 根据 entity 条件，查询全部记录（并翻页）
  18. IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  19. // 根据 Wrapper 条件，查询全部记录（并翻页）
  20. IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  21. // 根据 Wrapper 条件，查询总记录数
  22. Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
参数说明
类型参数名描述
Serializableid主键ID
Wrapper<T>queryWrapper实体对象封装操作类（可以为 null）
Collection<? extends Serializable>idList主键ID列表(不能为 null 以及 empty)
Map<String, Object>columnMap表字段 map 对象
IPage<T>page分页查询条件（可以为 RowBounds.DEFAULT）

mapper 层 选装件

说明:

选装件位于 com.baomidou.mybatisplus.extension.injector.methods.additional 包下 需要配合Sql 注入器使用,案例CRUD 接口 - 图3
使用详细见源码注释CRUD 接口 - 图4

AlwaysUpdateSomeColumnById

  1. int alwaysUpdateSomeColumnById(T entity);

insertBatchSomeColumn

  1. int insertBatchSomeColumn(List<T> entityList);

deleteByIdWithFill

  1. int deleteByIdWithFill(T entity);