MyBatis-Plus （7） CRUD 接口

不念不忘少年蓝@ 2023-07-08 09:19 11阅读 0赞

## Service CRUD 接口 ##

说明:

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

### [\#][Link 2]Save ###

// 插入一条记录（选择字段，策略插入）
    boolean save(T entity);
    // 插入（批量）
    boolean saveBatch(Collection<T> entityList);
    // 插入（批量）
    boolean saveBatch(Collection<T> entityList, int batchSize);

[\#][Link 3]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>T</td> 
   <td>entity</td> 
   <td>实体对象</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;T&gt;</td> 
   <td>entityList</td> 
   <td>实体对象集合</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>batchSize</td> 
   <td>插入批次数量</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 4]SaveOrUpdate ###

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

[\#][Link 5]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>T</td> 
   <td>entity</td> 
   <td>实体对象</td> 
  </tr> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>updateWrapper</td> 
   <td>实体对象封装操作类 UpdateWrapper</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;T&gt;</td> 
   <td>entityList</td> 
   <td>实体对象集合</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>batchSize</td> 
   <td>插入批次数量</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 6]Remove ###

// 根据 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);

[\#][Link 7]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>queryWrapper</td> 
   <td>实体包装类 QueryWrapper</td> 
  </tr> 
  <tr> 
   <td>Serializable</td> 
   <td>id</td> 
   <td>主键ID</td> 
  </tr> 
  <tr> 
   <td>Map&lt;String, Object&gt;</td> 
   <td>columnMap</td> 
   <td>表字段 map 对象</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;? extends Serializable&gt;</td> 
   <td>idList</td> 
   <td>主键ID列表</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 8]Update ###

// 根据 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);

[\#][Link 9]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>updateWrapper</td> 
   <td>实体对象封装操作类 UpdateWrapper</td> 
  </tr> 
  <tr> 
   <td>T</td> 
   <td>entity</td> 
   <td>实体对象</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;T&gt;</td> 
   <td>entityList</td> 
   <td>实体对象集合</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>batchSize</td> 
   <td>更新批次数量</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 10]Get ###

// 根据 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);

[\#][Link 11]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Serializable</td> 
   <td>id</td> 
   <td>主键ID</td> 
  </tr> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>queryWrapper</td> 
   <td>实体对象封装操作类 QueryWrapper</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>throwEx</td> 
   <td>有多个 result 是否抛出异常</td> 
  </tr> 
  <tr> 
   <td>T</td> 
   <td>entity</td> 
   <td>实体对象</td> 
  </tr> 
  <tr> 
   <td>Function&lt;? super Object, V&gt;</td> 
   <td>mapper</td> 
   <td>转换函数</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 12]List ###

// 查询所有
    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);

[\#][Link 13]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>queryWrapper</td> 
   <td>实体对象封装操作类 QueryWrapper</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;? extends Serializable&gt;</td> 
   <td>idList</td> 
   <td>主键ID列表</td> 
  </tr> 
  <tr> 
   <td>Map&lt;?String, Object&gt;</td> 
   <td>columnMap</td> 
   <td>表字段 map 对象</td> 
  </tr> 
  <tr> 
   <td>Function&lt;? super Object, V&gt;</td> 
   <td>mapper</td> 
   <td>转换函数</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 14]Page ###

// 无条件翻页查询
    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);

[\#][Link 15]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>IPage&lt;T&gt;</td> 
   <td>page</td> 
   <td>翻页对象</td> 
  </tr> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>queryWrapper</td> 
   <td>实体对象封装操作类 QueryWrapper</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 16]Count ###

// 查询总记录数
    int count();
    // 根据 Wrapper 条件，查询总记录数
    int count(Wrapper<T> queryWrapper);

