MybatisPlus

MyBatis-Plus 是 MyBatis 的增强工具,在 MyBatis 的基础上只做增强、不做改变,为简化开发、提高效率而生。

其核心思想是“无侵入式增强”:引入它不会对现有工程产生任何影响,却能以面向对象的方式直接完成单表大部分 CRUD 操作。

传统 MyBatis 开发需要编写大量 pojo、dao、mapper.xml 等配置文件才能跑通 CRUD,而 MyBatis-Plus 通过内置通用 Mapper、通用 Service 与条件构造器,让开发者几乎零配置即可上手。
MyBatis-Plus 3.5.1

1. 概述

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑;启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作。

定位 MyBatis-Plus 不是对 MyBatis 的替换,而是对其能力的增强:保留 MyBatis 原有写法,同时提供开箱即用的通用 CRUD、条件构造器、代码生成器、分页与逻辑删除等能力。

其主要特性如下:

特性 说明
无侵入 只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小 启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
强大的 CRUD 操作 内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
支持 Lambda 形式调用 通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
支持主键自动生成 支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
支持 ActiveRecord 模式 支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
支持自定义全局通用操作 支持全局通用方法注入( Write once, use anywhere )
内置代码生成器 采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
内置分页插件 基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
分页插件支持多种数据库 支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
内置性能分析插件 可输出 SQL 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
内置全局拦截插件 提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作

2. 快速入门

2.1 添加依赖

使用 Spring Boot 父工程与 mybatis-plus-boot-starter 起步依赖:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.5</version>
    <relativePath/>
</parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.1</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

2.2 配置数据库连接

在 application.yml 中配置数据源:

spring:
  datasource:
    username: root
    password: password
    url: jdbc:mysql:///mybatis_plus?userUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver

2.3 启动类添加 @MapperScan 注解

在 Spring Boot 启动类上使用 @MapperScan 扫描 Mapper 文件夹:

注意 一定要用 @MapperScan,不要使用 @ComponentScan 来扫描 Mapper。
@SpringBootApplication
@MapperScan("com.wen.mybatis_plus.mapper")  //扫描mapper
public class MybatisPlusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }
}

2.4 配置实体类

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

2.5 编写 Mapper 接口

在 Mapper 包下定义 UserMapper 接口,继承 BaseMapper 即可获得通用 CRUD 能力:

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.wen.mybatis_plus.pojo.User;
import org.apache.ibatis.annotations.Mapper;

//再对应的mapper上面实现基本的接口 BaseMapper
@Mapper
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD都已经完成
    //不需要像以前一样配置一大堆文件:pojo-dao(连接mybatis,配置mapper.xml文件)==>service-controller
}

2.6 测试

@SpringBootTest
class MybatisPlusApplicationTests {

    //继承了BaseMapper所有的方法,可以编写自己的扩展方法
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect(){
        System.out.println("--------selectAll method test-------");
        //查询全部用户,参数是一个Wrapper,条件构造器,先不使用为null
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }

3. IService 通用 Service

除了 BaseMapper,MyBatis-Plus 还提供通用 Service 层:IService 接口与 ServiceImpl 实现类,进一步简化业务逻辑编写。

3.1 继承 IService 接口

#Userservice.java
package com.richu.iorichu1.Service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.richu.iorichu1.domain.po.User;

public interface Userservice extends IService<User>{
}

3.2 实现类

package com.richu.iorichu1.Service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.richu.iorichu1.Mapper.UserMapper;
import com.richu.iorichu1.Service.Userservice;
import com.richu.iorichu1.domain.po.User;
import org.springframework.stereotype.Service;

@Service
public class Userserviceimpl extends ServiceImpl<UserMapper, User> implements Userservice{

}

3.3 测试

@Autowired
private Userservice userservice;

@Test
public void testsaveUser(){
    User user = new User();
    user.setId(7L);
    user.setUsername("李磊");
    user.setPassword("123");
    user.setPhone("18688990011");
    user.setBalance(200);
    user.setInfo("{\"age\": 24, \"intro\": \"数学老师\", \"gender\": \"female\"}");
    user.setCreateTime(LocalDateTime.now());
    user.setUpdateTime(LocalDateTime.now());
    userservice.save(user);
}

4. 自定义 SQL

当通用方法无法满足复杂业务时,可基于 Wrapper 自定义 SQL,通过 ${ew.customSqlSegment} 拼接条件构造器生成的条件。

4.1 测试类

@Test
public void CustomTest() {
    List<Long> ids = List.of(1L, 2L, 3L, 4L);
    int amount=200;
    QueryWrapper<User> queryWrapper = new QueryWrapper<User>().in("id",ids);
    userMapper.updateblance(queryWrapper,amount);
}

4.2 Mapper 接口

@Mapper
public interface UserMapper extends BaseMapper<User> {
    void updateblance(@Param("ew") QueryWrapper<User> queryWrapper,@Param("amount") int amount);
}

4.3 XML 映射

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.richu.iorichu1.Mapper.UserMapper">

