mybatisplus接口解析

以你之姓@ 2024-02-24 01:14 70阅读 0赞

#### 一、前言 ####

java开发应用程序与数据库交互使用比较多的就是mybatisplus接口。通过mybatisplus接口，我们可以通过程序更好得到对数据库表进行增删查改。

#### 二、mybatisplus Mapper接口源码 ####

/**
 * Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能
 * 这个 Mapper 支持 id 泛型
 *
 * @author hubin
 * @since 2016-01-23
 */
 public interface BaseMapper<T> extends Mapper<T> {
 
 /**
 * 插入一条记录
 *
 * @param entity 实体对象
 */
 int insert(T entity);
 
 /**
 * 根据 ID 删除
 *
 * @param id 主键ID
 */
 int deleteById(Serializable id);
 
 /**
 * 根据实体(ID)删除
 *
 * @param entity 实体对象
 * @since 3.4.4
 */
 int deleteById(T entity);
 
 /**
 * 根据 columnMap 条件，删除记录
 *
 * @param columnMap 表字段 map 对象
 */
 int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
 
 /**
 * 根据 entity 条件，删除记录
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
 */
 int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 
 /**
 * 删除（根据ID 批量删除）
 *
 * @param idList 主键ID列表(不能为 null 以及 empty)
 */
 int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
 
 /**
 * 根据 ID 修改
 *
 * @param entity 实体对象
 */
 int updateById(@Param(Constants.ENTITY) T entity);
 
 /**
 * 根据 whereEntity 条件，更新记录
 *
 * @param entity 实体对象 (set 条件值,可以为 null)
 * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
 */
 int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
 
 /**
 * 根据 ID 查询
 *
 * @param id 主键ID
 */
 T selectById(Serializable id);
 
 /**
 * 查询（根据ID 批量查询）
 *
 * @param idList 主键ID列表(不能为 null 以及 empty)
 */
 List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
 
 /**
 * 查询（根据 columnMap 条件）
 *
 * @param columnMap 表字段 map 对象
 */
 List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
 
 /**
 * 根据 entity 条件，查询一条记录
 * 查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意：多条数据会报异常
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 */
 default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
 List<T> ts = this.selectList(queryWrapper);
 if (CollectionUtils.isNotEmpty(ts)) {
 if (ts.size() != 1) {
 throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records");
 }
 return ts.get(0);
 }
 return null;
 }
 
 /**
 * 根据 Wrapper 条件，查询总记录数
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 */
 Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 
 /**
 * 根据 entity 条件，查询全部记录
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 */
 List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 
 /**
 * 根据 Wrapper 条件，查询全部记录
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 */
 List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 
 /**
 * 根据 Wrapper 条件，查询全部记录
 * 注意： 只返回第一个字段的值
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 */
 List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 
 /**
 * 根据 entity 条件，查询全部记录（并翻页）
 *
 * @param page 分页查询条件（可以为 RowBounds.DEFAULT）
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 */
 > P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 
 /**
 * 根据 Wrapper 条件，查询全部记录（并翻页）
 *
 * @param page 分页查询条件
 * @param queryWrapper 实体对象封装操作类
 */
 >> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 }

mybatisplus Mapper 由苞米豆公司开发。

现在对源码进行解析

public interface BaseMapper<T> extends Mapper<T>

BaseMapper 首先这是一个泛型接口，并且这个BaseMapper 继承了 Mapper接口。Mapper也是一个泛型接口。

![92b1701804e8481fa7c07054ca896d47.png][]

1、泛型接口

定义泛型接口与定义普通接口类似，只需要在接口的名称后面加上`<T>`或其他泛型参数即可。其中`<T>`表示这是一个泛型参数，可以在实现接口的时候指定具体的类型。

使用泛型接口时，可以指定具体的类型作为泛型参数，也可以使用通配符`?`表示任意类型。

2、在BaseMapper<T>接口中定义了如下方法：

/\*\*  
\* 插入一条记录  
\*  
\* @param entity 实体对象  
\*/  
int insert(T entity);

