一、MyBatis-Plus简介
1、简介
- MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上
只做增强不做改变
,为
简化开发、提高效率而生。
.
.
2、特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
.
.
3、支持数据库
任何能使用MyBatis进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下
- MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb
- 达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库
.
.
4、框架结构
.
.
5、代码及文档地址
- 官方地址:
http://mp.baomidou.com
- 代码发布地址:
Github:https://github.com/baomidou/mybatis-plus
Gitee:https://gitee.com/baomidou/mybatis-plus
文档发布地址:https://baomidou.com/pages/24112f
.
.
.
二、入门案例
MyBatis-Plus官方推荐使用Spring Boot,在此我们以Spring整合MyBatis为基础,再加入MyBatis-plus。
但该学习阶段不使用Spring boot
1、开发环境
- IDE:idea 2019.2
- JDK:JDK8+
- 构建工具:maven 3.5.4
- MySQL版本:MySQL 5.7
- Spring:5.3.1
- MyBatis-Plus:3.4.3.4
.
.
2、创建数据库及表
- a>创建表
.
- b>添加数据
.
.
3、创建maven工程
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<!-- 连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.8</version>
</dependency>
<!-- junit测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!-- MySQL驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<!-- lombok用来简化实体类 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.16</version>
</dependency>
<!--MyBatis-Plus的核心依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>3.4.3.4</version>
</dependency>
</dependencies>
.
.
4、Spring整合MyBatis
- a>创建实体
.
- b>创建Spring的配置文件
MybatisSqlSessionFactoryBean是在SqlSessionFactoryBean的基础上进行了增强即具有SqlSessionFactoryBean的基础功能,又具有MyBatis-Plus的扩展配置具体配置信息地址:
https://baomidou.com/pages/56bac0/#%E5%9F%BA%E6%9C%AC%E9% 85%8D%E7%BD%AE
- c>创建mapper接口
BaseMapper是MyBatis-Plus提供的基础mapper接口
,泛型为所操作的实体类型,其中包含CRUD的各个方法,我们的mapper继承了BaseMapper之后,就可以直接使用BaseMapper所提供的各种方法
,而不需要编写映射文件以及SQL语句,大大的提高了开发效率
- d>测试
.
.
5、总结
- 在Spring整合MyBatis中加入了MyBatis-Plus后,我们就可以使用MyBatis-Plus所提供的
BaseMapper
实现CRUD,并不需要编写映射文件以及SQL语句 - 但是若要自定义SQL语句,
仍然可以编写映射文件而不造成任何影响
- 因为MyBatis-Plus只做增强,而不做改变
.
.
.
三、基本CRUD
1、插入
.
.
2、删除
- a>通过id删除记录
- b>通过id批量删除记录
- c>通过map条件删除记录
.
.
3、修改
.
.
4、查询
- a>根据id查询用户信息
- b>根据多个id查询多个用户信息
- c>通过map条件查询用户信息
- d>查询所有数据
.
.
6、通用Service
-
a>
IService接口
和ServiceImpl实现类
MyBatis-Plus中有一个接口IService和其实现类 ServiceImpl
,封装了常见的业务层逻辑。 -
b>创建Service接口和实现类
.
.
6.1、通用Service中的方法(更多详情查看官方文档
)
- 添加:
- 添加或修改:(
根据id判断如果存在修改,不存在添加
)
- 删除:
- 修改:
- 查询单条记录
- 查询多条记录
- 分页查询
- 查询条数
- 链式
.
.
四、Wrapper(条件构造器)
1、Wrapper的继承关系:
.
.
2、常用条件
【比较大小: ( =, <>, >, >=, <, <= )】
范围:(between、not between、in、not in)】
between(R column, Object val1, Object val2); // 等价于 between a and b, 例: between("age", 18, 30) ---> age between 18 and 30
notBetween(R column, Object val1, Object val2); // 等价于 not between a and b, 例: notBetween("age", 18, 30) ---> age not between 18 and 30
in(R column, Object... values); // 等价于 字段 IN (v0, v1, ...),例: in("age",{1,2,3}) ---> age in (1,2,3)
notIn(R column, Object... values); // 等价于 字段 NOT IN (v0, v1, ...), 例: notIn("age",{1,2,3}) ---> age not in (1,2,3)
inSql(R column, Object... values); // 等价于 字段 IN (sql 语句), 例: inSql("id", "select id from table where id < 3") ---> id in (select id from table where id < 3)
notInSql(R column, Object... values); // 等价于 字段 NOT IN (sql 语句)
【模糊匹配:(like)】
like(R column, Object val); // 等价于 LIKE '%值%',例: like("name", "王") ---> name like '%王%'
notLike(R column, Object val); // 等价于 NOT LIKE '%值%',例: notLike("name", "王") ---> name not like '%王%'
likeLeft(R column, Object val); // 等价于 LIKE '%值',例: likeLeft("name", "王") ---> name like '%王'
likeRight(R column, Object val); // 等价于 LIKE '值%',例: likeRight("name", "王") ---> name like '王%'
【空值比较:(isNull、isNotNull)】
【分组、排序:(group、having、order)】
groupBy(R... columns); // 等价于 GROUP BY 字段, ..., 例: groupBy("id", "name") ---> group by id,name
orderByAsc(R... columns); // 等价于 ORDER BY 字段, ... ASC, 例: orderByAsc("id", "name") ---> order by id ASC,name ASC
orderByDesc(R... columns); // 等价于 ORDER BY 字段, ... DESC, 例: orderByDesc("id", "name") ---> order by id DESC,name DESC
having(String sqlHaving, Object... params); // 等价于 HAVING ( sql语句 ), 例: having("sum(age) > {0}", 11) ---> having sum(age) > 11
【拼接、嵌套 sql:(or、and、nested、apply)】
or(); // 等价于 a or b, 例:eq("id",1).or().eq("name","老王") ---> id = 1 or name = '老王'
or(Consumer<Param> consumer); // 等价于 or(a or/and b),or 嵌套。例: or(i -> i.eq("name", "李白").ne("status", "活着")) ---> or (name = '李白' and status <> '活着')
and(Consumer<Param> consumer); // 等价于 and(a or/and b),and 嵌套。例: and(i -> i.eq("name", "李白").ne("status", "活着")) ---> and (name = '李白' and status <> '活着')
nested(Consumer<Param> consumer); // 等价于 (a or/and b),普通嵌套。例: nested(i -> i.eq("name", "李白").ne("status", "活着")) ---> (name = '李白' and status <> '活着')
apply(String applySql, Object... params); // 拼接sql(若不使用 params 参数,可能存在 sql 注入),例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08") ---> date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
last(String lastSql); // 无视优化规则直接拼接到 sql 的最后,可能存若在 sql 注入。
exists(String existsSql); // 拼接 exists 语句。例: exists("select id from table where age = 1") ---> exists (select id from table where age = 1)
【QueryWrapper 条件:】
select(String... sqlSelect); // 用于定义需要返回的字段。例: select("id", "name", "age") ---> select id, name, age
select(Predicate<TableFieldInfo> predicate); // Lambda 表达式,过滤需要的字段。
lambda(); // 返回一个 LambdaQueryWrapper
【UpdateWrapper 条件:】
set(String column, Object val); // 用于设置 set 字段值。例: set("name", null) ---> set name = null
setSql(String sql); // 用于设置 set 字段值。例: setSql("name = '老李头'") ---> set name = '老李头'
lambda(); // 返回一个 LambdaUpdateWrapper
.
.
3、 QueryWrapper
-
例1:组装查询条件
-
例2:组装排序条件
-
例3:组装删除条件
-
例4:条件的优先级
-
例5:组装select子句
-
例6:实现子查询
.
.
4、UpdateWrapper
基本语法:
用法:
解析:
.
.
5、condition
在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因此我们在组装这些条件时,
必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若没有选择则一定不能组装
,以免影响SQL执行的结果
.
.
6、LambdaQueryWrapper
主要使用
Lambda 表达式(SFunction<T, ?>)代替原来参数中表示 表中的列 的字符串
,避免写错
.
.
7、LambdaUpdateWrapper
主要使用
Lambda 表达式(SFunction<T, ?>)代替原来参数中表示 表中的列 的字符串(String column)
,避免写错
.
.
.
五、常用注解
1、@TableName
- MyBatis-Plus在确定操作的表时,由
BaseMapper的泛型决定
,即实体类型决定,且默认操作的表名和实体类型的类名一致
.
a>@TableName
- @TableName 可以解决
表名与实体类名不一致问题
- 在实体类
类型上添加@TableName("t_user"),标识实体类对应的表
,即可成功执行SQL语句
.
b> 配置GlobalConfig
- 可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名**
设置默认的前缀
**,那么就不需要在每个实体类上通过@TableName标识实体类对应的表
.
.
2、@TableId
a> @TableId
- 通过给属性添加 @TableId 注解 则
将其属性标识为主键
.
b>@TableId的value属性
- 通过@TableId注解的value属性,指定表中的主键字段(
解决表中字段名与类中属性名不一致问题
) 写法:
@TableId(“uid”)
@TableId(value=“uid”)
.
c>@TableId的type属性
- type属性用来定义主键策略
- 配置全局主键策略:
.
d>雪花算法
百度
:了解
.
.
3、@TableField
-
@TableField
解决实体类中的属性名和表中的字段名不一致问题
-
a>情况1
-
b>情况2
.
.
4、@TableLogic
a>逻辑删除
.
b>实现逻辑删除
-
第一步:
数据库中创建逻辑删除状态列
,设置默认值为0
-
第二步:
实体类中添加逻辑删除属性
-
第三步:测试
.
.
.
六、插件
1、分页插件
-
MyBatis Plus
自带分页插件,只要简单的配置即可实现分页功能
-
a>添加配置
-
b>测试
.
.
2、xml自定义分页
- a>UserMapper中定义接口方法
- b>UserMapper.xml中编写SQL
- c>测试
.
.
3、乐观锁
① 简介
-
a>场景
-
b>乐观锁与悲观锁
.
② 操作
-
a>乐观锁实现流程
-
b>Mybatis-Plus实现乐观锁
-
c>添加乐观锁插件配置
-
测试
.
.
.
七、通用枚举
-
表中的有些
字段值是固定的
,例如性别(男或女),此时我们可以使用MyBatis-Plus的通用枚举
来实现 -
a>数据库表添加字段sex
-
b>创建通用枚举类型
@EnumValue 注解:设置存入数据库中的值
-
c>配置扫描通用枚举
.
.
.
八、代码生成器
1、引入依赖
.
.
2、快速生成
public class FastAutoGeneratorTest {
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis_plus",
"root", "123456")
.globalConfig(builder -> {
builder.author("atguigu") // 设置作者
//.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("D://mybatis_plus"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com.atguigu") // 设置父包名
.moduleName("mybatisplus") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://mybatis_plus"));
// 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("t_user") // 设置需要生成的表名
.addTablePrefix("t_", "c_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker
引擎模板,默认的是Velocity引擎模板
.execute();
}
}
.
.
.
九、MyBatisX插件
MyBatis-Plus为我们提供了强大的mapper和service模板,能够大大的提高开发效率但是在真正开发过程中,MyBatis-Plus并不能为我们解决所有问题,
例如一些复杂的SQL,多表联查,我们就需要自己去编写代码和SQL语句,我们该如何快速的解决这个问题呢,这个时候可以使用MyBatisX插件。
MyBatisX一款基于 IDEA 的快速开发插件,为效率而生。
- MyBatisX插件用法:
https://baomidou.com/pages/ba5b24/