MybatisPlus详解

一. MybatisPlus介绍

1. 简介

官网
Mybaits-Plus (简称 MP),是一个 Mybatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

2. 特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

二、MybatisPlus入门案例

1. 创建并初始化数据库

1.1 创建数据库

mybatis_plus

1.2 创建 User 表

其表结构如下：

其对应的数据库 Schema 脚本如下：

DROP TABLE IF EXISTS user;
CREATE TABLE user
(
    id BIGINT(20) NOT NULL COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

其对应的数据库 Data 脚本如下

DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

2. 初始化工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程

3. 添加依赖

    <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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

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

        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--lombok用来简化实体类-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>

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

4. idea中安装lombok插件

5. 配置

在 application.properties 配置文件中添加 MySQL 数据库的相关配置：

#mysql数据库连接
##mysql8以上（spring boot 2.1）
###注意：driver和url的变化
spring.datasource.hikari.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.6.61:3306/kaoqinreport?serverTimezone=GMT%2B8	#加时区
spring.datasource.username=root
spring.datasource.password=Edao6688


#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

注意：
1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：
java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or represents more
2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

6. 编写代码

6.1 启动类

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹

注意：扫描的包名根据实际情况修改

package com.hyang.mybatis;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.hyang.mybatis.sys.mapper")
public class RunApplication {

    public static void main(String[] args) {
        SpringApplication.run(RunApplication.class, args);
    }
}

6.2 实体

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

package com.hyang.mybatis.sys.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

import java.util.Date;

@SuppressWarnings("serial")
@EqualsAndHashCode(callSuper = false)
@TableName("user")
@Data
@Accessors(chain = true)
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private int age;
    private String email;
}

6.3 mapper

创建包 mapper 编写Mapper 接口： UserMapper.java

package com.hyang.mybatis.sys.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.hyang.mybatis.sys.entity.User;

public interface UserMapper extends BaseMapper<User> {
    
}

6.4 测试

添加测试类，进行功能测试：

package com.hyang.mybatis;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.hyang.mybatis.sys.entity.User;
import com.hyang.mybatis.sys.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class RunApplicationTests {

    @Autowired
    private UserMapper userMapper;

    /**
     * 查询所有用户信息
     */
    @Test
    public void selectUserTest() {
        List<User> userList = userMapper.selectList(null);
        System.out.println(userList);
    }

    /**
     * 添加用户
     */
    @Test
    public void saveUserTest() {
        User user = new User();
        user.setName("与海03");
        user.setAge(18);
        user.setEmail("2768270255@qq.com");
        int i=userMapper.insert(user);
        if (i>0){
            System.out.println("添加成功");
        }else{
            System.out.println("添加失败");
        }
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("name", "与海");
        User user1 = userMapper.selectOne(queryWrapper);
        System.out.println(user1);
    }
}

三. 主键生成策略介绍

1. 主键策略

1.1 ID_WORKER

MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID
参考资料：分布式系统唯一ID生成方案汇总

1.2 自增策略

要想主键自增需要配置如下主键策略

需要在创建数据表的时候设置主键自增
实体字段中配置 @TableId(type = IdType.AUTO)

    @TableId(type = IdType.AUTO)
    private Long id;

要想影响所有实体的配置，可以设置全局主键配置

#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto

其它主键策略：分析 IdType 源码可知

package com.baomidou.mybatisplus.annotation;

public enum IdType {
    /**
     * 数据库ID自增
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型
     */
    NONE(1),
    /**
     * 用户输入ID
     * 该类型可以通过自己注册自动填充插件进行填充
     */
    INPUT(2),
    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 全局唯一ID (idWorker)
     */
    ID_WORKER(3),
    /**
     * 全局唯一ID (UUID)
     */
    UUID(4),
    /**
     * 字符串全局唯一ID (idWorker 的字符串表示)
     */
    ID_WORKER_STR(5);

