SpringBoot使用Mybatis-Plus详解

巴学潞

2023-12-01

MyBatisPuls概述

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生
国产的开源框架，基于MyBatis

核心功能是简化MyBatis的开发，提高效率

底层采用CGlib动态代理方式

其特性有：

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
支持的数据库有:
mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
达梦数据库、虚谷数据库、人大金仓数据库

快速入门

大概分四步

导入对应的依赖
研究依赖如何配置
代码如何编写
提高拓展技术能力

创建表

CREATE DATABASE mybati_plus;

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) 
);

//真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create（创建时间）、gmt_modified（更新时间）

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');

导入依赖

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

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

说明：我们使用mybatis-puls 可以节省我们大量的代码，但是尽量不要同时使用mybatis和mybatis-plus依赖，容易出错。

配置文件

# mysql 5 驱动不同com.,mysql.jdbc.Driver

# mysql 8 com.mysql.cj.jdbc.Driver 并且需要增加时区的配置serverTimezone=UTC
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456

pojo


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private long id;
    private String name;
    private Integer age;
    private String email;
}

mapper

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

import org.springframework.stereotype.Repository;

//其中继承基本类BaseMapper

@Repository //代表这是持久层
public interface UserMapper extends BaseMapper<User> {
    
    //到这一步已经把简单的CRUD的编写完成了，不在是像之前mybatis一样编写接口和XXXMapper.xml，简化开发！
}

注意点：需要在主启动类中，添加 @MapperScan(“com.*.mapper”) =》扫描mapper包下的所有接口

测试


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 ApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        //其中参数是wrapper，条件构造器，这里不用的话可以写null，表示查询所有的用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

配置日志

因为现在由于MyBatis-plus的原因，sql语句对我们来讲是不可见的，我们可以使用他的方法，但是我们没有看到sql语句是怎么执行的，所以这个时候日志应运而生，我们可以通过查看日志，来查看它是怎么执行的，如何配置日志，需要我们在yml文件中加入：

mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

此时打印的日志条件参数为占位符
如何打印出完整的sql呢？
springboot整合mybatis-plus打印完整SQL语句

插入操作（Insert插入）

    @Test
    public void testInsert(){

        User user = new User();
        user.setName("陈志辉");
        user.setAge(21);
        user.setEmail("2425540101@qq.com");

        int insert = userMapper.insert(user);
        System.out.println(insert);
        System.out.println(user);
    }

在这里我们并没有主动设置id，但是系统帮我们自动添加进去了，所以我们紧跟着来了解一下这个主键生成策略！

主键生成策略

默认ID_WORKER ：全局的唯一ID

mybatis-plus主键生成策略

雪花算法：
snowﬂake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），后还有一个符号位，永远是0。可以保证几乎全球唯一！

1、主键自增

（1）我们需要在数据库表中设置主键自增
（2）实体类字段设置注解

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

IdType的源码解释

public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入
ID_WORKER(3), // 默认的全局唯一id
UUID(4), // 全局唯一id uuid
ID_WORKER_STR(5); //ID_WORKER 字符串表示法
}

更新操作

    @Test
    public void testUpdate(){
        User user = new User();
        //通过条件动态拼接sql
        user.setId(1L);
        user.setName("chen");
        //这里的参数是一个对象，而不是id
        int i = userMapper.updateById(user);
        System.out.println(i);
    }

查询操作：【单一查询、批量查询、条件查询map】

    //测试单一查询
    @Test
    public void testSelectById(){
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    //批量查询
    @Test
    public void testSelectByBatchId(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1L,2L,3L));
        users.forEach(System.out::println);

    }

    //条件查询：map
    @Test
    public void testSelectBatchIds(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","陈志辉");
        map.put("age",21);

        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

分页查询

分页查询在网站上使用的频率极多，因为由于大量的数据需要展示，为了给用户更好的体验，会选择分批展示出来

分页的方式：
（1）原始的limit分页
（2）pageHelper第三方插件
（3）MP其实也内置了分页插件

MP使用分页查询步骤

（1）只需要配置拦截器即可

// 分页插件

@Bean
public MybatisPlusInterceptor MybatisPlusInterceptor() {
	MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
	//乐观锁
	mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
	//分页配置
	mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
	return mybatisPlusInterceptor;
}

（2）直接使用Page对象即可

    //分页查询
    @Test
    public void testPage(){
        Page<User> page = new Page<>(1,5);
        userMapper.selectPage(page,null);

        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());

    }

