深入浅出理解 MyBatis-Plus（最新版3.5.2）
MyBatisPlus（最新版3.5.2）
笔者使用的是3.5.2最新版本，针对一些功能的修改，比如乐观锁插件、MyBatisPlus分页插件、执行SQL分析打印等新特性都做了详细描述，读者在阅读的过程中发现写的不对的地方，还请指正！
文章目录
- MyBatisPlus（最新版3.5.2）
- 1、快速开始
- 2、配置日志
- 3、CRUD扩展
-
- 3.1、主键生成策略
- 3.2、更新(修改)操作
- 3.3、自动填充
- 3.4、乐观锁
- 3.5、查询操作
- 3.6、分页查询
- 3.7、删除操作
- 3.8、逻辑删除
- 4、 执行SQL分析打印
- 5、条件构造器
- 6、代码自动生成器
基础知识：SSM框架学完，
只要学不死，就往死里学
MybatisPlus可以节省大量的工作时间，所有的CRUD代码自动完成！
JPA、tk-mapper 、MyBatisPlus
简介
官网：MyBatis-Plus (baomidou.com)
特性
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响
- 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
1、快速开始
地址：快速开始 | MyBatis-Plus (baomidou.com)
使用第三方组件：
1、导入相应的依赖
2、研究依赖如何配置
3、代码如何编写
4、提高扩展技术能力
步骤
1、创建数据库mybatis_plus
2、创建user表
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)
);
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
-- 真实开发中，version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
3、编写项目，初始化项目，使用springboot初始化
4、导入相关依赖
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.5.2version>
dependency>
说明：使用mybatis-plus可以节省大量的代码，不要同时导入mybatis和mybatis-plus依赖，会出现版本冲突问题。
5、连接数据库 application.properties
#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?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
6、传统方式 pojo -dao (连接mybatis,配置mapper.xml 文件) -server-controller
6 、使用mybatis-plus之后
-
pojo
@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private Integer age; private String email; } -
mapper接口
//在对应的Mapper 上面继承基本的类 BaseMapper //@Mapper @Repository //代表持久层 public interface UserMapper extends BaseMapper<User> { //所有的CRUD操作都已经编写完成 //不需要像以前一样配置一大堆文件了 } -
注意点，需要在主启动类上扫描mapper包下的所有接口(若编写了配置类，扫描mapper包就放在配置类上)
@MapperScan("com.hh.mybatis_plus.mapper") -
测试类中测试
@SpringBootTest class MybatisPlusApplicationTests { //继承了BaseMapper,所有的方法都来自父类 //也可以自己编写自己的扩展方法 @Autowired private UserMapper userMapper; @Test void contextLoads() { //查询全部的用户 //参数是一个Wrapper 条件构造器，这里先不用 参数写null List<User> users = userMapper.selectList(null); users.forEach(System.out::println); } }
思考问题
1、Sql 谁帮我们写的？
2、方法哪里来的？
myBatis-plus都帮我们干了
2、配置日志
所有的sql 现在是不可见的，我们希望知道他是怎么执行的，所以看日志是必须的，这里使用mybatis-plus 自带的日志功能，当然也可以使用log4j、sel4j 开启日志
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
3、CRUD扩展
Insert
// 测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("落日很温柔");
user.setAge(3);
user.setEmail("[email protected]");
int result = userMapper.insert(user); // 帮我们自动生成id
System.out.println(result); // 受影响的行数
System.out.println(user); // 发现，id会自动回填
}
不需要设置id值（主键），mp自动生成19位的 id 值
数据库插入的id的默认值为：全局的唯一id
3.1、主键生成策略
默认 ID_WORKER 全局唯一id
分布式系统唯一id生成
雪花算法：
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！
主键自增
1、实体类字段上 @TableId(type = IdType.AUTO)
2、数据库字段一定要是自增
3、再次插入测试
源码解释
public enum IdType {
AUTO(0), //数据库id自增
NONE(1), //未设置主键
INPUT(2),//手动输入id值
ASSIGN_ID(3),//默认的全局唯一的ID
ASSIGN_UUID(4); //全局随机唯一id UUID
private final int key;
private IdType(int key) {
this.key = key;
}
public int getKey() {
return this.key;
}
}
mp自带策略
- ID_WORKER : 生成19位值，数字类型使用这种这种策略，比如 long
- ID_WORKER_STR: 生成19位值，字符串类型使用这种策略
3.2、更新(修改)操作
// 测试更新
@Test
public void testUpdate(){
User user = new User();
// 通过条件自动拼接动态sql
user.setId(3L);//三号用户
user.setName("吉吉");
user.setAge(18);
// 注意：updateById 但是参数是一个 对象！
int i = userMapper.updateById(user);
System.out.println(i);
}
通过条件自动拼接动态sql(重要)
所有的sql都是自动帮你动态配置的！
3.3、自动填充
- 创建时间、修改时间！这些个操作一遍都是自动化完成的，我们不希望手动更新！
- 阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化！
方式一：数据库级别（工作中不允许你修改数据库）
1、在表中新增字段 create_time, update_time
2、再次测试插入方法，我们需要先把实体类同步！(测试的时候要把内容一起改了：这里是将吉吉改为了吉吉国王)
方式二：代码级别
1、删除数据库的默认值、更新操作！
2、实体类字段属性上需要增加注解
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3、编写处理器来处理这个注解即可！
package com.hh.mybatis_plus.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
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill.....");
//default MetaObjectHandler 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、测试更新、观察时间即可！
3.4、乐观锁
在面试过程中，我们经常会被问道乐观锁，悲观锁！这个其实非常简单！
- 乐观锁 : 故名思意十分乐观，它
总是认为不会出现问题，无论干什么不去上锁！如果出现了问题，再次更新值测试 - 悲观锁：故名思意十分悲观，它总是认为总是出现问题，无论干什么都会上锁！再去操作！
乐观锁实现方式：
- 取出记录时，获取当前
version - 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
举个栗子
乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "hh", version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成，这个时候 version = 2，会导致 A 修改失败！
update user set name = "hh", version = version + 1
where id = 2 and version = 1
测试一下mybatis-plus的乐观锁插件
1、给数据库中增加version字段！
2、我们实体类加对应的字段
@Version //乐观锁Version注解
private Integer version;
3、注册组件（注意版本问题）
// 扫描我们的 mapper 文件夹
@MapperScan("com.hh.mybatis_plus.mapper")
//开启事务
@EnableTransactionManagement
@Configuration
public class MyBatisPlusConfig {
/**
* 新版
* 注册乐观锁插件
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return mybatisPlusInterceptor;
}
}
4、测试一下！
// 测试乐观锁成功！
@Test
public void testOptimisticLocker(){
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 2、修改用户信息
user.setName("kuangshen");
user.setEmail("[email protected]");
// 3、执行更新操作
userMapper.updateById(user);
}
// 测试乐观锁失败！多线程下
@Test
public void testOptimisticLocker2(){
// 线程 1
User user = userMapper.selectById(1L);
user.setName("kuangshen111");
user.setEmail("[email protected]");
// 模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user2.setName("kuangshen222");
user2.setEmail("[email protected]");
userMapper.updateById(user2);
// 自旋锁来多次尝试提交！
userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！
}
结果：被插队了
3.5、查询操作
// 测试查询(通过id)
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
//测试批量查询(通过多个id去查询)
@Test
public void testSelectByBatchId(){
//selectBatchIds()参数是一个集合
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<String,Object>();
map.put("name","吉吉国王");
map.put("age",18);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
3.6、分页查询
分页在网站使用的十分之多！
1、原始的 limit 进行分页
2、pageHelper 第三方插件
3、MyBatisPlus 其实也内置了分页插件！
如何使用
1、配置拦截器组件即可
/**
* 分页插件
* 也可以不传DbType.MYSQL，为空时会通过URL判断数据库类型
* if (url.contains(":mysql:") || url.contains(":cobar:")) {
* return DbType.MYSQL;
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor2() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
//---------------------------------------------------------------------
//最新版3.5.0分页插件注册写法：
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
//添加乐观锁
mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//添加分页
mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return mybatisPlusInterceptor;
}
//逻辑删除加这个
interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
2、直接使用Page对象即可！
//测试分页查询
@Test
public void testPage(){
// 参数一：当前页
// 参数二：页面大小
// 使用了分页插件之后，所有的分页操作也变得简单的！
Page<User> page = new Page<>(1, 3);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
//System.out.println(page.getTotal());
}
3、测试
3.7、删除操作
1、根据 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);
}
我们在工作中会遇到一些问题：逻辑删除！
3.8、逻辑删除
- 物理删除 ：从数据库中直接移除
- 逻辑删除 ：数据库中没有被移除，而是通过一个变量来让他失效！ deleted = 0 => deleted = 1
管理员可以查看被删除的记录！防止数据的丢失，类似于回收站！
测试一下：
1、在数据表中增加一个 deleted 字段
2、实体类中增加属性
@TableLogic //逻辑删除
private Integer deleted;
3、配置（application.yml）
mybatis-plus:
global-config:
db-config:
logic-delete-field: flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
4、测试一下删除！
记录依旧在数据库，但是值确已经变化了！
查询一下看看
查不到了哦
4、 执行SQL分析打印
我们在平时的开发中，会遇到一些慢sql。测试！ druid,
作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间
MyBatisPlus也提供性能分析插件，如果超过这个时间就停止运行！
该功能依赖
p6spy组件，完美的输出打印 SQL 及执行时长3.1.0以上版本
1**.p6spy 依赖引入**
<dependency>
<groupId>p6spygroupId>
<artifactId>p6spyartifactId>
<version>3.9.1version>
dependency>
2、application.yml 配置（要是application.properties中配置了此处便不再配置）
spring:
datasource:
driver-class-name: com.p6spy.engine.spy.P6SpyDriver
url: jdbc:p6spy:h2:mem:test
...
注意： driver-class-name 为 p6spy 提供的驱动类
url 前缀为 jdbc:p6spy 跟着冒号为对应数据库连接地址
实际配置
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/mybatisplus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
3、spy.properties 配置
#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
#3.2.1以下使用或者不配置
#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2
4、测试使用！
@Test
void contextLoads() {
//查询全部的用户
//参数是一个Wrapper 条件构造器，这里先不用null
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
5、结果
注意配置：application.properties
5、条件构造器
十分重要：Wrapper
我们写一些复杂的sql就可以使用它来替代！
mp实现复杂条件查询 :使用
QueryWrapper构建条件
- 创建
QueryWrapper对象 - 调用方法实现各种 条件查询
1、测试一，记住查看输出的SQL进行分析
@Test
void contextLoads() {
// 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);
}
2、测试二
void test2(){
//查询名字haohao
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "haohao");
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
3、测试三
@Test
void test3(){
//查询年龄在20-30岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30);
Long count = userMapper.selectCount(wrapper);
System.out.println(count);
}
4、测试四
@Test
void test4(){
/**
* 模糊查询
* 查询name 中不带 e 并且 email 左边是 t
* 左和右 t%
*/
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
5、测试五
@Test
void test5(){
//模糊查询 id 在自查询中查出来
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id<3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
6、测试六
@Test
void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序
wrapper.orderByAsc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
其余后面测试
6、代码自动生成器
代码生成器（新） | MyBatis-Plus (baomidou.com)
pojo、dao、service、controller都自动编写完成！
AutoGenerator是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、
Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
代码自动生成器非常好用，我们只需要提供我们数据库的表名，然后就可以让生成器自动帮我们完成各种代码的创建，整个过程非常清爽，可以说是加班人的福利！
使用
导包
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.5.2version>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-generatorartifactId>
<version>3.5.2version>
dependency>
<dependency>
<groupId>org.freemarkergroupId>
<artifactId>freemarkerartifactId>
<version>2.3.31version>
dependency>
快速生成：
package com.hh.demo;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.Collections;
//代码自动生成器
public class
CodeGenerator {
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://localhost:3306/library?&characterEncoding=utf-8&userSSL=false", "root", "123456")
.globalConfig(builder -> {//全局配置
builder.author("吉吉国王") // 设置作者
//.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("D://demo-library"); // 指定输出目录
})
.packageConfig(builder -> {//包配置
builder.parent("com.hh") // 设置父包名
.moduleName("demo") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.xml, "D://demo-library"));// 设置mapperXml生成路径
})
.strategyConfig(builder -> {//策略配置
builder.addInclude("iot1002_book","iot1002_bookinfo","iot1002_exceptionmessage","iot1002_smokesensor","iot1002_user") // 设置需要生成的表名
.addTablePrefix("iot1002_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker 引擎模板，默认的是Velocity引擎模板
.execute();
}
}