Mybatis-Plus?CRUD操作方法

更新時(shí)間：2023年10月25日 12:43:21 作者：wei_shuo

通用?Service?CRUD?封裝?IService?接口，進(jìn)一步封裝?CRUD?采用?get?查詢、remove?刪除?、list?查詢集合、page?分頁(yè)的前綴命名方式區(qū)分?Mapper?層避免混淆，這篇文章主要介紹了Mybatis-Plus?CRUD的相關(guān)知識(shí),需要的朋友可以參考下

Mybatis-Plus CRUD

通用 Service CRUD 封裝 IService 接口，進(jìn)一步封裝 CRUD 采用 get 查詢、remove 刪除、list 查詢集合、page 分頁(yè)的前綴命名方式區(qū)分 Mapper 層避免混淆
泛型 T 為任意實(shí)體對(duì)象
如果自定義通用 Service 方法，可以創(chuàng)建自己的 IBaseService 繼承 Mybatis-Plus 提供的基類IService
對(duì)象 Wrapper 為條件構(gòu)造器

Service CRUD 接口

Save

類型	參數(shù)名	描述
T	entity	實(shí)體對(duì)象
Collection	entityList	實(shí)體對(duì)象集合
int	batchSize	插入批次數(shù)量

// 插入一條記錄（選擇字段，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection<T> entityList);
// 插入（批量）
boolean saveBatch(Collection<T> entityList, int batchSize);

SaveOrUpdate

類型	參數(shù)名	描述
T	entity	實(shí)體對(duì)象
Wrapper	updateWrapper	實(shí)體對(duì)象封裝操作類 UpdateWrapper
Collection	entityList	實(shí)體對(duì)象集合
int	batchSize	插入批次數(shù)量

// TableId 注解存在更新記錄，是否插入一條記錄
boolean saveOrUpdate(T entity);
// 根據(jù)updateWrapper嘗試更新，是否繼續(xù)執(zhí)行saveOrUpdate(T)方法
boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);

Remove

類型	參數(shù)名	描述
Wrapper	queryWrapper	實(shí)體包裝類 QueryWrapper
Serializable	id	主鍵 ID
Map<String, Object>	columnMap	表字段 map 對(duì)象
Collection<? extends Serializable>	idList	主鍵 ID 列表

// 根據(jù) UpdateWrapper 條件，更新記錄 需要設(shè)置sqlset
boolean update(Wrapper<T> updateWrapper);
// 根據(jù) whereWrapper 條件，更新記錄
boolean update(T updateEntity, Wrapper<T> whereWrapper);
// 根據(jù) ID 選擇修改
boolean updateById(T entity);
// 根據(jù)ID 批量更新
boolean updateBatchById(Collection<T> entityList);
// 根據(jù)ID 批量更新
boolean updateBatchById(Collection<T> entityList, int batchSize);

Update

類型	參數(shù)名	描述
Wrapper	updateWrapper	實(shí)體對(duì)象封裝操作類 UpdateWrapper
T	entity	實(shí)體對(duì)象
Collection	entityList	實(shí)體對(duì)象集合
int	batchSize	更新批次數(shù)量

// 根據(jù) UpdateWrapper 條件，更新記錄 需要設(shè)置sqlset
boolean update(Wrapper<T> updateWrapper);
// 根據(jù) whereWrapper 條件，更新記錄
boolean update(T updateEntity, Wrapper<T> whereWrapper);
// 根據(jù) ID 選擇修改
boolean updateById(T entity);
// 根據(jù)ID 批量更新
boolean updateBatchById(Collection<T> entityList);
// 根據(jù)ID 批量更新
boolean updateBatchById(Collection<T> entityList, int batchSize);

Get

類型	參數(shù)名	描述
Serializable	id	主鍵 ID
Wrapper	queryWrapper	實(shí)體對(duì)象封裝操作類 QueryWrapper
boolean	throwEx	有多個(gè) result 是否拋出異常
T	entity	實(shí)體對(duì)象
Function<? super Object, V>	mapper	轉(zhuǎn)換函數(shù)

// 根據(jù) ID 查詢
T getById(Serializable id);
// 根據(jù) Wrapper，查詢一條記錄。結(jié)果集，如果是多個(gè)會(huì)拋出異常，隨機(jī)取一條加上限制條件 wrapper.last("LIMIT 1")
T getOne(Wrapper<T> queryWrapper);
// 根據(jù) Wrapper，查詢一條記錄
T getOne(Wrapper<T> queryWrapper, boolean throwEx);
// 根據(jù) Wrapper，查詢一條記錄
Map<String, Object> getMap(Wrapper<T> queryWrapper);
// 根據(jù) Wrapper，查詢一條記錄
<V> V getObj(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);

List

類型	參數(shù)名	描述
Wrapper	queryWrapper	實(shí)體對(duì)象封裝操作類 QueryWrapper
Collection<? extends Serializable>	idList	主鍵 ID 列表
Map<String, Object>	columnMap	表字段 map 對(duì)象
Function<? super Object, V>	mapper	轉(zhuǎn)換函數(shù)

