MyBatis-Plus：全网最全攻略，从入门到精通

原创于 2025-12-06 12:29:08 发布 · 556 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #java #maven #java-ee #spring boot #jvm #tomcat

JAVA 专栏收录该内容

12 篇文章

订阅专栏

引言

在当今快速发展的软件开发领域，数据访问层（Data Access Layer, DAL）的构建效率与性能优化已成为提升整体应用质量的关键。MyBatis 作为一款优秀的持久层框架，以其灵活性和强大的 SQL 映射能力赢得了广泛认可。然而，随着项目规模的扩大和复杂度的提升，传统 MyBatis 在某些场景下显得力不从心。此时，MyBatis-Plus 应运而生，它作为 MyBatis 的增强工具，在保持原有强大功能的基础上，通过一系列便捷的 API 和智能特性，极大地简化了开发流程，提升了开发效率。

MyBatis-Plus 的核心优势在于其“零配置、无侵入”的设计理念，这意味着开发者无需编写繁琐的 XML 映射文件，即可完成大部分数据库操作。同时，它提供了丰富的功能，如通用 CRUD 操作、分页插件、性能分析插件等，帮助开发者快速构建高效、稳定的数据访问层。本文将深入探讨 MyBatis-Plus 的各个方面，从基础概念到高级特性，从实战案例到性能优化，旨在为读者提供一份全面、深入的指南，助力开发者轻松驾驭这一强大工具，提升开发效率与代码质量。

一、MyBatis-Plus 基础入门

1.1 概念与核心优势

MyBatis-Plus 是一个基于 MyBatis 的增强工具，旨在简化开发流程，提升开发效率。它继承了 MyBatis 的所有特性，并在此基础上进行了扩展和优化。MyBatis-Plus 的核心优势在于其“零配置、无侵入”的设计理念，这意味着开发者无需编写繁琐的 XML 映射文件，即可完成大部分数据库操作。同时，MyBatis-Plus 提供了丰富的功能，如通用 CRUD 操作、分页插件、性能分析插件等，极大地简化了开发流程。

1.2 环境搭建与配置

1.2.1 依赖引入

在 Maven 项目中，只需在 pom.xml 文件中添加以下依赖，即可引入 MyBatis-Plus：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.4</version>
</dependency>

对于 Gradle 项目，则在 build.gradle 文件中添加：

implementation 'com.baomidou:mybatis-plus-boot-starter:3.5.4'

1.2.2 配置文件

在 application.yml 或 application.properties 文件中配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydatabase?useSSL=false&serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver

1.2.3 实体类与 Mapper 接口

创建一个简单的实体类 User：

@Data
@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

对应的 Mapper 接口 UserMapper：

public interface UserMapper extends BaseMapper<User> {
}

BaseMapper 是 MyBatis-Plus 提供的通用 Mapper，包含了常用的 CRUD 方法。

二、MyBatis-Plus 核心功能详解

2.1 通用 CRUD 操作

MyBatis-Plus 提供了丰富的通用 CRUD 方法，无需编写任何 XML 或 SQL 语句，即可完成数据库操作。

2.1.1 新增操作

@Autowired
private UserMapper userMapper;

public void addUser() {
    User user = new User();
    user.setName("John Doe");
    user.setAge(30);
    user.setEmail("john.doe@example.com");
    userMapper.insert(user);
}

2.1.2 查询操作

public List<User> getAllUsers() {
    return userMapper.selectList(null);
}

public User getUserById(Long id) {
    return userMapper.selectById(id);
}

public List<User> getUsersByAge(Integer age) {
    return userMapper.selectList(new QueryWrapper<User>().eq("age", age));
}

2.1.3 更新操作

public void updateUser(Long id, User user) {
    user.setId(id);
    userMapper.updateById(user);
}

public void updateUserName(Long id, String name) {
    userMapper.update(new UpdateWrapper<User>().eq("id", id).set("name", name));
}

2.1.4 删除操作

public void deleteUser(Long id) {
    userMapper.deleteById(id);
}

public void deleteUsersByAge(Integer age) {
    userMapper.delete(new QueryWrapper<User>().eq("age", age));
}

2.2 条件构造器

MyBatis-Plus 提供了强大的条件构造器 QueryWrapper，用于构建复杂的查询条件。

2.2.1 基本查询

public List<User> getUsersByConditions() {
    return userMapper.selectList(new QueryWrapper<User>()
        .eq("name", "John Doe")
        .gt("age", 25)
        .orderByDesc("age"));
}

