MybatisPlus最全面的MybatisPlus通关教程

Posted 2023-01-20 小新要变强

前言

本文为最全面的MybatisPlus通关教程相关介绍，下边将对MyBatisPlus概述，MyBatisPlus快速入门，CRUD扩展（包括：插入操作、主键生成策略、更新操作，自动填充，乐观锁，查询操作，分页查询，删除操作，逻辑删除，性能分析插件，条件构造器，代码自动生成器）等进行详尽介绍~

📌博主主页：小新要变强 的主页
👉Java全栈学习路线可参考：【Java全栈学习路线】最全的Java学习路线及知识清单，Java自学方向指引，内含最全Java全栈学习技术清单~
👉算法刷题路线可参考：算法刷题路线总结与相关资料分享，内含最详尽的算法刷题路线指南及相关资料分享~
👉Java微服务开源项目可参考：企业级Java微服务开源项目（开源框架，用于学习、毕设、公司项目、私活等，减少开发工作，让您只关注业务！）

---

目录

文章标题

• 前言
• 目录
• 一、MyBatisPlus概述
• 二、MyBatisPlus快速入门
• 三、CRUD扩展
• • 1️⃣插入操作
  • 2️⃣主键生成策略
  • 3️⃣更新操作
  • 4️⃣自动填充
  • 5️⃣乐观锁
  • 6️⃣查询操作
  • 7️⃣分页查询
  • 8️⃣删除操作
  • 9️⃣逻辑删除
  • 🔟性能分析插件
  • 1️⃣1️⃣条件构造器
  • 1️⃣2️⃣代码自动生成器
• 后记

一、MyBatisPlus概述

需要MyBatisPlus前需要具备的基础： MyBatis、Spring、SpringMVC

为什么要学习MyBatisPlus呢？ MyBatisPlus可以节省我们大量工作时间，所有的CRUD代码它都可以自动化完成！ MyBatisPlus 本来就是简化 JDBC 操作的！

与MyBatisPlus类似的其它工具： JPA 、 tk-mapper

MyBatisPlus官网： https://baomidou.com/

MyBatisPlus特性：

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作， BaseMapper
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD操作，更有强大的条件构造器，满足各类使用需求, 以后简单的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快速入门

准备：

• 拥有 Java 开发环境以及相应 IDE
• 熟悉 Spring Boot
• 熟悉 Maven

🍀（1）创建数据库表

现有一张 User 表，其表结构如下：

id	name	age	email
1	Jone	18	[e-mail]
2	Jack	20	[e-mail]
3	Tom	28	[e-mail]
4	Sandy	21	[e-mail]
5	Billie	24	[e-mail]

其对应的数据库 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, '[e-mail]'),
(2, 'Jack', 20, '[e-mail]'),
(3, 'Tom', 28, '[e-mail]'),
(4, 'Sandy', 21, '[e-mail]'),
(5, 'Billie', 24, '[e-mail]');

🍀（2）初始化工程

创建一个空的 Spring Boot 工程

🍀（3）添加依赖

<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是自己开发，并非官方的！ -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>

说明：使用 mybatis-plus 可以帮助我们节省大量的代码，尽量不要同时导入 mybatis 和 mybatis-plus！

🍀（4）连接数据库

这一步和 mybatis的相关操作相同！

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

🍀（5）连接mybatis，配置mapper.xml文件

采用传统的方式：pojo-dao-service-controller

🍀（6）编码

编写实体类 User.java（此处使用了 Lombok (opens new window)简化代码）：

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

编写 Mapper 包下的 UserMapper接口：

public interface UserMapper extends BaseMapper<User> 

🍀（7）编写测试类，进行功能测试

@SpringBootTest
public class SampleTest 

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() 
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);
    

控制台输出：

User(id=1, name=Jone, age=18, email=[e-mail])
User(id=2, name=Jack, age=20, email=[e-mail])
User(id=3, name=Tom, age=28, email=[e-mail])
User(id=4, name=Sandy, age=21, email=[e-mail])
User(id=5, name=Billie, age=24, email=[e-mail])

三、CRUD扩展

1️⃣插入操作

Insert 插入：

// 测试插入
@Test
public void testInsert()
User user = new User();
user.setName("小新要变强");
user.setAge(22);
user.setEmail("[e-mail]");
int result = userMapper.insert(user); // 帮我们自动生成id
System.out.println(result); // 受影响的行数
System.out.println(user); // 发现，id会自动回填

数据库插入的id的默认值为：全局的唯一id

2️⃣主键生成策略

🍀默认 ID_WORKER 全局唯一id

分布式系统唯一ID生成方案汇总，参考：https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法：

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

🍀主键自增

我们需要配置主键自增：

// 测试插入
@Test
public void testInsert()
User user = new User();
user.setName("小新要变强");
user.setAge(22);
user.setEmail("[e-mail]");
int result = userMapper.insert(user); // 帮我们自动生成id
System.out.println(result); // 受影响的行数
System.out.println(user); // 发现，id会自动回填