// 查詢所有
List<T> list();
// 查詢列表
List<T> list(Wrapper<T> queryWrapper);
// 查詢（根據(jù)ID 批量查詢）
Collection<T> listByIds(Collection<? extends Serializable> idList);
// 查詢（根據(jù) columnMap 條件）
Collection<T> listByMap(Map<String, Object> columnMap);
// 查詢所有列表
List<Map<String, Object>> listMaps();
// 查詢列表
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
// 查詢?nèi)坑涗?
List<Object> listObjs();
// 查詢?nèi)坑涗?
<V> List<V> listObjs(Function<? super Object, V> mapper);
// 根據(jù) Wrapper 條件，查詢?nèi)坑涗?
List<Object> listObjs(Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢?nèi)坑涗?
<V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);

Page

IPage	page	翻頁(yè)對(duì)象
Wrapper	queryWrapper	實(shí)體對(duì)象封裝操作類 QueryWrapper

// 無(wú)條件分頁(yè)查詢
IPage<T> page(IPage<T> page);
// 條件分頁(yè)查詢
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
// 無(wú)條件分頁(yè)查詢
IPage<Map<String, Object>> pageMaps(IPage<T> page);
// 條件分頁(yè)查詢
IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper);

Count

類型	參數(shù)名	描述
Wrapper	queryWrapper	實(shí)體對(duì)象封裝操作類 QueryWrapper

// 查詢總記錄數(shù)
int count();
// 根據(jù) Wrapper 條件，查詢總記錄數(shù)
int count(Wrapper<T> queryWrapper);

Chain

query

// 鏈?zhǔn)讲樵?普通
QueryChainWrapper<T> query();
// 鏈?zhǔn)讲樵?lambda 式。注意：不支持 Kotlin
LambdaQueryChainWrapper<T> lambdaQuery();
// 示例：
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();

update

// 鏈?zhǔn)礁?普通
UpdateChainWrapper<T> update();
// 鏈?zhǔn)礁?lambda 式。注意：不支持 Kotlin
LambdaUpdateChainWrapper<T> lambdaUpdate();

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

Mapper CRUD 接口

通用 CRUD 封裝 BaseMapper 接口，為 Mybatis-Plus 啟動(dòng)時(shí)自動(dòng)解析實(shí)體表關(guān)系映射轉(zhuǎn)換為 Mybatis 內(nèi)部對(duì)象注入容器

泛型 T 為任意實(shí)體對(duì)象

參數(shù) Serializable 為任意類型主鍵 Mybatis-Plus 不推薦使用復(fù)合主鍵，約定每一張表，都有自己的唯一 id 主鍵

對(duì)象 Wrapper 為條件構(gòu)造器

Insert

類型	參數(shù)名	描述
T	entity	實(shí)體對(duì)象

// 插入一條記錄
int insert(T entity);

Delete

類型	參數(shù)名	描述
Wrapper	wrapper	實(shí)體對(duì)象封裝操作類（可以為 null）
Collection<? extends Serializable>	idList	主鍵 ID 列表(不能為 null 以及 empty)
Serializable	id	主鍵 ID
Map<String, Object>	columnMap	表字段 map 對(duì)象

// 根據(jù) entity 條件，刪除記錄
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
// 刪除（根據(jù)ID 批量刪除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根據(jù) ID 刪除
int deleteById(Serializable id);
// 根據(jù) columnMap 條件，刪除記錄
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

Update

類型	參數(shù)名	描述
T	entity	實(shí)體對(duì)象 (set 條件值,可為 null)
Wrapper	updateWrapper	實(shí)體對(duì)象封裝操作類（可以為 null,里面的 entity 用于生成 where 語(yǔ)句）

調(diào)用updateById方法前，需要在T entity（對(duì)應(yīng)的實(shí)體類）中的主鍵屬性上加上@TableId注解

// 根據(jù) whereWrapper 條件，更新記錄
int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper);
// 根據(jù) ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

Select

類型	參數(shù)名	描述
Serializable	id	主鍵 ID
Wrapper	queryWrapper	實(shí)體對(duì)象封裝操作類（可以為 null）
Collection<? extends Serializable>	idList	主鍵 ID 列表(不能為 null 以及 empty)
Map<String, Object>	columnMap	表字段 map 對(duì)象
IPage	page	分頁(yè)查詢條件（可以為 RowBounds.DEFAULT）

// 根據(jù) ID 查詢
T selectById(Serializable id);
// 根據(jù) entity 條件，查詢一條記錄
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 查詢（根據(jù)ID 批量查詢）
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根據(jù) entity 條件，查詢?nèi)坑涗?
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 查詢（根據(jù) columnMap 條件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根據(jù) Wrapper 條件，查詢?nèi)坑涗?
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢?nèi)坑涗?。注意?只返回第一個(gè)字段的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根據(jù) entity 條件，查詢?nèi)坑涗洠ú⒎?yè)）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢?nèi)坑涗洠ú⒎?yè)）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢總記錄數(shù)
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

到此這篇關(guān)于Mybatis-Plus CRUD的文章就介紹到這了,更多相關(guān)Mybatis-Plus CRUD內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: