[狂神说]Java学习完整路线https://www.bilibili.com/read/cv5702420
Mybatis-Plus插件使用
一、简介
是什么?Mybaits本来就是简化JDBC操作的
官网:https://baomidou.com/
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window) 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生
特性
-
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
-
损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
-
强大的 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
二、快速入门
配置环境
- 开发工具 IDEA
- JDK 1.8
- 数据库Mysql
使用第三方组件:
- 导入对应的依赖
- 研究依赖如何配置
- 代码如何编写
- 提高扩展技术能力
2.1 步骤
-
创建数据库myabtis-plus
-
创建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, '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');
- 编写项目,初始化项目,使用SpringBoot初始化,使用IDEA创建一个工程
- 导入依赖
<!--数据库驱动-->
<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.5.1</version>
</dependency>
尽量不要同时导入mybatis和mybatis-plus,版本差异
- 连接数据库,这一步和mybatis相同,这里的是application.properties文件内容
# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mssql 8 驱动不同 com.mysql.cj.jdbc.Driver 、需要增加时区 向下兼容 mysql 5
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSl=true
spring.datasource.username=root
spring.datasource.password=123456
- 传统方式pojo-dao(连接mybatis,配置mapper.xml)-service-controller
- 实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private long id;
private String name;
private Integer age;
private String email;
}
- 对应mapper接口
// 在对应的Mapper上面实现基本的接口BaseMapper<>
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作已经完成
// 不需要配置一大堆文件
}
- 注意需要在主启动类上去扫描mapper包下的所有接口
//扫描我们的mapper文件夹
@MapperScan("com.vinjcent.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
- 测试类中测试
@SpringBootTest
class MybatisPlusApplicationTests {
//继承了BaseMapper,所有的方法都来自父类,我们也可以编写自己的扩展方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//参数是一个Wrapper,条件构造器,我们这里先不用 null
//查询全部用户
List<User> users = userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
}
}
2.2 配置日志
我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以必须配置日志
在application.properties
中配置
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后,后面的学习就需要注意这个自动生产的SQL
三、CRUD扩展(所有操作都在SpringBoot项目中的测试类实现的)
3.1 插入操作(Insert)
@Test
public void testInsert(){
User user = new User();
user.setName("vincent");
user.setAge(21);
user.setEmail("123456#qqq");
int result = userMapper.insert(user);
System.out.println(result);
}
数据库插入的id默认值为:全局的唯一id
主键生成策略
默认ASSIGN_ID 全局唯一id,分布式系统唯一id生成
雪花算法
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0
主键自增
我们需要配置主键自增
- 实体类字段
@TableId(type = IdType.AUTO)
private long id;
- 数据库字段一定要是自增
再次测试插入即可
@TableId(type = IdType.AUTO)其余的源码解释
public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), //未设置主键
INPUT(2), //手动输入 一旦手动输入之后,就需要自己配置id了
ASSIGN_ID(3), //默认全局id
ASSIGN_UUID(4); //全局唯一id uuid
}
3.2 更新操作(Update)
//测试更新
@Test
public void testUpdate(){
User user = new User();
// 通过条件自动拼接动态sql
user.setName("vincent");
user.setId(1505067397213507585L);
user.setAge(100);
// user.setEmail("123456#qqq");
// 注意updateById 但是参数是一个对象
int i = userMapper.updateById(user);
System.out.println(i);
}
注意:所有的sql都是自动帮你动态配置的,不需要我们去手动写sql语句
3.3 自动填充
创建时间,修改时间,这些操作都是自动化完成的,我们不希望手动更新
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modify几乎所有的表都要配置上,而且需要自动化
方式一:数据库级别(工作中不允许修改数据库,不建议使用)
- 在表中新增字段create_time,update_time
- 再次测试插入方法,我们需要先把实体类的属性同步
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private long id;
private String name;
private Integer age;
private String email;
private Date createTime;
private Date updateTime;
}
再次更新查看结果即可(mybatis-plus中默认开启了驼峰命名的转换)
方式二:代码级别
- 删除数据库的默认值、更新操作
- 实体类的字段属性需要增加注解
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
- 编写处理器来处理这个注解即可
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 MyMateObjectHandler implements MetaObjectHandler {
// 插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
/**
default MetaObjectHandler
setFieldValByName(String fieldName, //属性字段名
Object fieldVal, //给属性字段赋值
MetaObject metaObject) //使用的元对象metaObject
*/
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
// 更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start insert fill ...."); // 输出消息
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
- 测试插入
- 测试更新、观察时间即可
3.4 乐观锁
面试过程,经常会被问到乐观锁,悲观锁(主要在多线程中使用)
乐观锁:它总认为不会出现问题,无论干什么都不会去上锁,如果出现了问题,再次更新值测试
悲观锁:它总是认为会出现问题,无论干什么都会上锁,再去操作
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时, set version =
newVersion
where version =oldVersion
- 如果version不对,就更新失败
假如有两个线程,同时修改一条记录
乐观锁:先查询 ,获得版本号version = 1
–A线程
update user set name = “…” ,
version = version + 1 where id = 2 and version = 1
–B线程 抢先完成,这个时候version = 2,会导致A修改失败(重点)
update user set name = “…” ,
version = version + 1 where id = 2 and version = 1
举例模拟多线程情况下
【思考】虽然这里是单线程执行,但是在多线程的执行下,我们两个线程同时拿的是不是都是一个对象?(是的)version是不是都是相同的?(是的)
因为查询的都是同一个记录,这就说明大家拿的version值都一样
测试一下Mybatis的乐观锁插件
- 给数据库中增加version字段
- 实体类加对应字段
@Version //乐观锁version注解
private Integer version;
- 注册组件
//扫描我们的mapper文件夹 这里扫描了mapper文件之后,在主启动类的注解可以去掉了
@MapperScan("com.vinjcent.mapper")
@EnableTransactionManagement
@Configuration //配置类
public class MybatisPlusConfig {
// 注册乐观锁插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//配置乐观锁拦截器
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
测试代码
//测试乐观锁失败
@Test
public void testMybatisPlusInterceptor2(){
// 线程1
User user1 = userMapper.selectById(1L);
user1.setName("vincent11111");
user1.setEmail("123456@qq.com");
// 模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user2.setName("vincent22222");
user2.setEmail("123456@qq.com");
// 执行更新
userMapper.updateById(user2);
// 自旋锁来多次尝试提交
userMapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值
}
大概的视图
3.5 查询操作(Select)
// 测试查询
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
// 测试批量查询
@Test
public void testselectBatchIds(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1,2,3));
for (User user : users) {
System.out.println(user);
}
}
// 条件查询之一 map
@Test
public void testselectByMap(){
Map<String,Object> map = new HashMap<String,Object>();
//自定义要查询 类似于我们Mybatis中的动态SQL查询
map.put("name","vincent");
map.put("age",21);
List<User> users = userMapper.selectByMap(map);
for (User user : users) {
System.out.println(user);
}
}
3.6 分页查询
方法
- 原始的limit进行分页
- pageHelper第三方插件
- Mybatis其实也内置了分页插件
如何使用
- 配置拦截器组件即可
在我们刚刚那个MybatisPlusConfig 类中注入PaginationInnerInterceptor这个bean
@MapperScan("com.vinjcent.mapper")
@EnableTransactionManagement
@Configuration //配置类
public class MybatisPlusConfig {
// 注册乐观锁插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//配置乐观锁拦截器
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//配置分页拦截器
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
测试
// 测试分页查询
@Test
public void testPage(){
// 参数一: 当前页
// 参数二: 页面大小
// 使用了分页插件之后,所有的分页操作变得简单
Page<User> page = new Page<>(2,5);
Page<User> userPage = userMapper.selectPage(page, null);
for (User user : userPage.getRecords()) {
System.out.println(user);
}
System.out.println(userPage.getTotal());
}
3.7 删除操作(Delete)
基本删除操作
// 测试删除
@Test
public void testDeleteById(){
int i = userMapper.deleteById(1505067397213507593L);
}
// 批量删除
@Test
public void testDeleteBatchIds(){
int i = userMapper.deleteBatchIds(Arrays.asList(1505067397213507590L,1505067397213507591L,1505067397213507592L));
}
// 通过map删除
@Test
public void testDeleteByMap(){
Map<String,Object> map =new HashMap<String,Object>();
map.put("name","vincent");
int i = userMapper.deleteByMap(map);
}
删除两大类
物理删除:从数据库中直接移除
逻辑删除:在数据库中没有被移除,而是通过一个变量来让他失效
deleted = 0 ====> deleted = 1
管理员可以查看被删除的记录!防止数据的丢失,类似于回收站
测试
- 在数据库表中增加一个deleted字段
- 在实体类中增加属性
@TableLogic //逻辑删除
private Integer deleted;
- 配置applicaition.properties
# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤1)
mybatis-plus.global-config.db-config.logic-delete-field=deleted
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0
进行删除操作
记录依旧在数据库,但是值却已经变化了
我们再随便查询一次记录
可以看到再查询的后面添加了一个deleted = 0 的条件判断
三、性能分析插件
平常的开发中,会遇到一些慢sql
作用:性能分析拦截器,用于输出每条SQL语句及其执行时间
Mybatis-Plus也提供了性能分析插件,如果超过了这个时间就停止运行
- 导入jar包
<!--性能分析插件-->
<!--p6spy-->
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.9.1</version>
</dependency>
- 配置文件application.properties(完整版)
这里使用p9spy包下的类,需要修改driver-class-name
和url
# 数据库连接配置
# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mssql 8 驱动不同 com.mysql.cj.jdbc.Driver 、需要增加时区 向下兼容 mysql 5
#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSl=true
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSl=true
spring.datasource.username=root
spring.datasource.password=123456
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
# 配置逻辑删除
# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤1)
mybatis-plus.global-config.db-config.logic-delete-field=deleted
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0
- 创建一个syp.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.p6spy.engine.spy.appender.CustomLineFormat
customLogMessageFormat=%(currentTime) \n SQL耗时: %(executionTime) ms \n 连接信息: %(category)-%(connectionId) \n 执行语句: %(sql)
# 日志输出到控制台
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 and resultset are valid values
# (默认 info,debug,result,resultset,batch)
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2
# 真实JDBC driver
driverlist=com.mysql.cj.jdbc.Driver
- 测试使用
// 测试删除
@Test
public void testDeleteById(){
int i = userMapper.deleteById(3L);
}
使用性能插件,可以帮我们提高效率
四、条件构造器
十分重要:Wapper
复杂的SQL语句就可以使用它来替代
测试一(多条件查询)
@Test
void test01() {
// 查询name不为空的用户,并且邮箱不为空的,年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age",12);
List<User> users = userMapper.selectList(wrapper);//
for (User user : users) {
System.out.println(user);
}
}
测试二(单条件查询)
@Test
void test02() {
// 查询姓名vincent
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","vincent");
User user = userMapper.selectOne(wrapper); // 查询一个数据,出现多个结果使用List 或者 map
System.out.println(user);
}
测试三(between)
@Test
void test03() {
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30); //区间
Long count = userMapper.selectCount(wrapper); //数量
List<User> count = userMapper.selectList(wrapper); //用户
System.out.println(count);
}
测试四(模糊查询)
@Test
void test04() {
// 模糊查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 %e e%
wrapper.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
for (Map<String, Object> map : maps) {
System.out.println(map);
}
}
测试五(嵌套sql)
@Test
void test05() {
// 模糊查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 %e e%
wrapper.notLike("name","e")
.likeRight("email","t");
wrapper.inSql("id","select id from user where id > 3");
List<User> maps = userMapper.selectList(wrapper);
for (User map : maps) {
System.out.println(map);
}
}
测试六(升序降序)
@Test
void test05() {
//
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序 降序(orderByDesc) 升序(orderByAsc)
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
for (User user : users) {
System.out.println(user);
}
}