删除操作

1、根据id删除记录【同查询分为：单一、批量、条件删除map】

    //通过id删除
    @Test
    public void testDeleteById(){
        userMapper.deleteById(1L);
    }
    
    //批量删除
    @Test
    public void testDeleteByBatchId(){
        userMapper.deleteBatchIds(Arrays.asList(1L,2L,3L));
    }
    
    
    //按照条件删除
    @Test
    public void testDeleteByMap(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","chen");
        
        userMapper.deleteByMap(map);
    }

逻辑删除

删除分为两种：
（1）物理删除（从数据库中直接移除）
（2）逻辑删除（在数据库中没有移除，而是通过一个变量让他失效：从deleted = 0 =》deleted = 1）
逻辑删除比如删除一个用户名要求唯一的用户后,再进行插入操作还会报错，此问题下一篇文章会详细介绍

管理员可以查看被删除的记录！防止数据丢失，类似于回收站，我们在桌面删除了一个文件，我们感觉文件被删除了，但是它只是进了回收站，还没有在我们本机的存储中删除掉，但是在回收站再清空一下之后，他就完全被删除掉了，这个就是逻辑删除的一个过程。

测试：

1、在数据库表中增加一个deleted字段
2、实体类增加对应的属性

    @TableLogic
    private Integer deleted;

3、配置

（1）MyBatisConfig.java中配置

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

3、配置

（1）MyBatisConfig.java中配置

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

4，测试

自动填充

Springboot +mybatis-plus 实现公共字段自动填充
创建时间、更新时间！这些操作都是自动化完成的，我们不希望手动更新！

在阿里巴巴开发手册上：所有的数据库表：gmt_create、gmt_modied 几乎所有的表都要配置上！而且需要自动化！

方式一：数据库级别（工作中不允许你修改数据库）【不建议】

（1）在表中新增字段：gmt_create、gmt_modified
（2）再次测试插入方法，当然需要先把实体类更新同步一下
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private String email;
private Date gmt_create;
private Date gmt_modified;

}
（3）测试更结果即可

方式二：代码级别

（1）删除数据库的默认值，更新操作！
（2）实体类字段属性上加上注解

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    
    @TableField(fill = FieldFill.INSERT)
    private Date gmt_create;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date gmt_modified;
}

（3）我们需要编写处理器来处理这个注解：【注意方法里的参数需要和实体类的字段对应起来！】


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 {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("gmt_create",new Date(),metaObject);
        this.setFieldValByName("gmt_modified",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("gmt_modified",new Date(),metaObject);
    }
}

（4）测试插入！

（5）查看结果

乐观锁

乐观锁：顾名思义十分乐观，它总是认为不会出现任何问题，不论做什么都不上锁，如果出现问题就更新测试

悲观锁：顾名思义十分悲观，他总是认为会出问题，不论做什么都要上锁，再去操作

下面我们主要说下乐观锁的机制：【实现乐观锁的步骤】
（1）取出记录时，获取当前的version
（2）更新时，带上这个version
（3）执行更新时： set version = newVersion where version = oldVersion
（4）如果version不对，那么就更新失败

一个场景：

假设乐观锁起始值为1，先查询，获得版本号version = 1
现在有两个线程在进行操作

–A
update user set name = “陈志辉”, version += 1
where id = 2 and version = 1

–B 线程抢先完成，这个时候version = 2，导致A更新失败
update user set name = “chen”, version += 1
where id = 2 and version = 1

因为在A线程进行的过程中，B线程抢先执行完成，导致version为2，这个时候当A执行的时候，发现version不为1了，所以就更新失败！

测试：
（1）先给数据库增加字段version
（2）给我们的实体类中增加对应的字段

@Version
private Integer version;

（3）注册组件


@Bean
public MybatisPlusInterceptor MybatisPlusInterceptor() {
	MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
	//乐观锁
	mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
	//分页配置
	mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
	return mybatisPlusInterceptor;
}

（4）测试！

成功

    @Test
    public void testLe1(){
        //查询用户信息
        User user = userMapper.selectById(1l);
        //修改用户信息
        user.setName("chenzhihui");
        user.setAge(100);
        //执行更新操作
        userMapper.updateById(user);
    }

失败：得到的是线程2，而不是线程1的修改的值

