【MybatisPlus】BaseMapper详解，举例说明

news2024/10/6 14:28:29

一、BaseMapper 简介

MyBatis-Plus 的核心类 BaseMapper 主要是用于提供基本的 CRUD（创建、读取、更新、删除）操作的接口定义。它是 MyBatis-Plus 框架中的一个重要组成部分，可以大大简化基于 MyBatis 的数据访问层代码的编写。

BaseMapper 接口通常定义了一些基本的数据库操作方法，例如：

insert：插入一条记录到数据库中。
deleteById：根据主键 ID 删除一条记录。
updateById：根据主键 ID 更新一条记录。
selectById：根据主键 ID 查询一条记录。
selectList：查询所有符合条件的记录列表。
selectPage：分页查询记录。

等等…
除了这些基本的 CRUD 方法外，BaseMapper 还可能包含一些其他便捷的查询方法，如按条件查询、统计符合条件的记录数等。这些方法可以通过 MyBatis-Plus 框架自动生成实现，无需手动编写对应的 SQL 语句。

通过使用 BaseMapper，开发人员可以避免编写重复的 CRUD 操作代码，提高开发效率，同时也能够确保代码的一致性和可维护性。

二、原理

BaseMapper 类是 MyBatis-Plus 框架中的一个核心接口，用于提供基本的 CRUD（创建、读取、更新、删除）操作的方法定义。它通过继承 MyBatis 的 Mapper 接口并扩展了一些常用的数据库操作方法，使得开发人员可以更加便捷地进行数据访问层的开发，无需手动编写对应的 SQL 语句。

BaseMapper 接口的原理主要基于 MyBatis 的 Mapper 动态代理机制。在运行时，MyBatis-Plus 会动态生成 BaseMapper 接口的实现类，并通过 Java 反射机制来调用相应的数据库操作方法。这些方法在实现时会自动生成对应的 SQL 语句，并利用 MyBatis 的 SQL 执行引擎来执行这些 SQL 语句，从而实现对数据库的 CRUD 操作。
在这里插入图片描述

三、BaseMapper 应用

假设有一个名为 User 的实体类，对应数据库中的用户表，其字段包括 id、username 和 password。我们可以创建一个对应的 UserMapper 接口，继承自 BaseMapper 接口，从而获得基本的 CRUD 方法的实现。

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
    // 这里不需要编写任何方法，继承了 BaseMapper 接口后，已经包含了常用的数据库操作方法
}

然后，我们可以在服务层或控制器层中注入 UserMapper，并调用其方法来实现数据库操作，例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    // 添加用户
    public void addUser(User user) {
        userMapper.insert(user);
    }

    // 根据用户ID查询用户信息
    public User getUserById(Long userId) {
        return userMapper.selectById(userId);
    }

    // 更新用户信息
    public void updateUser(User user) {
        userMapper.updateById(user);
    }

    // 删除用户
    public void deleteUser(Long userId) {
        userMapper.deleteById(userId);
    }
}

在上面的示例中，我们通过注入 UserMapper 接口的实例 userMapper，并调用其继承自 BaseMapper 的 insert、selectById、updateById 和 deleteById 方法来实现对用户表的增、查、改、删操作。

通过这种方式，我们可以非常方便地进行数据库操作，而不需要编写繁琐的 SQL 语句，同时也提高了代码的可读性和可维护性。

四、BaseMapper 进阶操作

除了基本的 CRUD 操作之外，BaseMapper 还提供了一些进阶操作，可以更灵活地满足实际开发中的需求。以下是一些常见的进阶操作：

自定义 SQL 方法：

BaseMapper 接口支持在子接口中定义自定义的 SQL 方法，可以通过注解或 XML 文件来编写自定义的 SQL 语句，并在方法上使用@Select、@Update、@Insert、@Delete 等注解来指定对应的 SQL 类型。
条件构造器：

MyBatis-Plus 提供了强大的条件构造器（QueryWrapper、UpdateWrappe、LambdaQueryWrapper、LambdaUpdateWrapper 等），可以帮助开发人员构建复杂的查询条件。BaseMapper 的查询方法通常接受一个条件构造器作为参数，从而支持根据条件查询符合条件的记录。详情参考【MybatisPlus】QueryWrapper、UpdateWrappe、LambdaQueryWrapper、LambdaUpdateWrapper
分页查询：

BaseMapper 提供了分页查询的方法，例如 selectPage 方法，可以指定查询的页码和每页的记录数，并返回一个分页对象（Page 对象），其中包含了查询结果的分页信息。
批量操作：

BaseMapper 支持批量插入、更新和删除操作，可以提高数据处理的效率。例如，批量插入可以通过 insertBatch 方法实现，批量更新可以通过 updateBatchById 方法实现，批量删除可以通过deleteBatchIds 方法实现。
逻辑删除：

MyBatis-Plus 支持逻辑删除功能，可以通过在实体类的字段上添加 @TableLogic 注解来指定逻辑删除的字段，并在全局配置中启用逻辑删除功能。BaseMapper 支持根据条件进行逻辑删除操作，例如，selectPage 方法可以通过指定查询条件来查询被逻辑删除的记录。
乐观锁：

MyBatis-Plus 支持乐观锁功能，可以通过在实体类的字段上添加 @Version 注解来指定乐观锁的字段，并在全局配置中启用乐观锁功能。BaseMapper 提供了根据乐观锁字段进行更新操作的方法，例如，updateById 方法可以通过乐观锁字段来实现乐观锁更新。