一,Mybatis-plus简介
1, 简介
Mybatis-plus(简称MP)是一个Mybatis的增强的工具,在Mybatis的基础上制作增强,不做改变,为简化开发,提高效率而生。
2,特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响。
- 损耗小:启动即会自动注入基本CURD,性能基本无损耗,直接面向对象操作
- 强大的CRUD操作:内置通用Mapper,通用Service,仅仅通过少量配置即可实现单表大部分CRUD操作,更有强大的条件构造器,满足各类使用需求
- 支持Lambda形式调用:通过Lambda表达式,方便编写各种查询条件,无需担心字段写错
- 支持主键自动生成:支持多达四种主键策略(内含分布式唯一ID生成器:Sequence),可自由配置,完美解决主键问题
- 支持ActiveRecord模式:支持ActiveRecord形式调用,实体类只需继承Model类即可进行强大的CRUD操作
- 支持自定义全局通用操作:支持全局通用方法注入
- 内置代码生成器:采用代码或者Maven插件可快速生成Mapper,Model,Service,Controller层代码,支持模板引擎,更有超多自定义配置
- 内置分页插件:基于Mybatis物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通List查询
- 分页插件支持多种数据库:支持MySQL,MariaDB,Oracle,DB2,H2,HSQL,SQLite.SQLServer等多种数据库
- 内置性能分析插件:可输出SQL语句以及其执行时间,建议开发测试时启用此功能,能快速找出慢查询
- 内置全局拦截插件:提供全表delete,update操作只能分析阻断,也可自定义拦截规则,预防误操作
二,入门案例
1,开发环境
IDE: idea 2022.3
JDK: JDK8+
构建工具:maven 3.9.0
MySQL版本:MySQL 8.0
Spring Boot: 2.7.10
Mybatis-plus: 3.5.1
2,创建数据库及表
a>创建表
CREATE DATABASE `mybatis_plus`
USER `mybatis_plus`;
CREATE TABLE `user`(
id BIGINT(20) NOT NULL COMMENT '主键ID',
NAME VARCHAR(30) DEFAULT NULL COMMENT '姓名',
age INT(11) DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
)ENGINE=INNODB DEFAULT CHARSET=utf8;
b>添加数据
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,'Rose',21,'test4@baomidou.com');
3,创建Spring Boot工程
a>初始化工程
b>需要在基础上补充的依赖
//mybatis-plus环境
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
//数据库连接
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.31</version>
</dependency>
//lombok插件
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
c>安装lombok插件
如何使用插件的具体细节:https://blog.csdn.net/m0_62128530/article/details/130218341
4.编写代码
项目结构
a>配置application.yaml
spring:
datasource:
url: jdbc:mysql://localhost:3306/mybatis_plus
password: 10210620
username: root
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.zaxxer.hikari.HikariDataSource
//此处使用的数据源类型是hikaridatasource,也可以使用druid的数据源,但别忘记引入相关依赖。
driven驱动类根据mysql选择:
mysql 5 :com.mysql.jdbc.Driver
mysql 8 :com.mysql.cj.jdbc.Driver
b>启动类
在Spring Boot 启动类中添加@MapperScan注解,扫描mapper包
c>添加实体类
使用lombok注解的地方,有不了解的可以参考一下:https://blog.csdn.net/m0_62128530/article/details/130218341
d>添加mapper
BaseMapper是MaBaits-Plus提供的模板mapper,其中包含了基本的CRUD方法。
e>测试
selectList()方法的参数是一个Wrapper(条件构造器),可根据在条件构造器中设置的条件过滤不想查找数据。本次测试先设置为null(没有条件,查询全部),后续会细说…
三.基本的CRUD
1.BaseMapper
BaseMapper是Mybatis-Plus内置的模板mapper,其中实现了基本的CRUD功能,我们将自定义的mapper接口继承于它,可快速使用CRUD功能。如果想实现跟多功能,在自己定义的mapper扩展即可。
BaseMapper内部所有的方法,相信大家看到方法名、参数和返回值就知道如何使用,在这里我也不罗嗦了:
注意:通过观察我们可以发现,BaseMapper中大多数方法的形参都有Wrapper类型的参数,这个是条件构造器,可根据在条件构造器中设置的不同条件过滤不想查找数据。如果没有条件,则可以为该形参赋值null,即CRUD所有数据。
2.Service层
通用Service CRUD封装IService接口,进一步封装CRUD.
为了区别Mapper层,Servcie层采用:get查询单行,remove删除,list集合查询,page分页等前缀。
总体结构:
UserMapper:
UserService:
IService<>的泛型是任意实体类
UserServiceImpl:
ServiceImpl<T1,T2>中的泛型,T1是任意对应实体Mapper,T2是任意对应实体。
a>IService
Mybaits-Plus中有一个接口IService和其实现类ServiceImpl,封装了常见的业务层逻辑。
IService:
ServiceImpl:
b>Service层思想
- UserService继承IService模板提供的基础功能
- ServiceImpl实现了IService,提供了IService中基础功能的实现,若ServiceImpl无法满足业务需求,则可以使用自定义的UserService自定义扩充方法,并在自定义实现类中实现。
四.常用注解
1.@TableName
规律:我们在使用Mybatis-Plus提供的CRUD功能时,只是在Mapper接口继承BaseMapper时,设置了泛型User,并没有指出要操作哪个表,它为什么会知道我们要操作的user表。
结论:Mybatis-plus通过BaseMapper的泛型来确定要操作的表,默认实体类型类型的名字与要操作的表名一致。
a>问题
若实体类类型的名字与要操作的表明不一致会怎样?
将表user改名为t_user后,测试:
b>解决问题
1.通过@TableName
在实体类类型上添加@TableName(“t_user”),标识实体类对应的表,即可。
再次测试:测试通过
2.通过全局配置
可以使用Mybatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就不需要在每个实体类上通过@TableName标识实体类对应的表了。
2.@TableId
Mybatis-Plus在进行CRUD操作时,会默认将(字段/属性名)为id作为主键列,并在插入数据时,默认基于雪花算法的策略生成id。
a>问题
若实体类和表中标识主键的不是id,而是其他字段,例如uid,Mybatis-Plus会自动识别uid作为主键列吗?
测试:将实体类中的属性id改为uid,将表中的字段id也改为uid,测试添加功能。
结果:抛异常,Field ‘uid’ doesn’t have a default value,说明Mybatis-Plus没有将uid作为主键赋值。
b>通过@TableId解决问题
在实体类中uid属性上通过加上@TableId将其标识为主键
再次测试:测试通过,影响行数1。
c>@TableId的value属性
若实体类主键对应的属性名为id,而表中表示主键的字段名为uid,此时若只在属性id上添加@TableId,则抛出Unknown colunm ‘id’ in ‘field list’,即Mybatis-Plus仍然会将id作为表的主键操作,而表中表示主键的是字段uid就,此时需要通过@TableId注解的value属性,来指定表中的主键字段,@TableId(value = 'uid)。
d>@TableId的type属性
作用:type属性用来定义主键策略。
常用的主键策略:
- IdType.ASSIGN_ID(默认):基于雪花算法的策略生成数据id,与数据库id是否设置自增无关。
- IdType.AUTO: 使用数据库的自增策略,注意,该类型请保证了数据库设置了id自增,否则无效。
3.@TableField
Mybatis-Plus在执行SQL语句时,要保证实体类中的属性名和表中的字段名保持一致。
问题:如果实体类中的属性名和表中的字段名不一致,会出现什么情况。
a>情况一
若实体类中的属性使用的是驼峰命名风格,而表中字段使用的是下划线命名风格
如:实体类属性userName,表中字段user_name
此时Mybatis_Plus会自动将下划线命名风格转化为驼峰命名风格
b>情况二
若实体类中的属性和表中的字段不满足情况一
例如:实体类属性name,表中字段username
此时需要在实体类属性上使用@TableField(“username”)设置属性所对应的字段名
4.@TabelLogic
a>逻辑删除
- 物理删除:真实删除,将对应数据从数据库中删除,值后插叙不到被删除的数据
- 逻辑删除:假删除,将对应数据中代表被删除字段的状态修改为“被删除状态”,之后在数据库中仍能看到这条数据记录
使用场景:可以进行数据恢复
b>实现逻辑删除
step1:在数据库中创建一个字段列表示逻辑删除状态,默认值设为0。
step2:在实体类中添加逻辑删除属性
step3:测试后发现,delete功能实际是修改功能。
五.条件构造器和常用接口
1.wrapper介绍
-
Wrapper: 条件构造抽象类,最顶端父类
- AbstractWrapper: 用于查询条件封装,生成sql的where条件
- QueryWrapper:查询条件封装
- UpdateWrapper:修改条件封装
- AbstractLambdaWrapper:使用lambda语法
- LambdaQueryWrapper:使用Lambda语法的查询Wrapper
- LambdaUpdateWrapper:使用Lombda语法的修改Wrapper
- AbstractWrapper: 用于查询条件封装,生成sql的where条件
2.QueryWrapper
a>例1:组装查询条件
b>例2:组装排序条件
c>例3:组装删除条件
d>例4:条件的优先级
e>例5:组装select子句
f>例6:实现子查询
3.UpdateWrapper
4.condition
在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因此我们在组装这些条件时,必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若没有选择则一定不能组装,以免影响SQL执行的结果。
如何避免条件的错误组装:
思路一:
思路二:
上面的实现方案没有问题,但是代码比较复杂,我么可以使用带condition参数的重载方法构建查询条件,简化代码的编写
5.LambdaQueryWrapper
6.LambdaUpdateWrapper
六.插件
1.分页插件
Mybatis-Plus自带分页插件,只要简单的配置即可实现分页功能
a>添加配置类
package com.example.mybatisplusstudy.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
b>测试
2.了解乐观锁和悲观锁
a>场景
一件商品,成本价是80元,售价是100元。老板先是通知小李,说你去把商品价格增加50元。小李正在玩游戏,耽搁了一个小时。正好一个小时后,老板觉得商品价格增加到150元,价格太高,可能会影响销量。又通知小王,说你把商品价格再降低30元。
此时,小李和小王同时操作商品后台系统。小李操作的时候,系统先取出商品价格100元;小王也在操作,取出的商品价格也是100元。小李将价格加了50元后,将150元元存入了数据库;小王将产品减了30元,并将70元存入了数据库。是的,如果没有锁,小李的操作就完全被小王的操作覆盖了。
现在商品的价格时70元,比成本价低10元。几分钟后老板含泪卖了1000多件商品。
b>乐观锁和悲观锁的作用
上面的场景,如果使用了乐观锁,小王保存价格前,会检查一下价格是否被人修改过了。如果被修改过了,则重新取出被修改后的价格,150元,这样他会将120存入数据库。
如果使用了悲观锁,小李取出数据后,小王只能等到小李操作完成之后,才能对价格进行修改,也会保证最终的价格是120元。
c>模拟修改冲突
数据库中增加商品表
CREATE TABLE `t_product`(
id BIGINT(20) NOT NULL COMMENT '主键ID',
NAME VARCHAR(30) DEFAULT NULL COMMENT '商品名称',
price INT(11) DEFAULT 0 COMMENT '价格',
VERSION INT(11) DEFAULT 0 COMMENT '乐观锁版本号',
PRIMARY KEY (id)
)ENGINE=INNODB DEFAULT CHARSET=utf8;
添加数据
insert into t_product(id,name,price) values(1,"拯救者笔记本",100);
添加实体类
package com.example.mybatisplusstudy.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {
private Long id;
private String name;
private int price;
private int version;
}
添加mapper
package com.example.mybatisplusstudy.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
public interface ProductMapper extends BaseMapper<ProductMapper> {
}
测试
d>乐观锁实现流程
数据库中添加version字段,取出记录时,获取当前version
select id,name,price,version from t_product where id=1;
更新时,version + 1,如果where语句中的version版本不对,则更新失效
update t_product set price=price+50,version=version+1 where id=1 and version=1;
e>实现乐观锁过程
修改实体类
添加乐观锁插件配置
再次测试
小王修改失败:商品最终价格是150元
优化
七.通用枚举
表中的有些字段值是固定的,例如性别(男或女),此时我们可以通过Mybatis-Plus的通用枚举来实现。
a>数据库表添加字段sex
b>创建通用枚举类型
c> 配置扫描通用配置
d>测试
八.代码生成器
1.引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
2.快速生成
package com.example.mybatisplusstudy.pojo;
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 MyFastAutoGenerator {
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&userSSL=false","root","")
.globalConfig(builder -> {
builder.author("author")//设置作者
.fileOverride()//覆盖已经生成的文件
.outputDir("D://xxx");//指定输出目录
})
.packageConfig(builder -> {
builder.parent("Me")//设置父包名
.moduleName("fatherModelName")//设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml,"D://xxx"));//设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("tableName")//设置要生成的表名字
.addTablePrefix("t_","c_");//设置过滤前缀
})
.templateEngine(new FreemarkerTemplateEngine())//使用Freemarker引擎模板,默认的是使用Velocity引擎模板
.execute();
}
}
九.多数据源
适用于多种场景:纯粹多库,读写分离,一主多从,混合模式等。
测试场景:纯粹多库
场景说明:
我们创建两个数据库,分别为:mybatis_plus和mybatis_plus2,将mybatis_plus库的product表移动到mybatis_plus2库,这样每个库都有一张表,通过一个测试用例分别获取用户数据和商品数据,如果获取到说明多库模拟成功。
1.创建数据库
CREATE DATABASE mybatis_plus2;
USE mybatis_plus2;
CREATE TABLE `t_product`(
id BIGINT(20) NOT NULL COMMENT '主键ID',
NAME VARCHAR(30) DEFAULT NULL COMMENT '商品名称',
price INT(11) DEFAULT 0 COMMENT '价格',
VERSION INT(11) DEFAULT 0 COMMENT '乐观锁版本号',
PRIMARY KEY (id)
)ENGINE=INNODB DEFAULT CHARSET=utf8;
2.引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.5.0</version>
</dependency>
3.配置多数据源
说明:注释掉之前的数据库连接,添加新配置
spring:
datasource:
dynamic:
#设置默认数据源或者数据源组,默认值即为master
primary: master
#严格匹配数据源,默认false. true表示未匹配到指定数据源时抛异常,false使用默认数据源
strict: false
datasource:
master:
url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
slave:
url: jdbc:mysql://localhost:3306/mybatis_plus2?characterEncoding=utf-8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 1234565
4.创建用户service
5.创建商品service
6.测试
结果:
都能成功获取对象,测试成功。
延伸:
如果想实现读写分离,将写操作方法加上主数据源,读操作方法上加上从数据源,自动切换,就能实现读写分离。
十.MyBatisX插件
Mybatis-Plus为我们提供了强大的mapper和service模板,能够大大地提高开发效率
但是在真正开发过程中,Mybatis-Plus并不能为我们解决所有问题,例如一些复杂地Sql,多表联查,我们就需要自己去编写代码和Sql语句。
我们如何快速解决这个问题呢?可以使用MyBatisX插件。
详细安装步骤和使用方法:
https://baomidou.com/pages/ba5b24/
MyBatisX的作用:根据我们数据库中的表,快速生成项目模板。
使用之前:新建一个项目,什么都没有。
使用之后:
1.安装MyBatisX插件
安装方法:打开 IDEA,进入 File -> Settings -> Plugins -> Browse Repositories,输入 mybatisx 搜索并安装。
2.使用MyBatisX插件快速创建模板
a>创建流程