Mybatis-Plus天花板教程，还有谁不选择使用？
算起来，mp也用了两年多了，总体上还是非常舒服的，导致我现在都不想写sql了，网络上教程很多，这里只记录我项目中感觉较为好用的功能
什么是MybatisPlus
MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
愿景是成为Mybatis最好的搭档，就像魂斗罗中的1P、2P，基友搭配，效率翻倍
为什么选择它
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
快速开始
可以使用Spring Initializer(opens new window)快速初始化一个SpringBoot 工程
- 添加父工程(Spring Boot Starter)
1
2
3
4
5
6<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5+ 版本</version>
<relativePath/>
</parent> - 引入依赖
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22// spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、h2
<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>最新版本</version>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies> - 添加配置(application.yml)
1
2
3
4
5
6
7
8
9
10
11# DataSource Config
spring:
datasource:
driver-class-name: org.h2.Driver
schema: classpath:db/schema-h2.sql
username: root
password: test
sql:
init:
schema-locations: classpath:db/schema-h2.sql
data-locations: classpath:db/data-h2.sql - 添加扫描注解(@MapperScan)
1
2
3
4
5
6
7
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
} - 测试代码(使用Lombok简化代码)
- 实体类
1
2
3
4
5
6
7
public class User {
private Long id;
private String name;
private Integer age;
private String email;
} - mapper接口
1
2public interface UserMapper extends BaseMapper<User> {
} - 编写测试类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
public class SampleTest {
private UserMapper userMapper;
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);
}
}selectList()不填写表示无参数 - 控制台输出
1
2
3
4
5User(id=1, name=Jone, age=18, email=test1.com)
User(id=2, name=Jack, age=20, email=test2.com)
User(id=3, name=Tom, age=28, email=test3.com)
User(id=4, name=Sandy, age=21, email=test4.com)
User(id=5, name=Billie, age=24, email=test5.com)
配置日志(bootstrap.yml)
1 | mybatis-plus: |
自动填充
一般来说，代码中create_time、update_time、create_user等字段希望是自动化完成，不希望手动更新
阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化！
- 表中添加字段create_time、update_time
- 删除数据库中配置的更新属性
- 实体中添加@TableField注解
1
2
3
4
5
6
7
8
9
10
11
12/**
* 创建人
*/
private String createName;
/**
* 创建时间
*/
private LocalDateTime createTime; - 添加处理器来处理该注解
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23/**
* 自定义字段填充类
*
* @author Manxin
* @date 2023-03-28 16:06:47
*/
public class MyDateObjectHandler implements MetaObjectHandler {
public void insertFill(MetaObject metaObject) {
User user = SecurityUtils.getUser();
this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
this.setFieldValByName("createId", user.getId(), metaObject);
this.setFieldValByName("createName", user.getRealname(), metaObject);
}
public void updateFill(MetaObject metaObject) {
}
} - 测试观察数据库即可
乐观锁
乐观锁：故名思议十分乐观，它总是认为不会出现问题，无论干什么不去上锁！如果出了问题，再次更新值测试
悲观锁：故名思议十分悲观，它总是认为总是出现问题，无论干什么都会上锁！再去操作！
乐观锁实现的方式
取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败
测试乐观锁插件
- 数据库添加version字段
- 实体类添加version字段
- 注册使用
1
2
3
4
5
6
7
8
9
10
11//扫描mapper文件夹
//配置类
public class MyBatisPlusConfig {
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
} - 测试效果
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24//乐观锁-成功
public void versionTest(){
User user = userMapper.selectById(1L);
user.setName("满心");
user.setEmail("manxin@lovelu.top");
userMapper.updateById(user);
}
//乐观锁失败----多线程
public void OptimisticLockerTest(){
User user = userMapper.selectById(1L);
user.setName("满心");
user.setEmail("manxin@lovelu.top");
//模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user.setName("满心2");
user.setEmail("manxin@lovelu.top");
userMapper.updateById(user2);
userMapper.updateById(user);
}
逻辑删除
物理删除：从数据库中直接移除
逻辑删除：在数据库中没有被移除，而是通过一个变量让他无效！delete = 0 —> delete = 1
管理员可以查看被删除的记录！防止数据的丢失，类似于回收站！
- 数据库添加deleted字段
- 实体中添加deleted属性
- 配置逻辑删除(bootstrap.yml)
1
2
3#配置逻辑删除 1 删除 0 未删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
条件构造器(重要)
可以使用QueryWrapper和LambdaQueryWrapper两种，我比较习惯使用后者（两者区别，后者对应的是实体字段，前者是数据库字段），具体可以看下面例子
- eg（QueryWrapper）
1
2
3
4
5
6
7
8
9
10
11
public void queryWrapperTest(){
//查询name不为空的用户，并且邮箱不为空的用户，年龄大于18
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age",18);
userMapper.selectList(wrapper).forEach(System.out::println);
} - eg（LambdaQueryWrapper）
1
2
3
4
5
6
7
8
9
10
public void LambdaQueryWrapperTest(){
//查询name不为空的用户，并且邮箱不为空的用户，年龄大于18
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull(User::getName)
.isNotNull(User::getEmail)
.ge(User::getAge,18);
userMapper.selectList(wrapper).forEach(System.out::println);
}
代码生成器
AutoGenerator是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
1 | public class Generator{ |