2.2.2 多条件查询

public List<User> getUsersByMultipleConditions() {
    return userMapper.selectList(new QueryWrapper<User>()
        .and(qw -> qw.eq("name", "John Doe").or().eq("name", "Jane Doe"))
        .gt("age", 25)
        .orderByDesc("age"));
}

2.2.3 分页查询

public IPage<User> getUsersByPage(int current, int size) {
    return userMapper.selectPage(new Page<>(current, size), new QueryWrapper<User>());
}

2.3 分页插件

MyBatis-Plus 提供了分页插件，支持多种数据库的分页查询。

2.3.1 配置分页插件

在配置类中配置分页插件：

@Configuration
public class MybatisPlusConfig {
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

2.3.2 分页查询

public IPage<User> getUsersByPage(int current, int size) {
    return userMapper.selectPage(new Page<>(current, size), new QueryWrapper<User>());
}

2.4 性能分析插件

MyBatis-Plus 提供了性能分析插件，可以记录 SQL 执行时间，帮助开发者优化 SQL 语句。

2.4.1 配置性能分析插件

在配置类中配置性能分析插件：

@Configuration
public class MybatisPlusConfig {
    @Bean
    public SqlParser sqlParser() {
        return new SqlParser();
    }
}

2.4.2 使用性能分析插件

@Autowired
private SqlParser sqlParser;

public void testPerformance() {
    sqlParser.start();
    userMapper.selectList(null);
    sqlParser.stop();
}

三、MyBatis-Plus 高级特性

3.1 代码生成器

MyBatis-Plus 提供了代码生成器，可以自动生成实体类、Mapper 接口、XML 映射文件等。

3.1.1 配置代码生成器

创建代码生成器配置类：

public class CodeGenerator {
    public static void main(String[] args) {
        AutoGenerator autoGenerator = new AutoGenerator();
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir("D:/project/src/main/java");
        globalConfig.setFileOverride(true);
        autoGenerator.setGlobalConfig(globalConfig);

        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mydatabase");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("password");
        autoGenerator.setDataSource(dataSourceConfig);

        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("user");
        strategyConfig.setNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setEntityLombokModel(true);
        strategyConfig.setRestControllerStyle(true);
        strategyConfig.setSuperEntityColumns("id");
        strategyConfig.setIncludeAllColumns(true);
        strategyConfig.setSuperEntityClass("com.example.common.BaseEntity");
        autoGenerator.setStrategy(strategyConfig);

        autoGenerator.execute();
    }
}

3.1.2 生成代码

运行 CodeGenerator 类，即可自动生成实体类、Mapper 接口、XML 映射文件等。

3.2 逻辑删除

MyBatis-Plus 提供了逻辑删除功能，可以实现数据的软删除。

3.2.1 配置逻辑删除

在实体类中添加逻辑删除注解：

@Data
@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableLogic
    private Integer deleted;
}

在配置类中配置逻辑删除：

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusConfig mybatisPlusConfig() {
        MybatisPlusConfig config = new MybatisPlusConfig();
        config.setGlobalConfig(new GlobalConfig().setDbConfig(new DbConfig()
            .setLogicDeleteField("deleted")
            .setLogicDeleteValue(1)
            .setLogicNotDeleteValue(0)));
        return config;
    }
}

3.2.2 使用逻辑删除

public void deleteUser(Long id) {
    userMapper.deleteById(id);
}

3.3 多租户

MyBatis-Plus 提供了多租户功能，可以实现数据隔离。

3.3.1 配置多租户

在配置类中配置多租户：

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusConfig mybatisPlusConfig() {
        MybatisPlusConfig config = new MybatisPlusConfig();
        config.setGlobalConfig(new GlobalConfig().setDbConfig(new DbConfig()
            .setTenantIdField("tenant_id")
            .setTenantIdValue("1")));
        return config;
    }
}

3.3.2 使用多租户

public List<User> getUsersByTenantId(String tenantId) {
    return userMapper.selectList(new QueryWrapper<User>().eq("tenant_id", tenantId));
}

四、MyBatis-Plus 实战案例

4.1 用户管理系统

4.1.1 需求分析

创建一个简单的用户管理系统，实现用户的增删改查、分页查询、逻辑删除等功能。

4.1.2 代码实现

创建实体类 User：

@Data
@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableLogic
    private Integer deleted;
}