    private int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

四. MybatisPlus实现自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：
案例:

1. 数据库表中添加自动填充字段

在User表中添加datetime类型的新的字段 create_time、update_time

2. 实体上添加注解

package com.hyang.mybatis.sys.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

import java.util.Date;

@SuppressWarnings("serial")
@EqualsAndHashCode(callSuper = false)
@TableName("user")
@Data
@Accessors(chain = true)
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private int age;
    private String email;
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

3. 实现元对象处理器接口 - MetaObjectHandler

package com.hyang.mybatis.common.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * 实现数据库对象自动加载,减少代码
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    /**
     * mp实现insert操作时,执行该方法
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    /**
     * mp实现update操作时,执行该方法
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

五. MybatisPlus实现乐观锁

1. 原理

主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新
乐观锁实现方式：

1. 取出记录时，获取当前version 如:version =1
2. 更新时，带上这个version 此时:version =1
3. 执行更新时， set version = newVersion where version = oldVersion=1
4. 执行更新后, 数据库version 自增1.
5. 如果执行更新时version不对(即当有其他用户修改用户数据成功时,version 会发生自增操作,导致当前version和数据库的version 不一致)，就更新失败.

2. 实现

2.1 数据库中添加version字段

ALTER TABLE `user` ADD COLUMN `version` INT

2.2 实体类添加version字段

添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;

2.3 元对象处理器接口添加version的insert默认值

package com.hyang.mybatis.common.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * 实现数据库对象自动加载创建时间和更新时间,减少代码
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    /**
     * mp实现insert操作时,执行该方法
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
        this.setFieldValByName("version", 1, metaObject);
    }

    /**
     * mp实现update操作时,执行该方法
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

特别说明:
支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime整数类型下
newVersion = oldVersion + 1
newVersion 会回写到 entity 中
仅支持 updateById(id) 与 update(entity, wrapper) 方法在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

2.4 在 MybatisPlusConfig 中注册 乐观锁Bean

package com.hyang.mybatis.common.config;


import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

//启动类配置配置到配置类
@Configuration
@MapperScan("com.hyang.mybatis.sys.mapper")
public class Mpconfig {

    /**
     * 乐观锁插件
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

2.5 测试乐观锁可以修改成功

    //测试乐观锁操作
    @Test
    public void testOptimisticLocker() {

        //根据id查询数据
        User user = userMapper.selectById(7);
        //进行修改
        user.setAge(200);
        int row =userMapper.updateById(user);
        System.out.println(row);
    }

    /**
     * 测试乐观锁插件 失败
     */
    @Test
    public void testOptimisticLockerFail() {
        //查询
        User user = userMapper.selectById(9);
        //修改数据
        user.setName("Helen Yao1");
        user.setEmail("helen@qq.com1");
        //模拟取出数据后，数据库中version实际数据比取出的值大，即已被其它线程修改并更新了version
        user.setVersion(user.getVersion() - 1);
        //执行更新
        int row = userMapper.updateById(user);
        System.out.println(row);
    }

六. MybatisPlus实现分页

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

1. Mybatis配置类添加分页插件

package com.hyang.mybatis.common.config;


import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

//启动类配置配置到配置类
@Configuration
@MapperScan("com.hyang.mybatis.sys.mapper")
public class Mpconfig {
    /**
     * 分页插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

    /**
     * 乐观锁插件
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

2. 应用

    @Test
    public void testPage() {
        //1、创建page对象
        //传入两个参数；当前页和每页显示记录数
        Page<User> page=new Page<>(1,3);
        //调用mp分页查询的方法
        //调用mp分页查询过程中，底层封装
        //把分页所有数据封装到page对象里面
        userMapper.selectPage(page,null);

        //通过page对象获取分页数据
        System.out.println("当前页:"+page.getCurrent());//当前页
        System.out.println("当前页数据");//获取数据的list集合
        page.getRecords().forEach(System.out::println);
        System.out.println("每页显示记录数:"+page.getSize());//每页显示记录数
        System.out.println("显示总记录数:"+page.getTotal());//显示总记录数
        System.out.println("总页数:"+page.getPages());//总页数

        System.out.println(page.hasNext());//下一页
        System.out.println(page.hasPrevious());
    }

测试结果

七. MybatisPlus实现逻辑删除

• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据
• 逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录
  

1. 表添加字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

2. 实体类添加deleted字段

    @TableLogic
    @TableField(fill = FieldFill.INSERT)
    private Integer deleted;

3. 元对象处理器接口添加deleted的insert默认值

MyMetaObjectHandler

    /**
     * mp实现insert操作时,执行该方法
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
        this.setFieldValByName("version", 1, metaObject);
        this.setFieldValByName("deleted",0,metaObject);
    }

4. application.properties 加入配置

#逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

5. 在 MybatisPlusConfig 中注册 Bean

    /**
     * 逻辑删除插件
     */
    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }

6. 测试逻辑删除

6.1 创建新用户

    /**
     * 添加用户
     */
    @Test
    public void saveUserTest() {
        User user = new User();
        user.setName("王鑫");
        user.setAge(18);
        user.setEmail("2768270255@qq.com");
        int i = userMapper.insert(user);
        if (i > 0) {
            System.out.println("添加成功");
        } else {
            System.out.println("添加失败");
        }
    }

表:

6.2 逻辑删除

    //逻辑删除
    @Test
    public void testLogicDelete(){
        int row=userMapper.deleteById(12L);
        System.out.println(row);
    }

运行: 底层并没有删除id为12的用户信息,而是更新他的deleted值为1

表:

6.3 查找

    @Test
    public void selectById(){
        User user=userMapper.selectById(12);
        System.out.println(user);
    }

底层sql:

SELECT id,name,age,email,create_time,update_time,version,deleted FROM user WHERE id=? AND deleted=0 

八. MybatisPlus性能分析插件

1. 性能分析

性能分析拦截器，用于输出每条 SQL 语句及其执行时间

SQL 性能执行分析,开发环境使用，超过指定时间，停止运行。有助于发现问题

2. 代码

2.1 在 MybatisPlusConfig 中配置插件

参数说明
参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。
参数：format： SQL是否格式化，默认false。

    /*
     *性能分析插件
     * SQL 执行性能分析插件
     * 开发环境使用，线上不推荐， maxTime 指的是 sql 最大执行时长
     *
     *
     * 三种环境
     * dev  ：开发环境
     * test ：测试环境
     * prod ：生产环境
     * */
    @Bean
    @Profile({"dev", "test"})// 设置 dev test 环境开启
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

2.2 Spring Boot 中设置dev环境

#环境设置：dev、test、prod
spring.profiles.active=dev

2.3 测试

常规测试

    //添加操作
    @Test
    public void addUser() {
        User user = new User();
        user.setName("岳不群");
        user.setAge(23);
        user.setEmail("lilei@qq.com");
        int insert = userMapper.insert(user);
        System.out.println(insert);
    }

将插件的maxTime 改小之后再次进行测试

performanceInterceptor.setMaxTime(5);//ms，超过此处设置的ms不执行

    //添加操作
    @Test
    public void addUser() {
        User user = new User();
        user.setName("王二麻子");
        user.setAge(23);
        user.setEmail("wanger@qq.com");
        int insert = userMapper.insert(user);
        System.out.println(insert);
    }

如果执行时间过长，则抛出异常：The SQL execution time is too large