MybatisPlus 的入门与实践：BaseMapper 实现 CRUD

MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集，可以使用简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通的 Java 对象）为数据库中的记录。

下面我们将详细探讨 MyBatis 的基本功能。

BaseMapper

MyBatis-Plus 中的基本 CRUD 在内置的 BaseMapper 中都已得到了实现，因此我们的 Mapper 继承该接口，同时指定泛型类型为对应的实体类，之后就可以直接使用。

BaseMapper 是 MyBatis-Plus 提供的一个核心接口，它定义了一系列基础的 CRUD（Create, Read, Update, Delete） 操作方法，旨在简化基于 MyBatis 的数据访问层代码的编写，提高开发效率。

public interface UserMapper extends BaseMapper<T>{
	// 在这里可以定义自己的方法
}

• 调用方法：通过调用 UserMapper 接口中的方法，可以直接执行数据库操作，而无需手动编写 SQL 语句或 XML 映射文件。

• 泛型 T 为任意实体对象，Mybatis Plus 通过扫描实体类，并基于反射获取实体类信息作为数据库表信息

• 类名驼峰转下划线作为表名

• 名为 id 的字段作为主键

• 变量名驼峰转下划线作为表的字段名

BaseMapper 中提供的 CRUD 方法

• 通用 CRUD 封装 BaseMapper 接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器

• 参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键

• 对象 Wrapper 为条件构造器

@Param

@Param 是 Mybatisplus 提供的注解之一，用于给 SQL 语句中的参数命名，以便在 XML 映射文件中使用这些命名参数，解决 Mybatisplus 在处理多个参数时无法识别参数名的问题。

使用 @Param 注解可以解决 Mybatisplus 在处理多个参数时无法识别参数名的问题。通过为参数添加 @Param 注解，可以在 SQL 语句中使用指定的参数名进行引用。

新增：insert

MyBatis 提供了方便的插入方法，允许我们插入单条记录到数据库中。

// 插入一条记录
int insert(T entity);

调用此方法时，需要传入一个与数据库表结构相对应的 Java 对象（Entity），MyBatis 会根据对象的属性自动生成 INSERT 语句，并将属性值填充到 SQL 语句中。

删除：delete

MyBatis 提供了多种删除方法，包括根据条件删除、根据 ID 删除等。

// 根据 wrapper 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);

// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

// 根据 ID 删除
int deleteById(Serializable id);

// 根据 columnMap 条件，删除记录
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

修改：update

• update 方法：根据条件更新记录
• updateById 方法：根据 ID 更新记录

示例代码与解释：

// 根据 whereWrapper 条件，更新记录
int update(@Param(Constants.ENTITY) T updateEntity,
@Param(Constants.WRAPPER) Wrapper<T> whereWrapper);

// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

查询：selete

• selectById：根据 ID 查询
• selectOne：根据条件查询一条记录
• selectBatchIds：根据 ID 列表批量查询
• selectList：根据条件查询全部记录
• selectByMap：根据 Map 条件查询
• selectMaps：查询全部记录并返回 Map 列表
• selectObjs：查询全部记录并只返回第一个字段的值
• selectPage 和 selectMapsPage：分页查询

示例代码与解释：

// 根据 ID 查询
T selectById(Serializable id);

// 根据 entity 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 查询（根据ID 批量查询）
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

// 根据 Wrapper 条件，查询全部记录
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 查询（根据 columnMap 条件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

// 根据 Wrapper 条件，查询全部记录
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 entity 条件，查询全部记录（并翻页）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 Wrapper 条件，查询总记录数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

示例

当使用 MyBatis-Plus 的 BaseMapper 时，以下是一些示例来展示其功能和用法。我们将按照不同的操作类型进行分点表示和归纳。

创建实体类

public Class User{
	private String userId;
	private String name;
	private Integer age;
	private Integer gender;
}

继承 BaseMapper

public interface UserMapper extends BaseMapper<User>{
	// 在这里可以定义自己的方法
}

插入操作

• insert(T entity): 插入一条记录到数据库中。

// 假设 User 是一个实体类
User user = new User();
user.setName("John Doe");
user.setAge(30);
// ... 设置其他属性

// 注入 UserMapper
@Autowired
private UserMapper userMapper;

// 调用 insert 方法插入用户
int result = userMapper.insert(user);
if (result > 0) {
    // 插入成功
} else {
    // 插入失败
}

删除操作

• deleteById(Serializable id): 根据主键 ID 删除一条记录。

// 假设要删除的用户 ID 为 1
Long userId = 1L;

// 调用 deleteById 方法删除用户
int result = userMapper.deleteById(userId);
if (result > 0) {
    // 删除成功
} else {
    // 删除失败或用户不存在
}

更新操作

• updateById(T entity): 根据主键 ID 更新一条记录。

// 假设要更新的用户 ID 为 1
User userToUpdate = new User();
userToUpdate.setId(1L);
userToUpdate.setName("Jane Doe"); // 更新名字
// ... 更新其他属性

// 调用 updateById 方法更新用户
int result = userMapper.updateById(userToUpdate);
if (result > 0) {
    // 更新成功
} else {
    // 更新失败或用户不存在
}

查询操作

• selectById(Serializable id): 根据主键 ID 查询一条记录。

// 假设要查询的用户 ID 为 1
Long userId = 1L;

// 调用 selectById 方法查询用户
User user = userMapper.selectById(userId);
if (user != null) {
    // 查询成功，处理用户数据
} else {
    // 查询失败或用户不存在
}

• selectList(Wrapper queryWrapper): 查询所有符合条件的记录列表。

// 构造查询条件
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "John Doe"); // 查询名字为 John Doe 的用户

// 调用 selectList 方法查询用户列表
List<User> userList = userMapper.selectList(queryWrapper);
if (!userList.isEmpty()) {
    // 查询成功，处理用户列表
} else {
    // 查询结果为空
}

• selectPage(IPage page, Wrapper queryWrapper): 分页查询记录。

// 构造分页信息和查询条件
Page<User> page = new Page<>(1, 10); // 第一页，每页10条记录
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.like("name", "Doe"); // 查询名字包含 Doe 的用户

// 调用 selectPage 方法分页查询用户
IPage<User> userPage = userMapper.selectPage(page, queryWrapper);
if (userPage.getRecords().size() > 0) {
    // 分页查询成功，处理用户分页数据
} else {
    // 分页查询结果为空
}

以上示例清晰地展示了 MyBatis-Plus 中 BaseMapper 的基本用法，包括插入、删除、更新和查询操作。在实际开发中，可以根据需要选择合适的方法，并结合条件构造器（如 QueryWrapper）来实现更复杂的数据库操作。

总结

BaseMapper 的原理主要基于 MyBatis 的 Mapper 动态代理机制。在运行时，MyBatis-Plus 会动态生成 BaseMapper 接口的实现类，并通过 Java 反射机制来调用相应的数据库操作方法。

综上所述，BaseMapper 作为 MyBatis-Plus 的核心概念之一，通过提供一套基础的 CRUD 操作方法，大大简化了基于 MyBatis 的数据访问层代码的编写，提高了开发效率。