MyBatis-Plus 技术文档

1. 项目简介

MyBatis-Plus 是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，简化开发、提高效率。它提供了高效的 CRUD 操作、代码生成器、条件构造器、分页插件等功能，能够显著减少开发工作量。

2. 安装指南

2.1 系统要求

• JDK 8+
• MyBatis 3.5+
• Spring Boot 2.x/3.x（可选）

2.2 Maven 安装方式

Spring Boot 2.x 项目

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

Spring Boot 3.x 项目

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
    <version>最新版本</version>
</dependency>

JDK 11+ 额外依赖（3.5.9+版本）

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-jsqlparser</artifactId>
    <version>最新版本</version>
</dependency>

JDK 8 额外依赖（3.5.9+版本）

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-jsqlparser-4.9</artifactId>
    <version>最新版本</version>
</dependency>

2.3 Gradle 安装方式

Spring Boot 2.x 项目

compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '最新版本'

Spring Boot 3.x 项目

compile group: 'com.baomidou', name: 'mybatis-plus-spring-boot3-starter', version: '最新版本'

3. 使用说明

3.1 基本配置

1. 创建 Mapper 接口并继承 BaseMapper：

public interface UserMapper extends BaseMapper<User> {
}

2. 在 Spring Boot 启动类上添加 @MapperScan 注解：

@SpringBootApplication
@MapperScan("com.example.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3.2 基础 CRUD 操作

查询操作

// 查询所有用户
List<User> users = userMapper.selectList(null);

// 条件查询
List<User> userList = userMapper.selectList(
    new QueryWrapper<User>()
        .lambda()
        .ge(User::getAge, 18)
);

插入操作

User user = new User();
user.setName("张三");
user.setAge(20);
userMapper.insert(user);

更新操作

User user = userMapper.selectById(1L);
user.setName("李四");
userMapper.updateById(user);

删除操作

// 根据ID删除
userMapper.deleteById(1L);

// 条件删除
userMapper.delete(
    new QueryWrapper<User>()
        .lambda()
        .eq(User::getName, "张三")
);

4. API 使用文档

4.1 条件构造器

MyBatis-Plus 提供了强大的条件构造器，支持链式调用和 Lambda 表达式：

// 基本条件构造
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "张三")
            .between("age", 18, 30)
            .isNotNull("email");

// Lambda 表达式方式
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.eq(User::getName, "张三")
                 .between(User::getAge, 18, 30)
                 .isNotNull(User::getEmail);

4.2 分页插件

1. 配置分页插件：

@Configuration
public class MybatisPlusConfig {
    
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

2. 使用分页查询：

Page<User> page = new Page<>(1, 10); // 当前页，每页大小
IPage<User> userPage = userMapper.selectPage(page, 
    new QueryWrapper<User>().eq("status", 1));
List<User> records = userPage.getRecords();
long total = userPage.getTotal();

4.3 代码生成器

MyBatis-Plus 提供了强大的代码生成器，可以快速生成 Entity、Mapper、Service、Controller 等代码：

FastAutoGenerator.create("jdbc:mysql://localhost:3306/db", "username", "password")
    .globalConfig(builder -> {
        builder.author("baomidou") // 设置作者
               .fileOverride() // 覆盖已生成文件
               .outputDir("D://"); // 指定输出目录
    })
    .packageConfig(builder -> {
        builder.parent("com.baomidou.mybatisplus.samples.generator") // 设置父包名
               .moduleName("system") // 设置父包模块名
               .pathInfo(Collections.singletonMap(OutputFile.xml, "D://")); // 设置mapperXml生成路径
    })
    .strategyConfig(builder -> {
        builder.addInclude("t_simple") // 设置需要生成的表名
               .addTablePrefix("t_", "c_"); // 设置过滤表前缀
    })
    .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
    .execute();

5. 高级特性

5.1 逻辑删除

1. 配置逻辑删除：

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted # 全局逻辑删除的实体字段名
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

2. 在实体类中添加逻辑删除字段：

@TableLogic
private Integer deleted;

5.2 自动填充

1. 实现 MetaObjectHandler 接口：

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
    }
    
    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }
}

2. 在实体类中添加自动填充字段：

@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;

5.3 乐观锁

1. 配置乐观锁插件：

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
    return interceptor;
}

2. 在实体类中添加版本字段：

@Version
private Integer version;

3. 使用乐观锁：

User user = userMapper.selectById(1L);
user.setName("新名字");
userMapper.updateById(user);