@Test
public void testLe2(){
    //线程1
    User user = userMapper.selectById(1l);
    user.setName("chenzhihui");
    user.setAge(100);

    //线程2
    User user2 = userMapper.selectById(1L);
    user2.setName("gogogo");
    userMapper.updateById(user2);

    //执行更新操作
    userMapper.updateById(user);
}

性能分析插件

我们在平时的开发过程中，我们会遇一些慢sql，我们如何找到这些sql语句，这个时候mybatis-plus中有个性能分析插件就可以帮我们完成这些事情，主要是输出每条sql的执行时间，如果超过这个规定的时间就报错停止查询，这样我们就可以知道我们哪里需要优化！

1、导入插件【记得要在springboot中配置环境】

    //性能分析插件
    @Profile({"dev","test"}) //设置在开发环境下，还是在测试环境下
    @Bean
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(10); //设置查询的最大时间，单位是毫秒 1s = 1000ms
        performanceInterceptor.setFormat(true); //是否格式化代码
        return performanceInterceptor;
    }

springboot的配置文件application.yml中配置环境

spring:
profiles:
active: test //配置环境：test
datasource:
url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456

条件构造器Wrapper

到现在为止，我们在UserMapper里没写过任何sql语句，一些简单的sql语句，mybatis-plus都帮我们写好了，那我们怎么实现复杂的sql语句呢，这个时候就需要用Wrapper，到底有多少功能，我们看下官方文档给我们展示的：太多了，一个截屏都放不下，我们就来初步理解下
测试一：记住查看输出的sql进行分析

@Test
public void test01(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //查询名字和邮箱都不为空、且年龄大于18岁的用户
    wrapper.isNotNull("name")
            .isNotNull("email")
            .ge("age",18);

    userMapper.selectList(wrapper).forEach(System.out::println);
}

测试二：记住查看输出的sql进行分析

@Test
public void test02(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //查询名字为陈志辉的用户
    wrapper.eq("name","陈志辉");

    userMapper.selectList(wrapper).forEach(System.out::println);
}

测试三：记住查看输出的sql进行分析

@Test
public void test03(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();

    //查询年龄在20-30岁之间的用户
    wrapper.between("age",20,30);

    userMapper.selectList(wrapper).forEach(System.out::println);
}

    @Test
    public void test04(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        //查询名字不含e、并且email以t开头
        wrapper.notLike("name","c")
                .likeRight("email","t");

        userMapper.selectList(wrapper).forEach(System.out::println);
    }

    @Test
    public void test05(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        //id在子查询中查出来
        wrapper.inSql("id","select id from user where id < 3");

        userMapper.selectList(wrapper).forEach(System.out::println);
    }

    @Test
    public void test06(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        //id在子查询中查出来
        wrapper.orderByAsc("id");

        userMapper.selectList(wrapper).forEach(System.out::println);
    }

代码自动生成器

听到这个代码自动生成器，我们会不禁问道，到底有多自动，那我就告诉你有多自动，自动到你可以不用写pojo、不用写mapper、不用写service、不用写controller，全部都让mybatis-plus帮我们自动生成！！！用AutoGenerator来生成各个模块的代码，极大的提升了开发效率

1、导入依赖

     
        <!--        选择模板-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
          
        </dependency>

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;

public class Code {

    public static void main(String[] args) {
        //需要构建一个代码自动生成器对象
        AutoGenerator mpg = new AutoGenerator();

        //全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir"); //获取当前项目路径
        globalConfig.setOutputDir(projectPath + "/src/main/java");
        globalConfig.setAuthor("XXX");
        globalConfig.setOpen(false);
        globalConfig.setFileOverride(false); //选择是否覆盖
        globalConfig.setServiceImplName("%sService");//取消前缀
        globalConfig.setIdType(IdType.ID_WORKER);
        mpg.setGlobalConfig(globalConfig);

        //设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf8&setTimezone=UTC");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        //包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog"); //设置要生成的模块的名字
        pc.setParent("com.liu"); //父包
        pc.setEntity("pojo");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);


        //策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("user");
        strategyConfig.setNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setEntityLombokModel(true);

        strategyConfig.setLogicDeleteFieldName("deleted");

        //自动填充设置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);

        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategyConfig.setTableFillList(tableFills);

        //乐观锁
        strategyConfig.setVersionFieldName("version");
        strategyConfig.setRestControllerStyle(true);
        strategyConfig.setControllerMappingHyphenStyle(true);

        mpg.setStrategy(strategyConfig);

        mpg.execute();

    }
}