/\*\*  
\* 根据 ID 删除  
\*  
\* @param id 主键ID  
\*/  
int deleteById(Serializable id);

/\*\*  
\* 根据实体(ID)删除  
\*  
\* @param entity 实体对象  
\* @since 3.4.4  
\*/  
int deleteById(T entity);

/\*\* 
\* 根据 columnMap 条件，删除记录 
\* 
\* @param columnMap 表字段 map 对象 
\*/ 
int deleteByMap(@Param(Constants.COLUMN\_MAP) Map<String, Object> columnMap);

/\*\* 
\* 根据 entity 条件，删除记录 
\* 
\* @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句） 
\*/ 
int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/\*\* 
\* 删除（根据ID 批量删除） 
\* 
\* @param idList 主键ID列表(不能为 null 以及 empty) 
\*/ 
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

/\*\*  
\* 根据 ID 修改  
\*  
\* @param entity 实体对象  
\*/  
int updateById(@Param(Constants.ENTITY) T entity);

/\*\* 
\* 根据 whereEntity 条件，更新记录 
\* 
\* @param entity 实体对象 (set 条件值,可以为 null) 
\* @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句） 
\*/ 
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

/\*\*  
\* 根据 ID 查询  
\*  
\* @param id 主键ID  
\*/  
T selectById(Serializable id);

/\*\* 
\* 查询（根据ID 批量查询） 
\* 
\* @param idList 主键ID列表(不能为 null 以及 empty) 
\*/ 
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

/\*\* 
\* 查询（根据 columnMap 条件） 
\* 
\* @param columnMap 表字段 map 对象 
\*/ 
List<T> selectByMap(@Param(Constants.COLUMN\_MAP) Map<String, Object> columnMap);

/\*\* 
\* 根据 entity 条件，查询一条记录 
\* 查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意：多条数据会报异常 
\* 
\* @param queryWrapper 实体对象封装操作类（可以为 null） 
\*/ 
default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) \{ 
List<T> ts = this.selectList(queryWrapper); 
if (CollectionUtils.isNotEmpty(ts)) \{ 
if (ts.size() != 1) \{ 
throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records"); 
\} 
return ts.get(0); 
\} 
return null; 
\}

/\*\* 
\* 根据 Wrapper 条件，查询总记录数 
\* 
\* @param queryWrapper 实体对象封装操作类（可以为 null） 
\*/ 
Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/\*\* 
\* 根据 entity 条件，查询全部记录 
\* 
\* @param queryWrapper 实体对象封装操作类（可以为 null） 
\*/ 
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/\*\* 
\* 根据 Wrapper 条件，查询全部记录 
\* 
\* @param queryWrapper 实体对象封装操作类（可以为 null） 
\*/ 
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/\*\* 
\* 根据 Wrapper 条件，查询全部记录 
\* 注意： 只返回第一个字段的值 
\* 
\* @param queryWrapper 实体对象封装操作类（可以为 null） 
\*/ 
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/\*\* 
\* 根据 entity 条件，查询全部记录（并翻页） 
\* 
\* @param page 分页查询条件（可以为 RowBounds.DEFAULT） 
\* @param queryWrapper 实体对象封装操作类（可以为 null） 
\*/ 
> P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/\*\* 
\* 根据 Wrapper 条件，查询全部记录（并翻页） 
\* 
\* @param page 分页查询条件 
\* @param queryWrapper 实体对象封装操作类 
\*/ 
>> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

#### 三、接口应用 ####

通过源码我们只看到了接口的定义，却看不到接口的是如何连接到数据库和接口的实现。

我们再代码中的引用只需要定义一个接口继承BaseMapper<T> 接口

如：

@Repository
 public interface MCouponsMapper extends BaseMapper<MCoupons>{
 
 }

<>符中传入具体的类型

皆可以通过实际的接口MCouponsMapper来调用BaseMapper<T>定义的所以方法。

[92b1701804e8481fa7c07054ca896d47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/24/6697833595e447939e8ee5f251c84bcb.png