BaseMapper方法簡介
【添加數(shù)據(jù):(增)】
int insert(T entity); // 插入一條記錄
注:
T 表示任意實(shí)體類型
entity 表示實(shí)體對象
【刪除數(shù)據(jù):(刪)】
int deleteById(Serializable id); // 根據(jù)主鍵 ID 刪除
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap); // 根據(jù) map 定義字段的條件刪除
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper); // 根據(jù)實(shí)體類定義的 條件刪除對象
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList); // 進(jìn)行批量刪除
注:
id 表示 主鍵 ID
columnMap 表示表字段的 map 對象
wrapper 表示實(shí)體對象封裝操作類伪嫁,可以為 null虫蝶。
idList 表示 主鍵 ID 集合(列表、數(shù)組)腕铸,不能為 null 或 empty
【修改數(shù)據(jù):(改)】
int updateById(@Param(Constants.ENTITY) T entity); // 根據(jù) ID 修改實(shí)體對象砰奕。
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper); // 根據(jù) updateWrapper 條件修改實(shí)體對象
注:
update 中的 entity 為 set 條件橡娄,可以為 null坯认。
updateWrapper 表示實(shí)體對象封裝操作類(可以為 null,里面的 entity 用于生成 where 語句)
【查詢數(shù)據(jù):(查)】
T selectById(Serializable id); // 根據(jù) 主鍵 ID 查詢數(shù)據(jù)
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList); // 進(jìn)行批量查詢
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap); // 根據(jù)表字段條件查詢
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 根據(jù)實(shí)體類封裝對象 查詢一條記錄
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢記錄的總條數(shù)
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢所有記錄(返回 entity 集合)
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢所有記錄(返回 map 集合)
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢所有記錄(但只保存第一個字段的值)
<E extends IPage<T>> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢所有記錄(返回 entity 集合)卷中,分頁
<E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢所有記錄(返回 map 集合),分頁
注:
queryWrapper 表示實(shí)體對象封裝操作類(可以為 null)
page 表示分頁查詢條件
Service接口介紹
【添加數(shù)據(jù):(增)】
default boolean save(T entity); // 調(diào)用 BaseMapper 的 insert 方法唬格,用于添加一條數(shù)據(jù)家破。
boolean saveBatch(Collection<T> entityList, int batchSize); // 批量插入數(shù)據(jù)
注:
entityList 表示實(shí)體對象集合
batchSize 表示一次批量插入的數(shù)據(jù)量颜说,默認(rèn)為 1000
【添加或修改數(shù)據(jù):(增或改)】
boolean saveOrUpdate(T entity); // id 若存在购岗,則修改, id 不存在則新增數(shù)據(jù)
default boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper); // 先根據(jù)條件嘗試更新门粪,然后再執(zhí)行 saveOrUpdate 操作
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize); // 批量插入并修改數(shù)據(jù)
【刪除數(shù)據(jù):(刪)】
default boolean removeById(Serializable id); // 調(diào)用 BaseMapper 的 deleteById 方法喊积,根據(jù) id 刪除數(shù)據(jù)。
default boolean removeByMap(Map<String, Object> columnMap); // 調(diào)用 BaseMapper 的 deleteByMap 方法玄妈,根據(jù) map 定義字段的條件刪除
default boolean remove(Wrapper<T> queryWrapper); // 調(diào)用 BaseMapper 的 delete 方法乾吻,根據(jù)實(shí)體類定義的 條件刪除對象。
default boolean removeByIds(Collection<? extends Serializable> idList); // 用 BaseMapper 的 deleteBatchIds 方法, 進(jìn)行批量刪除拟蜻。
【修改數(shù)據(jù):(改)】
default boolean updateById(T entity); // 調(diào)用 BaseMapper 的 updateById 方法绎签,根據(jù) ID 選擇修改。
default boolean update(T entity, Wrapper<T> updateWrapper); // 調(diào)用 BaseMapper 的 update 方法酝锅,根據(jù) updateWrapper 條件修改實(shí)體對象诡必。
boolean updateBatchById(Collection<T> entityList, int batchSize); // 批量更新數(shù)據(jù)
【查找數(shù)據(jù):(查)】
default T getById(Serializable id); // 調(diào)用 BaseMapper 的 selectById 方法,根據(jù) 主鍵 ID 返回?cái)?shù)據(jù)搔扁。
default List<T> listByIds(Collection<? extends Serializable> idList); // 調(diào)用 BaseMapper 的 selectBatchIds 方法爸舒,批量查詢數(shù)據(jù)。
default List<T> listByMap(Map<String, Object> columnMap); // 調(diào)用 BaseMapper 的 selectByMap 方法稿蹲,根據(jù)表字段條件查詢
default T getOne(Wrapper<T> queryWrapper); // 返回一條記錄(實(shí)體類保存)扭勉。
Map<String, Object> getMap(Wrapper<T> queryWrapper); // 返回一條記錄(map 保存)。
default int count(Wrapper<T> queryWrapper); // 根據(jù)條件返回 記錄數(shù)苛聘。
default List<T> list(); // 返回所有數(shù)據(jù)涂炎。
default List<T> list(Wrapper<T> queryWrapper); // 調(diào)用 BaseMapper 的 selectList 方法,查詢所有記錄(返回 entity 集合)设哗。
default List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper); // 調(diào)用 BaseMapper 的 selectMaps 方法唱捣,查詢所有記錄(返回 map 集合)。
default List<Object> listObjs(); // 返回全部記錄熬拒,但只返回第一個字段的值爷光。
default <E extends IPage<T>> E page(E page, Wrapper<T> queryWrapper); // 調(diào)用 BaseMapper 的 selectPage 方法,分頁查詢
default <E extends IPage<Map<String, Object>>> E pageMaps(E page, Wrapper<T> queryWrapper); // 調(diào)用 BaseMapper 的 selectMapsPage 方法澎粟,分頁查詢
注:
get 用于返回一條記錄蛀序。
list 用于返回多條記錄欢瞪。
count 用于返回記錄總數(shù)。
page 用于分頁查詢徐裸。
【鏈?zhǔn)秸{(diào)用:】
default QueryChainWrapper<T> query(); // 普通鏈?zhǔn)讲樵? default LambdaQueryChainWrapper<T> lambdaQuery(); // 支持 Lambda 表達(dá)式的修改
default UpdateChainWrapper<T> update(); // 普通鏈?zhǔn)叫薷? default LambdaUpdateChainWrapper<T> lambdaUpdate(); // 支持 Lambda 表達(dá)式的修改
注:
query 表示查詢
update 表示修改
Lambda 表示內(nèi)部支持 Lambda 寫法遣鼓。
形如:
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();
update().eq("column", value).remove();
lambdaUpdate().eq(Entity::getId, value).update(entity);
Wrapper常用條件
【通用條件:】
【比較大小: ( =, <>, >, >=, <, <= )】
eq(R column, Object val); // 等價于 =重贺,例: eq("name", "老王") ---> name = '老王'
ne(R column, Object val); // 等價于 <>骑祟,例: ne("name", "老王") ---> name <> '老王'
gt(R column, Object val); // 等價于 >,例: gt("name", "老王") ---> name > '老王'
ge(R column, Object val); // 等價于 >=气笙,例: ge("name", "老王") ---> name >= '老王'
lt(R column, Object val); // 等價于 <次企,例: lt("name", "老王") ---> name < '老王'
le(R column, Object val); // 等價于 <=,例: le("name", "老王") ---> name <= '老王'
【范圍:(between潜圃、not between缸棵、in、not in)】
between(R column, Object val1, Object val2); // 等價于 between a and b, 例: between("age", 18, 30) ---> age between 18 and 30
notBetween(R column, Object val1, Object val2); // 等價于 not between a and b, 例: notBetween("age", 18, 30) ---> age not between 18 and 30
in(R column, Object... values); // 等價于 字段 IN (v0, v1, ...),例: in("age",{1,2,3}) ---> age in (1,2,3)
notIn(R column, Object... values); // 等價于 字段 NOT IN (v0, v1, ...), 例: notIn("age",{1,2,3}) ---> age not in (1,2,3)
inSql(R column, Object... values); // 等價于 字段 IN (sql 語句), 例: inSql("id", "select id from table where id < 3") ---> id in (select id from table where id < 3)
notInSql(R column, Object... values); // 等價于 字段 NOT IN (sql 語句)
【模糊匹配:(like)】
like(R column, Object val); // 等價于 LIKE '%值%'谭期,例: like("name", "王") ---> name like '%王%'
notLike(R column, Object val); // 等價于 NOT LIKE '%值%'堵第,例: notLike("name", "王") ---> name not like '%王%'
likeLeft(R column, Object val); // 等價于 LIKE '%值',例: likeLeft("name", "王") ---> name like '%王'
likeRight(R column, Object val); // 等價于 LIKE '值%'隧出,例: likeRight("name", "王") ---> name like '王%'
【空值比較:(isNull踏志、isNotNull)】
isNull(R column); // 等價于 IS NULL,例: isNull("name") ---> name is null
isNotNull(R column); // 等價于 IS NOT NULL胀瞪,例: isNotNull("name") ---> name is not null
【分組针余、排序:(group、having赏廓、order)】
groupBy(R... columns); // 等價于 GROUP BY 字段, ...涵紊, 例: groupBy("id", "name") ---> group by id,name
orderByAsc(R... columns); // 等價于 ORDER BY 字段, ... ASC, 例: orderByAsc("id", "name") ---> order by id ASC,name ASC
orderByDesc(R... columns); // 等價于 ORDER BY 字段, ... DESC幔摸, 例: orderByDesc("id", "name") ---> order by id DESC,name DESC
having(String sqlHaving, Object... params); // 等價于 HAVING ( sql語句 )摸柄, 例: having("sum(age) > {0}", 11) ---> having sum(age) > 11
【拼接、嵌套 sql:(or既忆、and驱负、nested、apply)】
or(); // 等價于 a or b患雇, 例:eq("id",1).or().eq("name","老王") ---> id = 1 or name = '老王'
or(Consumer<Param> consumer); // 等價于 or(a or/and b)跃脊,or 嵌套。例: or(i -> i.eq("name", "李白").ne("status", "活著")) ---> or (name = '李白' and status <> '活著')
and(Consumer<Param> consumer); // 等價于 and(a or/and b)苛吱,and 嵌套酪术。例: and(i -> i.eq("name", "李白").ne("status", "活著")) ---> and (name = '李白' and status <> '活著')
nested(Consumer<Param> consumer); // 等價于 (a or/and b),普通嵌套。例: nested(i -> i.eq("name", "李白").ne("status", "活著")) ---> (name = '李白' and status <> '活著')
apply(String applySql, Object... params); // 拼接sql(若不使用 params 參數(shù)绘雁,可能存在 sql 注入)橡疼,例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08") ---> date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
last(String lastSql); // 無視優(yōu)化規(guī)則直接拼接到 sql 的最后,可能存若在 sql 注入庐舟。
exists(String existsSql); // 拼接 exists 語句欣除。例: exists("select id from table where age = 1") ---> exists (select id from table where age = 1)
【QueryWrapper 條件:】
select(String... sqlSelect); // 用于定義需要返回的字段。例: select("id", "name", "age") ---> select id, name, age
select(Predicate<TableFieldInfo> predicate); // Lambda 表達(dá)式挪略,過濾需要的字段历帚。
lambda(); // 返回一個 LambdaQueryWrapper
【UpdateWrapper 條件:】
set(String column, Object val); // 用于設(shè)置 set 字段值。例: set("name", null) ---> set name = null
etSql(String sql); // 用于設(shè)置 set 字段值杠娱。例: setSql("name = '老李頭'") ---> set name = '老李頭'
lambda(); // 返回一個 LambdaUpdateWrapper