创建 Mapper 接口 UserMapper：

public interface UserMapper extends BaseMapper<User> {
}

创建 Service 接口 UserService：

public interface UserService {
    List<User> getAllUsers();
    User getUserById(Long id);
    void addUser(User user);
    void updateUser(Long id, User user);
    void deleteUser(Long id);
    IPage<User> getUsersByPage(int current, int size);
}

创建 Service 实现类 UserServiceImpl：

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;

    @Override
    public List<User> getAllUsers() {
        return userMapper.selectList(null);
    }

    @Override
    public User getUserById(Long id) {
        return userMapper.selectById(id);
    }

    @Override
    public void addUser(User user) {
        userMapper.insert(user);
    }

    @Override
    public void updateUser(Long id, User user) {
        user.setId(id);
        userMapper.updateById(user);
    }

    @Override
    public void deleteUser(Long id) {
        userMapper.deleteById(id);
    }

    @Override
    public IPage<User> getUsersByPage(int current, int size) {
        return userMapper.selectPage(new Page<>(current, size), new QueryWrapper<User>());
    }
}

创建 Controller 类 UserController：

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getUserById(id);
    }

    @PostMapping
    public void addUser(@RequestBody User user) {
        userService.addUser(user);
    }

    @PutMapping("/{id}")
    public void updateUser(@PathVariable Long id, @RequestBody User user) {
        userService.updateUser(id, user);
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        userService.deleteUser(id);
    }

    @GetMapping("/page")
    public IPage<User> getUsersByPage(@RequestParam(defaultValue = "1") int current,
                                     @RequestParam(defaultValue = "10") int size) {
        return userService.getUsersByPage(current, size);
    }
}

五、MyBatis-Plus 性能优化

5.1 SQL 优化

5.1.1 避免 N+1 查询问题

使用 @One 注解进行关联查询：

@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableField(exist = false)
    private List<Order> orders;
}

@TableName("order")
public class Order {
    @TableId(type = IdType.AUTO)
    private Long id;
    private Long userId;
    private String orderNo;
    private BigDecimal amount;
}

@Mapper
public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT o.* FROM user u LEFT JOIN order o ON u.id = o.user_id WHERE u.id = #{id}")
    List<Order> selectOrdersByUserId(Long userId);
}

5.1.2 使用批量操作

使用 insertBatch 方法进行批量插入：

public void addUsers(List<User> users) {
    userMapper.insertBatch(users);
}

5.2 缓存优化

5.2.1 一级缓存

MyBatis 默认开启一级缓存，无需额外配置。

5.2.2 二级缓存

在 Mapper 接口上添加 @CacheNamespace 注解：

@Mapper
@CacheNamespace
public interface UserMapper extends BaseMapper<User> {
}

5.3 连接池优化

使用 HikariCP 作为连接池：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydatabase
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      minimum-idle: 5
      maximum-pool-size: 15
      idle-timeout: 60000
      max-lifetime: 1800000
      connection-timeout: 30000

六、MyBatis-Plus 常见问题与解决方案

6.1 SQL 注入问题

6.1.1 问题描述

使用 QueryWrapper 时，如果直接拼接字符串，可能导致 SQL 注入。

6.1.2 解决方案

使用 LambdaQueryWrapper 避免 SQL 注入：

public List<User> getUsersByConditions() {
    return userMapper.selectList(new LambdaQueryWrapper<User>()
        .eq(User::getName, "John Doe")
        .gt(User::getAge, 25)
        .orderByDesc(User::getAge));
}

6.2 分页插件不生效

6.2.1 问题描述

分页插件未正确配置，导致分页查询不生效。

6.2.2 解决方案

确保在配置类中正确配置分页插件：

@Configuration
public class MybatisPlusConfig {
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

6.3 逻辑删除不生效

6.3.1 问题描述

逻辑删除未正确配置，导致删除操作未生效。

6.3.2 解决方案

确保在实体类中添加 @TableLogic 注解，并在配置类中配置逻辑删除：

@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableLogic
    private Integer deleted;
}

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusConfig mybatisPlusConfig() {
        MybatisPlusConfig config = new MybatisPlusConfig();
        config.setGlobalConfig(new GlobalConfig().setDbConfig(new DbConfig()
            .setLogicDeleteField("deleted")
            .setLogicDeleteValue(1)
            .setLogicNotDeleteValue(0)));
        return config;
    }
}