MyBatis-Link

# CRUD 接口

# Mgr CRUD 接口

说明:

  • 通用 Mgr CRUD 封装IMgr (opens new window)接口，进一步封装 CRUD 采用 get 查询单行 del 删除 list 查询集合 page 分页 前缀命名方式区分 Dao 层避免混淆，
  • 泛型 T 为任意实体对象
  • 泛型 D 为任意实体对象对应的实体Dto对象

# Add

// 插入一条记录（选择字段，策略插入）
T add(T entity);
// 插入（批量）
Collection<T> addBatch(Collection<T> entityList);
// 插入（批量）
Collection<T> addBatch(Collection<T> entityList, int batchSize);
// 插入（批量）MP提供的方法
boolean addBatchOrig(Collection<T> entityList)
// 插入（批量）MP提供的方法
boolean addBatchOrig(Collection<T> entityList, int batchSize);

返回对象说明：

新增后返回新增对象，适用场景分布式远程调用后返回新增对象。

# 参数说明
类型 参数名 描述
T entity 实体对象
Collection<T> entityList 实体对象集合
int batchSize 插入批次数量

# AddOrUpdate

// TableId 注解存在更新记录，否插入一条记录
T addOrUpdate(T entity);
// 批量修改插入
Collection<T> addOrUpdateBatch(Collection<T> entityList);
// 批量修改插入
Collection<T> addOrUpdateBatch(Collection<T> entityList, int batchSize);
// 批量修改插入
boolean addOrUpdateBatchOrig(Collection<T> entityList)
// 批量修改插入
boolean addOrUpdateBatchOrig(Collection<T> entityList, int batchSize);
# 参数说明
类型 参数名 描述
T entity 实体对象
Collection<T> entityList 实体对象集合
int batchSize 插入批次数量

# Delete

// 删除（根据ID 删除）
int deleteById(Serializable id);
// 删除（根据ID 批量删除）
int deleteByIds(Collection<? extends Serializable> idList);
// 删除（根据ID 批量删除）
int deleteByIds(Collection<? extends Serializable> idList, int batchSize);
// 删除（根据实体对象 批量删除）
int deleteBatchVoIds(Collection<T> entityList);
// 删除（根据实体对象 批量删除）
int deleteBatchVoIds(Collection<T> entityList, int batchSize);
// 删除（根据Dto实体对象 批量删除）
int deleteBatchDtoIds(Collection<D> entityList);
// 删除（根据Dto实体对象 批量删除）
int deleteBatchDtoIds(Collection<D> entityList, int batchSize);
// 删除（根据ID 删除树形结构数据）
void deleteTreeById(Serializable id, String pidColumn);
// 删除（根据ID 批量删除树形结构数据）
void deleteTreeByIds(Collection<? extends Serializable> idList, String pidColumn);
# 参数说明
类型 参数名 描述
Serializable id 主键ID
Collection<? extends Serializable> idList 主键ID列表
String pidColumn 父节点主键
T entity 实体对象
D entityDto 实体Dto对象

# 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);
// 根据ID 批量更新
boolean updateBatchByIdOrig(Collection<T> entityList);
// 根据ID 批量更新
boolean updateBatchByIdOrig(Collection<T> entityList, int batchSize);
# 参数说明
类型 参数名 描述
Wrapper<T> updateWrapper 实体对象封装操作类 UpdateWrapper
T entity 实体对象
Collection<T> entityList 实体对象集合
int batchSize 更新批次数量

# Get