[\#][Link 17]参数说明

### [\#][Link 18]Chain ###

[\#][Link 19]query

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

[\#][Link 20]update

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

## [\#][Link 21]Mapper CRUD 接口 ##

说明:

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

### [\#][Link 22]Insert ###

// 插入一条记录
    int insert(T entity);

[\#][Link 23]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>T</td> 
   <td>entity</td> 
   <td>实体对象</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 24]Delete ###

// 根据 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);

[\#][Link 25]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>wrapper</td> 
   <td>实体对象封装操作类（可以为 null）</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;? extends Serializable&gt;</td> 
   <td>idList</td> 
   <td>主键ID列表(不能为 null 以及 empty)</td> 
  </tr> 
  <tr> 
   <td>Serializable</td> 
   <td>id</td> 
   <td>主键ID</td> 
  </tr> 
  <tr> 
   <td>Map&lt;String, Object&gt;</td> 
   <td>columnMap</td> 
   <td>表字段 map 对象</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 26]Update ###

// 根据 whereEntity 条件，更新记录
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
    // 根据 ID 修改
    int updateById(@Param(Constants.ENTITY) T entity);

[\#][Link 27]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>T</td> 
   <td>entity</td> 
   <td>实体对象 (set 条件值,可为 null)</td> 
  </tr> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>updateWrapper</td> 
   <td>实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）</td> 
  </tr> 
 </tbody> 
</table>

### [\#][Link 28]Select ###

// 根据 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);

[\#][Link 29]参数说明

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>参数名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Serializable</td> 
   <td>id</td> 
   <td>主键ID</td> 
  </tr> 
  <tr> 
   <td>Wrapper&lt;T&gt;</td> 
   <td>queryWrapper</td> 
   <td>实体对象封装操作类（可以为 null）</td> 
  </tr> 
  <tr> 
   <td>Collection&lt;? extends Serializable&gt;</td> 
   <td>idList</td> 
   <td>主键ID列表(不能为 null 以及 empty)</td> 
  </tr> 
  <tr> 
   <td>Map&lt;String, Object&gt;</td> 
   <td>columnMap</td> 
   <td>表字段 map 对象</td> 
  </tr> 
  <tr> 
   <td>IPage&lt;T&gt;</td> 
   <td>page</td> 
   <td>分页查询条件（可以为 RowBounds.DEFAULT）</td> 
  </tr> 
 </tbody> 
</table>

## [\#][Link 30]mapper 层 选装件 ##

说明:

选装件位于 `com.baomidou.mybatisplus.extension.injector.methods.additional` 包下 需要配合[Sql 注入器][Sql]使用,[案例][Link 31]  
使用详细见[源码注释][Link 32]

### [\#][Link 33][AlwaysUpdateSomeColumnById][] ###

int alwaysUpdateSomeColumnById(T entity);

### [\#][Link 34][insertBatchSomeColumn][] ###

int insertBatchSomeColumn(List<T> entityList);

### [\#][Link 35][deleteByIdWithFill][] ###

int deleteByIdWithFill(T entity);

[IService]: https://gitee.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-extension/src/main/java/com/baomidou/mybatisplus/extension/service/IService.java
[Link 1]: https://mp.baomidou.com/guide/wrapper.html
[Link 2]: https://mp.baomidou.com/guide/crud-interface.html#save
[Link 3]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E
[Link 4]: https://mp.baomidou.com/guide/crud-interface.html#saveorupdate
[Link 5]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-2
[Link 6]: https://mp.baomidou.com/guide/crud-interface.html#remove
[Link 7]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-3
[Link 8]: https://mp.baomidou.com/guide/crud-interface.html#update
[Link 9]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-4
[Link 10]: https://mp.baomidou.com/guide/crud-interface.html#get
[Link 11]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-5
[Link 12]: https://mp.baomidou.com/guide/crud-interface.html#list
[Link 13]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-6
[Link 14]: https://mp.baomidou.com/guide/crud-interface.html#page
[Link 15]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-7
[Link 16]: https://mp.baomidou.com/guide/crud-interface.html#count
[Link 17]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-8
[Link 18]: https://mp.baomidou.com/guide/crud-interface.html#chain
[Link 19]: https://mp.baomidou.com/guide/crud-interface.html#query
[Link 20]: https://mp.baomidou.com/guide/crud-interface.html#update-2
[Link 21]: https://mp.baomidou.com/guide/crud-interface.html#mapper-crud-%E6%8E%A5%E5%8F%A3
[BaseMapper]: https://gitee.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/mapper/BaseMapper.java
[Link 22]: https://mp.baomidou.com/guide/crud-interface.html#insert
[Link 23]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-9
[Link 24]: https://mp.baomidou.com/guide/crud-interface.html#delete
[Link 25]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-10
[Link 26]: https://mp.baomidou.com/guide/crud-interface.html#update-3
[Link 27]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-11
[Link 28]: https://mp.baomidou.com/guide/crud-interface.html#select
[Link 29]: https://mp.baomidou.com/guide/crud-interface.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-12
[Link 30]: https://mp.baomidou.com/guide/crud-interface.html#mapper-%E5%B1%82-%E9%80%89%E8%A3%85%E4%BB%B6
[Sql]: https://mp.baomidou.com/guide/sql-injector.html
[Link 31]: https://gitee.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-sql-injector
[Link 32]: https://gitee.com/baomidou/mybatis-plus/tree/3.0/mybatis-plus-extension/src/main/java/com/baomidou/mybatisplus/extension/injector/methods/additional
[Link 33]: https://mp.baomidou.com/guide/crud-interface.html#alwaysupdatesomecolumnbyid
[AlwaysUpdateSomeColumnById]: https://gitee.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-extension/src/main/java/com/baomidou/mybatisplus/extension/injector/methods/additional/AlwaysUpdateSomeColumnById.java
[Link 34]: https://mp.baomidou.com/guide/crud-interface.html#insertbatchsomecolumn
[insertBatchSomeColumn]: https://gitee.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-extension/src/main/java/com/baomidou/mybatisplus/extension/injector/methods/additional/InsertBatchSomeColumn.java
[Link 35]: https://mp.baomidou.com/guide/crud-interface.html#deletebyidwithfill
[deleteByIdWithFill]: https://gitee.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-extension/src/main/java/com/baomidou/mybatisplus/extension/injector/methods/additional/LogicDeleteByIdWithFill.java