一)简介
01-简介
官网:http://mp.baomidou.com/
参考教程:http://mp.baomidou.com/guide/
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
02-特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD
- 操作,更有强大的条件构造器,满足各类使用需求 支持 Lambda 形式调用:通过 Lambda
- 表达式,方便的编写各类查询条件,无需再担心字段写错 支持多种数据库:支持
- MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer
- 等多种数据库 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
- 支持 XML 热加载:Mapper 对应的 XML 支持热加载,对于简单的 CRUD 操作,甚至可以无 XML 启动 支持
- ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )- 支持关键词自动转义:支持数据库关键词(order、key…)自动转义,还可自定义关键词 内置代码生成器:采用代码或者 Maven
- 插件可快速生成 Mapper 、 Model 、 Service 、 Controller
- 层代码,支持模板引擎,更有超多自定义配置等您来使用 内置分页插件:基于 MyBatis
- 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询 内置性能分析插件:可输出 Sql
- 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询 内置全局拦截插件:提供全表 delete 、 update
- 操作智能分析阻断,也可自定义拦截规则,预防误操作 内置 Sql 注入剥离器:支持 Sql 注入剥离,有效预防 Sql 注入攻击
二、入门
01-创建并初始化数据库
1、创建数据库:
mybatis_plus
2、创建 User 表
其对应的数据库 Schema 脚本如下:
其对应的数据库 Data 脚本如下:
02-初始化工程
使用 Spring Initializr 快速初始化一个 Spring Boot 工程
Group:com.atguigu
Artifact:mybatis_plus
版本:2.0.7.RELEASE
03-添加依赖
1、引入依赖
spring-boot-starter、spring-boot-starter-test
添加:mybatis-plus-boot-starter、MySQL、lombok、
在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写
注意:引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring,以避免因版本差异导致的问题。
2、idea中安装lombok插件
04-配置
在 application.properties 配置文件中添加 MySQL 数据库的相关配置:
mysql5
mysql8以上(spring boot 2.1)
注意:driver和url的变化
注意:
1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀,因为Spring Boot 2.1 集成了8.0版本的jdbc驱动,这个版本的 jdbc 驱动需要添加这个后缀,否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or represents more
2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ,在 jdbc 8 中 建议使用这个驱动之前的com.mysql.jdbc.Driver 已经被废弃,否则运行测试用例的时候会有 WARN 信息
05-编写代码
1、主类
在 Spring Boot 启动类中添加 @MapperScan 注解,扫描 Mapper 文件夹
注意:扫描的包名根据实际情况修改
2、实体
创建包 entity 编写实体类 User.java(此处使用了 Lombok 简化代码)
Lombok使用参考:
https://blog.csdn.net/motui/article/details/79012846
3、mapper
创建包 mapper 编写Mapper 接口: UserMapper.java
06-开始使用
添加测试类,进行功能测试:
注意:
IDEA在 userMapper 处报错,因为找不到注入的对象,因为类是动态创建的,但是程序可以正确的执行。
为了避免报错,可以在 dao 层 的接口上添加 @Repository 注
控制台输出:
07-配置日志
查看sql输出日志
三)CRUD 接口
一、insert
1、插入操作
2、主键策略
(1)ID_WORKER
MyBatis-Plus默认的主键策略是:ID_WORKER 全局唯一ID
参考资料:分布式系统唯一ID生成方案汇总:https://www.cnblogs.com/haoxinyue/p/5208136.html
(2)自增策略
要想主键自增需要配置如下主键策略
需要在创建数据表的时候设置主键自增
实体字段中配置 @TableId(type = IdType.AUTO)
@TableId(type = IdType.AUTO)
要想影响所有实体的配置,可以设置全局主键配置
其它主键策略:分析 IdType 源码可知
02-update
1、根据Id更新操作
注意:update时生成的sql自动是动态
sql:UPDATE user SET age=? WHERE id=?
2、自动填充
项目中经常会遇到一些数据,每次都使用相同的方式填充,例如记录的创建时间,更新时间等。
我们可以使用MyBatis Plus的自动填充功能,完成这些字段的赋值工作:
数据库表中添加自动填充字段
在User表中添加datetime类型的新的字段 create_time、update_time
自动填充方案一、数据级别的自动填充,分别设置默认值:
自动填充方案二、业务层处理:
(1)实体上增加字段并添加注解
(2)实现元对象处理器接口
注意:不要忘记添加 @Component 注解
3、乐观锁
主要适用场景:当要更新一条记录的时候,希望这条记录没有被别人更新,也就是说实现线程安全的数据更新
乐观锁实现方式:
取出记录时,获取当前version:假设取出的version=1
更新时,带上这个version
执行更新时, set version = newVersion where version = oldVersion
如果version不对,就更新失败
(1)数据库中添加version字段
2)实体类添加version字段
并添加 @Version 注解
特别说明:
- 支持的数据类型只有int,Integer,long,Long,Date,Timestamp,LocalDateTime
- 整数类型下newVersion = oldVersion + 1
- newVersion 会回写到 entity 中
- 仅支持updateById(id) 与 update(entity, wrapper) 方法
- 在 update(entity, wrapper)方法下, wrapper 不能复用!!!
(3)创建配置文件
创建包config,创建文件MybatisPlusConfig.java
此时可以删除主类中的 @MapperScan 扫描注解
(4)在 MybatisPlusConfig 中注册 Bean
(5)测试乐观锁可以修改成功
测试后分析打印的sql语句,将version的数值进行了加1操作
(5)测试乐观锁修改失败
03-select
1、根据id查询记录
2、通过多个id批量查询
完成了动态sql的foreach的功能
3、简单的条件查询
通过map封装查询条件
注意:map中的key对应数据库中的列名。如:数据库user_id,实体类是userId,这时map的key需要填写user_id
4、分页
MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能
(1)配置类中添加分页插件
(2)测试selectPage分页
测试:最终通过page对象获取相关数据
控制台sql语句打印:SELECT id,name,age,email,create_time,update_time FROM user LIMIT 0,5
(3)测试selectMapsPage分页:结果集是Map
04-delete
1、根据id删除记录
2、批量删除
3、简单的条件查询删除
4、逻辑删除
物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除数据
逻辑删除:假删除,将对应数据中代表是否被删除字段状态修改为“被删除状态”,之后在数据库中仍旧能看到此条数据记录
(1)数据库中添加 deleted字段
(2)实体类添加deleted 字段
并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解
(3)application.properties 加入配置
此为默认值,如果你的默认值和mp默认的一样,该配置可无
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
(4)在 MybatisPlusConfig 中注册 Bean
(5)测试逻辑删除
测试后发现,数据并没有被删除,deleted字段的值由0变成了1
测试后分析打印的sql语句,是一条update
注意:被删除数据的deleted 字段的值必须是 0,才能被选取出来执行逻辑删除的操作
(7)测试逻辑删除后的查询
MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断
测试后分析打印的sql语句,包含 WHERE deleted=0
05-性能分析
性能分析拦截器,用于输出每条 SQL 语句及其执行时间
SQL 性能执行分析,开发环境使用,超过指定时间,停止运行。有助于发现问题
1、配置插件
(1)参数说明
参数:maxTime: SQL 执行最大时长,超过自动停止运行,有助于发现问题。
参数:format: SQL是否格式化,默认false。
(2)在 MybatisPlusConfig 中配置
(3)Spring Boot 中设置dev环境
#环境设置:dev、test、prod
可以针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties
也可以自定义环境名称:如test1、test2
2、测试
(1)常规测试
输出:
(2)将maxTime 改小之后再次进行测试
如果执行时间过长,则抛出异常:The SQL execution time is too large,
输出:
六、其它
如果想进行复杂条件查询,那么需要使用条件构造器 Wapper,涉及到如下方法
1、delete
2、selectOne
3、selectCount
4、selectList
5、selectMaps
6、selectObjs
7、update
四)例子
1依赖
我忘记具体是哪些依赖,我将我以前写的笔记的依赖全拿过来了
02-代码生成器
03-MyBatisPlus配置
03-实体类
服务
控制层
main