// 根据 ID 查询
D getById(Serializable id);
// 根据 ID 查询
T getVoById(Serializable id);
// 根据 entity 条件，查询
D get(Wrapper<T> wrapper)
// 根据 entity 条件，查询
T getVo(Wrapper<T> wrapper)
// 根据 entity 条件，查询
D get(Wrapper<T> wrapper, boolean throwEx)
// 根据 entity 条件，查询
T getVo(Wrapper<T> wrapper, boolean throwEx)
// 根据 columnMap 条件，查询
D getByMap(Wrapper<T> wrapper)
// 根据 columnMap 条件，查询
T getVoByMap(Wrapper<T> wrapper)
// 根据字段条件，查询
D get(String colomns, Object... values);
// 根据字段条件，查询
T getVo(String colomns, Object... values);
# 参数说明
类型 参数名 描述
Serializable id 主键ID
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper
boolean throwEx 有多个 result 是否抛出异常
T entity 实体对象
D entityDto 实体Dto对象
String colomns 字段，多个字段逗号隔开
Object... values 字段对应的值

# List

// 查询所有
List<D> list();
// 查询所有
List<T> listVo();
// 查询列表
List<D> list(Wrapper<T> wrapper);
// 查询列表
List<T> listVo(Wrapper<T> wrapper);
// 查询（根据ID 批量查询）
List<D> listByIds(Collection<? extends Serializable> idList);
// 查询（根据ID 批量查询）
List<T> listVoByIds(Collection<? extends Serializable> idList);
// 查询（根据 columnMap 条件）
List<D> listByMap(Map<String, Object> columnMap);
// 查询（根据 columnMap 条件）
List<T> listVoByMap(Map<String, Object> columnMap);
// 根据字段条件，查询全部记录
List<D> list(String colomns, Object... values);
// 根据字段条件，查询全部记录
List<T> listVo(String colomns, Object... values);
// 根据 Wrapper 条件，查询全部记录
List<Map<String, Object>> listMaps(Wrapper<T> wrapper);
// 根据 columnMap 条件，查询全部记录
List<Map<String, Object>> listMapsByMap(Map<String, Object> columnMap);
// 根据 Wrapper 条件，查询全部记录
List<Object> listObjs(Wrapper<T> wrapper);
# 参数说明
类型 参数名 描述
Serializable id 主键ID
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper
T entity 实体对象
D entityDto 实体Dto对象
String colomns 字段，多个字段逗号隔开
Map<String, Object> columnMap 字段，多个字段逗号隔开
Object... values 字段对应的值

# Page

// 根据 entity 条件，查询全部记录（并翻页）
<E extends IPage<D>> E page(Wrapper<T> wrapper);
// 根据 entity 条件，查询全部记录（并翻页）
<E extends IPage<D>> E page(E page, Wrapper<T> wrapper);
// 根据 entity 条件，查询全部记录（并翻页）
<E extends IPage<T>> E pageVo(Wrapper<T> wrapper);
// 根据 entity 条件，查询全部记录（并翻页）
<E extends IPage<T>> E pageVo(IPage<D> page, Wrapper<T> wrapper);
// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage<Map<String, Object>> pageMaps(Wrapper<T> wrapper)
// 根据 Wrapper 条件，查询全部记录（并翻页）
<E extends IPage<Map<String, Object>>> E pageMaps(E page, Wrapper<T> wrapper)
# 参数说明
类型 参数名 描述
IPage<T> page 翻页对象
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper

# Count

// 根据 Wrapper 条件，查询总记录数
Integer count(Wrapper<T> wrapper);
# 参数说明
类型 参数名 描述
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper

# Dao CRUD 接口

说明:

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

# Insert

// 插入一条记录
int insert(T entity);
// 批量插入记录
int insertBatch(@Param(SoftConstants.COLL) Collection<T> coll);
# 参数说明
类型 参数名 描述
T entity 实体对象

# Delete

// 根据 ID 删除
int deleteById(Serializable id);
// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 删除（根据实体对象 批量删除）
int deleteBatchVoIds(Collection<T> voList);
// 删除（根据实体Dto对象 批量删除）
int deleteBatchDtoIds(Collection<D> dtoList);
# 参数说明
类型 参数名 描述
Collection<? extends Serializable> idList 主键ID列表(不能为 null 以及 empty)
Serializable id 主键ID
T entity 实体对象
D entityDto 实体Dto对象

# Update

// 根据 ID 修改全部的
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> wrapper);
// 根据 ID 批量修改有值的
int updateBatchById(@Param(SoftConstants.COLL) Collection<T> coll);
// 根据 ID 批量修改有值的
int updateBatchByDtoId(Collection<D> coll);
// 根据ID 修改所有值
int updateById(@Param(Constants.ENTITY) T entity);
// 根据 ID 批量修改所有值
int updateAllBatchById(@Param(SoftConstants.COLL) Collection<T> coll);
// 根据 ID 批量修改所有值
int updateAllBatchByDtoId(Collection<D> collection)
// 根据 ID 修改所有值
int updateAllById(@Param(Constants.ENTITY) T entity);
# 参数说明
类型 参数名 描述
T entity 实体对象
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper
Collection<T> entityList 实体对象集合

# Get

// 根据 ID 查询
D getById(Serializable id);
// 根据 ID 查询
T getVoById(Serializable id);
// 根据 entity 条件，查询
D get(Wrapper<T> wrapper)
// 根据 entity 条件，查询
T getVo(Wrapper<T> wrapper)
// 根据 columnMap 条件，查询
D getByMap(Wrapper<T> wrapper)
// 根据 columnMap 条件，查询
T getVoByMap(Wrapper<T> wrapper)
// 根据字段条件，查询
D get(String colomns, Object... values);
// 根据字段条件，查询
T getVo(String colomns, Object... values);
# 参数说明
类型 参数名 描述
Serializable id 主键ID
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper
T entity 实体对象
D entityDto 实体Dto对象
String colomns 字段，多个字段逗号隔开
Object... values 字段对应的值

# List

// 查询列表
List<D> list(Wrapper<T> wrapper);
// 查询列表
List<T> listVo(Wrapper<T> wrapper);
// 查询（根据ID 批量查询）
List<D> listBatchIds(Collection<? extends Serializable> idList);
// 查询（根据ID 批量查询）
List<T> listVoBatchIds(Collection<? extends Serializable> idList);
// 查询（根据 columnMap 条件）
List<D> listByMap(Map<String, Object> columnMap);
// 查询（根据 columnMap 条件）
List<T> listVoByMap(Map<String, Object> columnMap);
// 根据字段条件，查询全部记录
List<D> list(String colomns, Object... values);
// 根据字段条件，查询全部记录
List<T> listVo(String colomns, Object... values);
// 根据 Wrapper 条件，查询全部记录
List<Map<String, Object>> listMaps(Wrapper<T> wrapper);
// 根据 columnMap 条件，查询全部记录
List<Map<String, Object>> listMapsByMap(Map<String, Object> columnMap);
// 根据 Wrapper 条件，查询全部记录
List<Object> listObjs(Wrapper<T> wrapper);
# 参数说明
类型 参数名 描述
Serializable id 主键ID
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper
T entity 实体对象
D entityDto 实体Dto对象
String colomns 字段，多个字段逗号隔开
Map<String, Object> columnMap 字段，多个字段逗号隔开
Object... values 字段对应的值

# Page

// 根据 entity 条件，查询全部记录（并翻页）
<E extends IPage<D>> E page(E page, Wrapper<T> wrapper);
// 根据 entity 条件，查询全部记录（并翻页）
<E extends IPage<T>> E pageVo(IPage<D> page, Wrapper<T> wrapper);
// 根据 Wrapper 条件，查询全部记录（并翻页）
<E extends IPage<Map<String, Object>>> E pageMaps(E page, Wrapper<T> wrapper)
# 参数说明
类型 参数名 描述
IPage<T> page 翻页对象
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper

# Count

// 根据 Wrapper 条件，查询总记录数
Integer count(Wrapper<T> wrapper);
# 参数说明
类型 参数名 描述
Wrapper<T> wrapper 实体对象封装操作类 FindWrapper

← 条件构造器 →

赞助商