【spring boot 】 MyBatis-Plus 就该这么学

本文链接：https://blog.youkuaiyun.com/ManuMAX/article/details/128890479

MyBatis-Plus（MP）是MyBatis的扩展，提供无侵入性、损耗小的CRUD操作，包括通用Mapper、通用Service等特性。它支持Lambda形式调用、ActiveRecord模式，内置分页插件、性能分析插件和全局拦截插件，同时提供代码生成器以简化开发。文章还介绍了安装、配置和使用MyBatis-Plus的流程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

点个关注，必回关

一、MyBatis-plus概述

1.1 简介

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生
（愿景：我们的愿景是成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍）

1.2 特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
支持 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

1.3 框架结构

在这里插入图片描述

1.4 安装

SpringBoot

Maven：

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

Gradle：

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

Spring MVC

Maven

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>3.4.0</version>
</dependency>

Gradle

compile group: 'com.baomidou', name: 'mybatis-plus', version: '3.4.0'

Spring

Maven：

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

Gradle：

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

注意：
引入MyBatis-Plus之后请不要再次引入MyBatis以及MyBatis-Spring，以避免因版本差异导致的问题

1.5 配置

Spring工程

配置MapperScan

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.baomidou.mybatisplus.samples.quickstart.mapper"/>
</bean>

调整SqlSessionFactory为MyBatis-Plus的SqlSessionFactory

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
</bean>

通常来说，一般的简单工程，通过以上配置即可正常使用MyBatis-Plus

官网地址：点击打开：https://baomidou.com/

1.6 Mcnrepository的使用

地址：https://mvnrepository.com/
作用：帮助我们拿到想要的依赖的具体<dependency>信息

二、mybatis plus的常用注解

@TableName：持久层实体中指出表名

@TableName("sys_user")
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

在这里插入图片描述

@Tableld：持久层实体中主键的注解

@TableName("sys_user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

在这里插入图片描述

@TableField：持久层实体中非中主键与数据库字段的对应（字段注解非主键）

@TableName("sys_user")
public class User {
    @TableId
    private Long id;
    @TableField("nickname")
    private String name;
    private Integer age;
    private String email;
}

在这里插入图片描述

@Version
描述：乐观锁注解、标记 @Version 在字段上
@EnumValue
描述：普通枚举类注解(注解在枚举字段上)
@TableLogic
描述：表字段逻辑处理注解（逻辑删除）
@SqlParser

see@Interceptorlgnore

@KeySequence
描述：序列主键策略 oracle
属性：value、dbType
@Interceptorlgnore
value 值为 1 | yes | on 视为忽略，例如 @InterceptorIgnore(tenantLine = “1”)
value 值为 0 | false | off | 空值不变视为正常执行。

see 插件主体

@OrderBy
描述：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询

三、示例工程

3.1 添加测试依赖

Maven：

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

Gradle：

compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter-test', version: '3.5.3.1'

3.2 编写测试用例

通过@MybatisPlusTest可以快速编写Mapper对应的测试类，实现快速测试代码

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;

import static org.assertj.core.api.Assertions.assertThat;

@MybatisPlusTest
class MybatisPlusSampleTest {

    @Autowired
    private SampleMapper sampleMapper;

    @Test
    void testInsert() {
        Sample sample = new Sample();
        sampleMapper.insert(sample);
        assertThat(sample.getId()).isNotNull();
    }
}