    <update id="updateblance">
        update user set balance = balance- #{amount} ${ew.customSqlSegment}
    </update>
</mapper>

5. DB 静态工具

MyBatis-Plus 提供 Db 静态工具类,可在不注入 Mapper/Service 的情况下直接进行链式查询:

//静态DB
        List<Address> addresses=Db.lambdaQuery(Address.class)
                .eq(Address::getUserId,user.getId()).list();

6. 逻辑删除支持

逻辑删除通过标记字段而非物理删除来保留数据,适用于需要审计或恢复的场景。

6.1 配置全局逻辑删除属性

在 application.yml 中配置 MyBatis-Plus 的全局逻辑删除属性:

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted # 全局逻辑删除字段名
      logic-delete-value: 1 # 逻辑已删除值
      logic-not-delete-value: 0 # 逻辑未删除值

6.2 在实体类中使用 @TableLogic 注解

在实体类中,对应数据库表的逻辑删除字段上添加 @TableLogic 注解:

import com.baomidou.mybatisplus.annotation.TableLogic;

public class User {
    // 其他字段...

    @TableLogic
    private Integer deleted;
}

7. 枚举处理器

枚举处理器负责 Java 枚举类型与数据库字段值之间的映射转换。

7.1 方式一:注解标记

枚举属性使用 @EnumValue 注解,指定枚举值在数据库中存储的实际值。支持枚举类中的任意字段,如序号或编码。

@Getter
@AllArgsConstructor
public enum GradeEnum {
    PRIMARY(1, "小学"),
    SECONDARY(2, "中学"),
    HIGH(3, "高中");

    @EnumValue // 标记数据库存的值是code
    private final int code;
    // 其他属性...
}

7.2 方式二:配置全局枚举类型处理器

mybatis-plus:
  configuration:
    default-enum-type-handler: xx.xx.xx.MyEnumTypeHandler

8. JSON 处理器

通过 JacksonTypeHandler 可让实体类中的对象字段(如 UserInfo)与数据库 JSON 字段自动互转,需配合 autoResultMap = true 使用。

@Data
@TableName(value = "user",autoResultMap = true)
public class UserVo {

    private Long id;

    private String username;
    
    @TableField(typeHandler = JacksonTypeHandler.class)
    private UserInfo info;
    
    private Integer status;

    private String balance;

    public List<AddressVo> addresses;
}

9. 配置分页插件

MyBatis-Plus 提供基于物理分页的 PaginationInnerInterceptor,配置后分页查询与普通 List 查询写法一致。

9.1 分页插件配置

package com.richu.iorichu1.Config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();

        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
        paginationInnerInterceptor.setMaxLimit(1000L);

        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }
}

9.2 复杂业务分页实现

@Override
public PageDto<UserVo> pagelist(UserQuery query) {
    String name = query.getName();
    Integer status = query.getStatus();
    //配置分页条件
    Page<User> page = Page.of(query.getPageNo(),query.getPageSize());
    //判断是否传入排序字段
    if (StrUtil.isNotBlank(query.getSortBy())){
        page.addOrder(new OrderItem(query.getSortBy(),query.getIsAsc()));
    }else{
        page.addOrder(new OrderItem("update_time",false));
    }
    //查询
    Page<User> pagelist = lambdaQuery().like(name != null,User::getUsername,name)
            .eq(status != null,User::getStatus,status)
            .page(page);
    //封装结果
    PageDto<UserVo> dto = new PageDto<>();
    dto.setPage((int) pagelist.getPages());
    dto.setTotal((int) pagelist.getTotal());
    if (CollUtil.isEmpty(pagelist.getRecords())){
        dto.setList(Collections.emptyList());
        return dto;
    }
    List<User> p = pagelist.getRecords();
    dto.setList(BeanUtil.copyToList(p,UserVo.class));
    return dto;
}

一句话总结:MyBatis-Plus 通过无侵入式增强,以通用 Mapper、通用 Service、条件构造器及分页/逻辑删除/枚举/JSON 等内置能力,让单表 CRUD 与复杂业务开发几乎零配置、大幅提效。