• （1）实体类字段上 @TableId(type = IdType.AUTO)
• （2）数据库字段一定要是自增！
• （3）再次测试插入即可！
  

🍀其余的源码解释

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

3️⃣更新操作

// 测试更新
@Test
public void testUpdate()
User user = new User();
// 通过条件自动拼接动态sql
user.setId(2L);
user.setName("小新一直很强");
user.setAge(23);
// 注意：updateById 但是参数是一个 对象！
int i = userMapper.updateById(user);
System.out.println(i);

4️⃣自动填充

创建时间、修改时间！这些个操作一遍都是自动化完成的，我们不希望手动更新！

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

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

• （1）在表中新增字段 create_time, update_time
  

• （2）再次测试插入方法，我们需要先把实体类同步！

private Date createTime;
private Date updateTime;

• （3）再次更新查看结果即可

🍀方式二：代码级别

• （1）删除数据库的默认值、更新操作！

• （2）实体类字段属性上需要增加注解

// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

• （3）编写处理器来处理这个注解即可！

package com.wang.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;

import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
@Slf4j
@Component // 一定不要忘记把处理器加到IOC容器中！
public class MyMetaObjectHandler implements MetaObjectHandler 
// 插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) 
log.info("start insert fill.....");
// setFieldValByName(String fieldName, Object fieldVal, MetaObject
metaObject
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);

// 更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) 
log.info("start update fill.....");
this.setFieldValByName("updateTime",new Date(),metaObject);

• （4）测试插入
• （5）测试更新、观察时间即可！

5️⃣乐观锁

• 乐观锁 : 故名思意十分乐观，它总是认为不会出现问题，无论干什么不去上锁！如果出现了问题， 再次更新值测试
• 悲观锁： 故名思意十分悲观，它总是认为总是出现问题，无论干什么都会上锁！再去操作！

我们这里主要讲解 乐观锁机制！

乐观锁实现方式：

• 取出记录时，获取当前 version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成，这个时候 version = 2，会导致 A 修改失败！
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1

🍀测试一下MP的乐观锁插件

• （1）给数据库中增加version字段！
• （2）我们实体类加对应的字段

@Version //乐观锁Version注解
private Integer version;

• （3）注册组件

// 扫描我们的 mapper 文件夹
@MapperScan("com.wang.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig 
// 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() 
return new OptimisticLockerInterceptor();

• （4）测试一下

// 测试乐观锁成功！
@Test
public void testOptimisticLocker()
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 2、修改用户信息
user.setName("小新要不断变强");
user.setEmail("[e-mail]");
// 3、执行更新操作
userMapper.updateById(user);

// 测试乐观锁失败！多线程下
@Test
public void testOptimisticLocker2()
// 线程 1
User user = userMapper.selectById(1L);
user.setName("小新要不断变强111");
user.setEmail("[e-mail]");
// 模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user2.setName("小新要不断变强222");
user2.setEmail("[e-mail]");
userMapper.updateById(user2);
// 自旋锁来多次尝试提交！
userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！

6️⃣查询操作

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

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

// 按条件查询之一使用map操作
@Test
public void testSelectByBatchIds()
HashMap<String, Object> map = new HashMap<>();
// 自定义要查询
map.put("name","小新要变强");
map.put("age",22);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);

7️⃣分页查询

• 分页在网站使用的十分之多！
• 原始使用 limit 进行分页
• 还有pageHelper 第三方插件
• MP 其实也内置了分页插件！

🍀如何使用

（1）配置拦截器组件即可

// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() 
return new PaginationInterceptor();

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

// 测试分页查询
@Test
public void testPage()
// 参数一：当前页
// 参数二：页面大小
// 使用了分页插件之后，所有的分页操作也变得简单的！
Page<User> page = new Page<>(2,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());

8️⃣删除操作

根据 id 删除记录：

// 测试删除
@Test
public void testDeleteById()
userMapper.deleteById(1240620674645544965L);

// 通过id批量删除
@Test
public void testDeleteBatchId()
userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L,124062067464554496
2L));

// 通过map删除
@Test
public void testDeleteMap()
HashMap<String, Object> map = new HashMap<>();
map.put("name","小新要变强");
userMapper.deleteByMap(map);

9️⃣逻辑删除

• 物理删除 ： 从数据库中直接移除
• 逻辑删除 ： 再数据库中没有被移除，而是通过一个变量来让他失效！ deleted = 0 => deleted = 1

管理员可以查看被删除的记录！防止数据的丢失，类似于回收站！

测试一下：

• （1）在数据表中增加一个 deleted 字段

• （2）实体类中增加属性

@TableLogic //逻辑删除
private Integer deleted;

• （3）配置

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

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-valueMybatisPlus与前端分页工具结合实现

 mybatis-plus代码生成器代码
 mybatisPlus生成项目
 最全面的网站reset文件~
 最全面的Android Studio使用教程
 史上最全面的线程池介绍