MyBatis-Plus(七)~CRUD接口

一、Mapper CRUD 接口

说明:

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

(1)、insert

/** *

* 插入一条记录 *

* * @param entity 实体对象 * @return 插入成功记录数 */
int insert(T entity);
(2)、deleteById

/** *

* 根据 ID 删除 *

* * @param id 主键ID * @return 删除成功记录数 */
int deleteById(Serializable id);
(3)、deleteByMap

/** *

* 根据 columnMap 条件,删除记录 *

* * @param columnMap 表字段 map 对象 * @return 删除成功记录数 */
int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
(4)、delete

/** *

* 根据 entity 条件,删除记录 *

* * @param queryWrapper 实体对象封装操作类(可以为 null) * @return 删除成功记录数 */
int delete(@Param(Constants.WRAPPER) Wrapper queryWrapper);
(5)、deleteBatchIds

/** *

* 删除(根据ID 批量删除) *

* * @param idList 主键ID列表(不能为 null 以及 empty) * @return 删除成功记录数 */
int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);

(6)、updateById

/** *

* 根据 ID 修改 *

* * @param entity 实体对象 * @return 修改成功记录数 */
int updateById(@Param(Constants.ENTITY) T entity);
(7)、update

/** *

* 根据 whereEntity 条件,更新记录 *

* * @param entity 实体对象 (set 条件值,不能为 null) * @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where 语句) * @return 修改成功记录数 */
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);
(8)、selectById

/** *

* 根据 ID 查询 *

* * @param id 主键ID * @return 实体 */
T selectById(Serializable id);
(9)、selectBatchIds

/** *

* 查询(根据ID 批量查询) *

* * @param idList 主键ID列表(不能为 null 以及 empty) * @return 实体集合 */
List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);
(10)、selectByMap

/** *

* 查询(根据 columnMap 条件) *

* * @param columnMap 表字段 map 对象 * @return 实体集合 */
List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
(11)、selectOne

/** *

* 根据 entity 条件,查询一条记录 *

* * @param queryWrapper 实体对象 * @return 实体 */
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);
(12)、selectCount

/** *

* 根据 Wrapper 条件,查询总记录数 *

* * @param queryWrapper 实体对象 * @return 满足条件记录数 */
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);
(13)、selectList

/** *

* 根据 entity 条件,查询全部记录 *

* * @param queryWrapper 实体对象封装操作类(可以为 null) * @return 实体集合 */
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);
(14)、selectMaps

/** *

* 根据 Wrapper 条件,查询全部记录 *

* * @param queryWrapper 实体对象封装操作类(可以为 null) * @return 字段映射对象 Map 集合 */
List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);
(15)、selectObjs

/** *

* 根据 Wrapper 条件,查询全部记录 * 注意: 只返回第一个字段的值 *

* * @param queryWrapper 实体对象封装操作类(可以为 null) * @return 字段映射对象集合 */
List selectObjs(@Param(Constants.WRAPPER) Wrapper queryWrapper);
(16)、selectPage

/** *

* 根据 entity 条件,查询全部记录(并翻页) *

* * @param page 分页查询条件(可以为 RowBounds.DEFAULT) * @param queryWrapper 实体对象封装操作类(可以为 null) * @return 实体分页对象 */
IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);

(17)、selectMapsPage

/** *

* 根据 Wrapper 条件,查询全部记录(并翻页) *

* * @param page 分页查询条件 * @param queryWrapper 实体对象封装操作类 * @return 字段映射对象 Map 分页对象 */
IPage> selectMapsPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);

二、Service CRUD 接口

说明:

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

(1)、save

/** *

* 插入一条记录(选择字段,策略插入) *

* * @param entity 实体对象 */
boolean save(T entity);
(2)、saveBatch

/** *

* 插入一条记录(选择字段,策略插入) *

* * @param entity 实体对象 */
(3)、saveOrUpdateBatch

/** *

* 批量修改插入 *

* * @param entityList 实体对象集合 */
boolean saveOrUpdateBatch(Collection entityList);
(4)、saveOrUpdateBatch

/** *

* 批量修改插入 *

* * @param entityList 实体对象集合 * @param batchSize 每次的数量 */
boolean saveOrUpdateBatch(Collection entityList, int batchSize);
(5)、removeById

/** *

* 根据 ID 删除 *

* * @param id 主键ID */
boolean removeById(Serializable id);
(6)、removeByMap

/** *

* 根据 columnMap 条件,删除记录 *

* * @param columnMap 表字段 map 对象 */
boolean removeByMap(Map columnMap);
(7)、remove

/** *

* 根据 entity 条件,删除记录 *

* * @param queryWrapper 实体包装类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
boolean remove(Wrapper queryWrapper);

(8)、removeByIds

/** *

* 删除(根据ID 批量删除) *

* * @param idList 主键ID列表 */
boolean removeByIds(Collection idList);
(9)、updateById

/** *

* 根据 ID 选择修改 *

* * @param entity 实体对象 */
boolean updateById(T entity);
(10)、update

/** *

* 根据 whereEntity 条件,更新记录 *

* * @param entity 实体对象 * @param updateWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper} */
boolean update(T entity, Wrapper updateWrapper);
(11)、updateBatchById

/** *

* 根据ID 批量更新 *

* * @param entityList 实体对象集合 * @param batchSize 更新批次数量 */
boolean updateBatchById(Collection entityList, int batchSize);
(12)、saveOrUpdate

/** *

* TableId 注解存在更新记录,否插入一条记录 *

* * @param entity 实体对象 */
boolean saveOrUpdate(T entity);
(13)、getById

/** *

* 根据 ID 查询 *

* * @param id 主键ID */
T getById(Serializable id);
(14)、listByIds

/** *

* 查询(根据ID 批量查询) *

* * @param idList 主键ID列表 */

Collection listByIds(Collection idList);
(15)、listByMap

/** *

* 查询(根据 columnMap 条件) *

* * @param columnMap 表字段 map 对象 */
Collection listByMap(Map columnMap);
(16)、getOne

/** *

* 根据 Wrapper,查询一条记录 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} * @param throwEx 有多个 result 是否抛出异常 */
T getOne(Wrapper queryWrapper, boolean throwEx);
(17)、getMap

/** *

* 根据 Wrapper,查询一条记录 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
Map getMap(Wrapper queryWrapper);
(18)、getObj

/** *

* 根据 Wrapper,查询一条记录 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
Object getObj(Wrapper queryWrapper);
(19)、count

/** *

* 根据 Wrapper 条件,查询总记录数 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
int count(Wrapper queryWrapper);
(20)、list

/** *

* 查询列表 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
List list(Wrapper queryWrapper);

(21)、page

/** *

* 翻页查询 *

* * @param page 翻页对象 * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
IPage page(IPage page, Wrapper queryWrapper);
(22)、listMaps

/** *

* 查询列表 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */

List> listMaps(Wrapper queryWrapper);
(23)、listObjs

/** *

* 根据 Wrapper 条件,查询全部记录 *

* * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
List listObjs(Wrapper queryWrapper);
(24)、pageMaps

/** *

* 翻页查询 *

* * @param page 翻页对象 * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper} */
IPage> pageMaps(IPage page, Wrapper queryWrapper);

转载于:https://my.oschina.net/tobeexpertismydream/blog/2984263

你可能感兴趣的:(java)