MyBatis-Plus
入门
简介
MyBatis-Plus(简称 MP)是一个MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
配置日志
没有配置日志,sql操作是不可见的,但我们需要了解sql语句的具体执行情况,在上线的系统中,则需要关闭日志,因为运行日志需要资源;
#基础的控制台日志,不需要导入依赖文件
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
insert语句
在没有setId时会自动生成id主键,同时自动生成的id还会回填到user对象中,那么,是怎么生成的id的呢?mybatis-plus中默认使用的是雪花算法
User user = new User();
user.setName("sudazhou");
user.setAge(18);
user.setEmail("2136632191@qq.com");
int insert = userMapper.insert(user); //在没有setId时会自动生成id
System.out.println(insert);
System.out.println(user.toString()); //自动生成的id还会回填到user对象中
update语句
在BaseMapper类中,update方法可以实现动态sql,根据传入对象的属性值判断生成适合的sql语句并执行;
User user = new User();
user.setId(3L); //要修改的id值
user.setName("sudazhou"); //要修改的属性值
int i = userMapper.updateById(user); //通过id进行update,参数是一个泛型对象
System.out.println(i);
delete语句
int i = userMapper.deleteById(1529156784161386498L);
int i1 = userMapper.deleteBatchIds(Arrays.asList(1529156512655683586L, 1529156186200449025L, 1529156046739861506L));
HashMap<String, Object> map = new HashMap<>();
map.put("name","sudazhou");
//DELETE FROM user WHERE name = ?
int i2 = userMapper.deleteByMap(map);
System.out.println(i+i1+i2);
select语句
/*
简单查询
*/
User user = userMapper.selectById(1L);
System.out.println(user);
/* SELECT id,name,age,email,gmt_create,gmt_update,version FROM user WHERE id IN ( ? , ? , ? , ? , ? )
*/
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3, 4, 5));
users.forEach(System.out::println);
/*
条件查询
*/
HashMap<String, Object> map = new HashMap<>();
map.put("name","sudazhou");
map.put("id","1529143341349978114");
/*
SELECT id,name,age,email,gmt_create,gmt_update,version FROM user WHERE name = ? AND id = ?
*/
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
CRUD扩展
主键唯一与雪花算法
雪花算法是一个开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个为数据中心,5个为机器ID),12bit作为毫秒内的流水号(意味着每一个节点在每毫秒内可以产生4096个ID),最后有一个符号位保持为0;
在MP中可以使用注解@TableId
设置主键自动生成的策略,使用IdType
属性进行设置,IdType
是一个枚举类:
NONE
数据表未设置主键;AUTO
主键自增,注意:设置auto时,数据库的主键也需要设置为自增;INPUT
即手动输入主键;ASSIGN_ID
全局唯一id,即雪花算法自动生成Long类型的唯一id;ASSIGN_UUID
全局唯一uuid;
自动填充
在实际开发中,每一个数据库表都需要创建时间和修改时间两个属性,我们需要做到对于这个两个属性实现自动生成,不需要手动更新!那么是怎么样实现的呢?
-
数据库级别(实际上不使用)
修改数据库的表结构如下:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xjSToEqZ-1653553307479)(D:\Dazhou\Desktop\data\gmt.png)]
-
代码级别
1.使用注解
TableField
的属性值fill
实现字段的自动填充,枚举类FieldFill
有四个属性:DEFAULT
:默认,即没有操作INSERT
:在执行insert语句时进行自动填充UPDATE
:在执行update语句时进行自动填充INSERT_UPDATE
:在执行insert或update语句时进行自动填充
2.自定义处理类,需要实现
MetaObjectHandler
接口
@TableField(fill = FieldFill.INSERT)
private Date gmt_create;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmt_update;
//自动填充
FieldFill fill() default FieldFill.DEFAULT;
//FieldFill中的四个属性
DEFAULT,
INSERT,
UPDATE,
INSERT_UPDATE;
//自定义处理类
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insertFill ...");
this.setFieldValByName("gmt_create",new Date(),metaObject);
this.setFieldValByName("gmt_update",new Date(),metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start updateFill ...");
this.setFieldValByName("gmt_update",new Date(),metaObject);
}
}
乐观锁机制
什么是乐观锁?乐观锁是指,在并发的过程中,乐观锁会认为不会出现并发问题,所以不去加锁,但一旦出现了问题,即当前访问的属性被修改了,就会去重新读执行更新操作;在mysql中,尝试用version来标注当前属性是否被修改了,来解决ABA问题,version规定了只加不减;
MP实现乐观锁
1.在mysql数据库表中增加一个列version,默认值为1(int)
2.在springboot实体类entity中添加一个属性version,并使用注解@Version
标注
3.在springboot中配置MP乐观锁插件,在MP中使用插件实现乐观锁:
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
4.MP乐观锁测试
//线程2
User user = userMapper.selectById(1L);
user.setName("dadada");
user.setEmail("dadwa@dada.com");
//线程2
User user1 = userMapper.selectById(1L);
user1.setName("adadad");
user1.setEmail("ewewe@ada.com");
System.out.println(userMapper.updateById(user1)); //成功
System.out.println(userMapper.updateById(user)); //失败
#单线程
#在执行更新操作时,会检查version的值是否正确,同时还会将version+1;
==> Preparing:
UPDATE user SET name=?, age=?, email=?, gmt_update=?, version=? WHERE id=? AND version=?
==> Parameters:
dadada(String), 18(Integer), dadwa@dada.com(String), 2022-05-25 03:26:19.656(Timestamp), 2(Integer), 1(Long), 1(Integer)
#模拟多线程
#线程1
==> Preparing:
UPDATE user SET name=?, age=?, email=?, gmt_update=?, version=? WHERE id=? AND version=?
==> Parameters:
adadad(String), 18(Integer), ewewe@ada.com(String), 2022-05-25 03:33:23.379(Timestamp), 3(Integer), 1(Long), 2(Integer)
#线程2
==> Preparing:
UPDATE user SET name=?, age=?, email=?, gmt_update=?, version=? WHERE id=? AND version=?
==> Parameters:
dadada(String), 18(Integer), dadwa@dada.com(String), 2022-05-25 03:33:23.391(Timestamp), 3(Integer), 1(Long), 2(Integer)
分页插件
在MP中有专门的分页插件来实现分页查询,操作简单方便!首先在官网找到插件,并传入springboot中:
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//分页插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
Page<User> page = new Page<>(2,5);
Page<User> userPage = userMapper.selectPage(page, null);
/*
SELECT id,name,age,email,gmt_create,gmt_update,version FROM user LIMIT ?,?
*/
userPage.getRecords().forEach(System.out::println);
//SELECT COUNT(*) AS total FROM user
System.out.println(userPage.getTotal()); //总页数
逻辑删除
与物理删除delete不同,物理删除是从数据库中直接删除;逻辑删除是指,数据库中并没有删除,而是通过一个变量来让他失效,让其他操作无法操作到该数据;实际应用中,比如,回收站,管理员查看高权限数据等
逻辑删除实现方法
1.在数据库中新增一个变量deleted ;
2.在实体类中新增属性deleted,并用注解@TableLogic
标注;
3.在yml文件或properties文件中进行配置:
logic-delete-value
指定已被逻辑删除的val;logic-not-delete-value
指定还未被逻辑删除的val;
#mybatis-plus.global-config.db-config.logic-delete-field=deleted 可以使用注解@TableLogic代替
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4.逻辑删除测试
/*
UPDATE user SET deleted=1 WHERE id=? AND deleted=0
可以发现,在执行删除命令的时,不会真的执行delete操作,而是执行update操作,将set变量deleted=1
*/
int i = userMapper.deleteById(1L);
/*
SELECT id,name,age,email,gmt_create,gmt_update,version,deleted FROM user WHERE id=?
AND deleted=0
*/
User user = userMapper.selectById(1L);
System.out.println(user); //返回null
性能分析插件
1.导入依赖
<!--MP性能分析依赖-->
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.9.1</version>
</dependency>
2.导入配置文件
#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记录标准 1 秒
outagedetectioninterval=1
3.修改springboot配置文件
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.url=jdbc:p6spy:mysql://localhost:3306
4.测试sql分析插件
#sql的执行时间
Consume Time:8 ms 2022-05-25 23:15:10
Execute SQL:SELECT id,name,age,email,gmt_create,gmt_update,version,deleted FROM user WHERE id=1 AND deleted=0
条件构造器
子查询
insql
notinsql
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id<=4");
userMapper.selectList(wrapper).forEach(System.out::println);
嵌套
and
and嵌套or
or嵌套nested
正常的嵌套
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
/*
SELECT id,name,age,email,gmt_create,gmt_update,version,deleted FROM user
WHERE deleted=0 AND (age >= ? AND (id IN (?,?,?,?,?)))
*/
queryWrapper.ge("age",18).and(wrapper -> wrapper.in("id",1,2,3,4,5));
userMapper.selectList(queryWrapper).forEach(System.out::println);
其余两种嵌套方法都与and嵌套使用相似
拼接sql
apply
该方法可用于数据库函数 动态入参的params
对应前面applySql
内部的{index}
部分.这样是不会有sql注入风险的,反之会有!last
无视优化规则直接拼接到 sql 的最后,只能调用一次,多次调用以最后一次为准 有sql注入的风险,请谨慎使用exists
notexists
queryWrapper
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
/*
SELECT id,name,age,email,gmt_create,gmt_update,version,deleted FROM user
WHERE deleted=0 AND (email IS NULL AND age >= 10)
*/
queryWrapper
.isNull("email")
.ge("age",10);
userMapper.selectList(queryWrapper).forEach(System.out::println);
LambdaQueryWrapper
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.eq(User::getName,"sudazhou");
List<User> users = userMapper.selectList(lambdaQueryWrapper);
users.forEach(System.out::println);
LambdaQueryChainWrapper
// SELECT id,name,age,email,gmt_create,gmt_update,version,deleted FROM user WHERE deleted=0 AND (age >= ?)
new LambdaQueryChainWrapper<>(userMapper)
.ge(User::getAge, 10).list()
.forEach(System.out::println);