用于记录自己的学习,欢迎大家提出建议和纠错
MybatisPlus
快速入门
用MybatisPlus的starter代替Mybatis的starter
1.引入依赖
<!--MybatisPlus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.3.1</version>
</dependency>
定义Mapper
自定义的Mapper继承MybatisPlus提供的BaseMapper接口
public interface UserMapper extends BaseMapper<User> {
}
BaseMapper中有很多定义好的方法,直接调用就行,提高效率
注意泛型需要与实体类相同
不用写xml,mapper方法
自动实现增删改查的基本原理
MyBatisPlus通过扫描实体类,并基于反射获取实体类信息作为数据库表信息。
泛型指定实体类,通过反射获取实体类字节码,通过字节码获取实体类信息
约定大于配置
- 类名驼峰转下划线作为表名
- 名为id的字段作为主键
- 变量名驼峰转下划线作为表的字段名
不符合约定要自己定义表名,主键名
常见注解
表一定要有主键,否则会报错
MybatisPlus中比较常用的几个注解如下:
- @TableName:用来指定表名
- @TableId:用来指定表中的主键字段信息
- @TableField:用来指定表中的普通字段信息
@TableName("tb_user")
public class User {
@TableId(value=”id”, type=IdType.AUTO)
private Long id;
@TableField("is_married")
private Boolean isMarried;
@TableField("`order`")
private Integer order;
@TableField(exist = false)
private String address;
}
IdType枚举:
- AUTO:数据库自增长(数据库)
- INPUT:通过set方法自行输入(自己手动)
- ASSIGN_ID:分配 ID,接口IdentifierGenerator的方法nextId来生成id,默认实现类为DefaultIdentifierGenerator雪花算法(Long型20位整数,mp)
使用@TableField的常见场景:
- 成员变量名与数据库字段名不一致
- 成员变量名以is开头,且是布尔值(is去掉后作为字段名)
- 成员变量名与数据库关键字冲突(order->order by,加单引号作为转义字符)
- 成员变量不是数据库字段(exist=false标记不存在)
常见配置
mybatis-plus:
type-aliases-package: com.itheima.mp.domain.po # 别名扫描包
mapper-locations: "classpath*:/mapper/**/*.xml" # Mapper.xml文件地址,默认值
configuration:
map-underscore-to-camel-case: true # 是否开启下划线和驼峰的映射
cache-enabled: false # 是否开启二级缓存
global-config:
db-config:
id-type: assign_id # id为雪花算法生成
update-strategy: not_null # 更新策略:只更新非空字段
具体可参考官方文档:使用配置 | MyBatis-Plus (baomidou.com)
基本只需要配置别名扫描包
核心功能
条件构造器
QueryWrapper
案例1:查询名字带o,存款大于等于1000
构建QueryWrapper,支持链式编程,注意指定泛型,ge是大于等于
使用selectList方法
案例2:更新jack的余额为2000(基于QW更新,值是固定的)
构建对象设置更新字段,构建wrapper,eq精确匹配字段,更新用update传入对象和wrapper
UpdateWrapper
需求:更新id为1,2,4的用户余额,扣200
创建ids的List,注意加L转换为Long,构建UpdateWrapper,setSql输入sql语句,in传入id集合,匹配id字段,update第一个参数设置为null
LambdaWrapper
解决硬编码问题,功能基本一致
创建可以new一个,也可以new QueryWrapper<>().lambda()
传入函数,通过反射获取字段,建议使用Lambda
总结
- QueryWrapper和LambdaQueryWrapper通常用来构建select、delete、update的where条件部分
- UpdateWrapper和LambdaUpdateWrapper通常只有在set语句比较特殊才使用
- 尽量使用LambdaQueryWrapper和LambdaUpdateWrapper,避免硬编码
自定义SQL
wrapper构建复杂where条件,自己定义剩下sql
防止sql代码写进业务代码,和特殊查询,别名
在mapper中自定义方法,xml中写上自定义sql,${ew.customSqlSegment}拼接mp语句
忘了ew可以用Constants.WRAPPER
Service接口
removeByIds:底层调用delete,where用的是in
removeBatchByIds:不用in,批量提交,在数据量大情况下性能高
查一个用get,查多个用list,list()查所有
复杂查询,更新时用Lambda
接口继承mp提供的IService,指定泛型为要操作的类,实现类继承mp实现类,泛型指定为对应的mapper和类
实现接口案例
导入swagger,web依赖
controller中,通过构造函数的方式自动注入service,加上final声明为常量,需要初始化,lombok注解@RequiredArgsConstructor自动创建必要的构造函数
新增
拷贝可以用.class
直接使用save方法传入user
删除
id查用户
查出来PO,拷贝到VO
id批量查
@RequestParam接收路径传过来的id集合
copyToList拷贝List
id扣余额(带业务)
判断状态,余额+自定义sql
可以直接(this)调用service层方法,也可以使用继承来的baseMapper
service:
mapper:
alt+8添加sevice,启动类启动
Lambda查询案例
需求:实现一个根据复杂条件查询用户的接口,查询条件如下:
- name:用户名关键字,可以为空
- status:用户状态,可以为空
- minBalance:最小余额,可以为空
- maxBalance:最大余额,可以为空
字段较多用对象接收
防止臃肿,将所有参数传入service:
(条件,字段名,值)
one查一个,list查多个,page查分页,exist查存在,count查数量
Lambda更新案例
需求:改造根据id修改用户余额的接口,要求如下
- 完成对用户状态校验
- 完成对用户余额校验
- 如果扣减后余额为0,则将用户status修改为冻结状态(2)
set设置字段值,判断余额是否为0,.update()执行sql
有并发问题,同时查询到用户,添加事务注解和乐观锁,判断余额是否和查出来时一样
IService批量新增案例
需求:批量插入10万条用户数据,并作出对比:
- 普通for循环插入
- IService的批量插入
- 开启rewriteBatchedStatements=true参数
批量一次1000条,防止内存占用过多,传入数据库数据包大小有上限
MP采用预编译方案,减少网络请求
优化:把多条sql语句优化成一条
更改配置,jdbc url加上&rewriteBatchedStatements=true
批处理方案:
- 普通for循环逐条插入速度极差,不推荐
- MP的批量新增,基于预编译的批处理,性能不错
- 配置jdbc参数,开rewriteBatchedStatements,性能最好
拓展功能
代码生成
MyBatisPlus插件
other-config database先配置要操作的数据库
code generator
静态工具
需要告知实体类类型,与sevice功能类似
需求:
- 改造根据id查询用户的接口,查询用户的同时,查询出用户对应的所有地址
- 改造根据id批量查询用户的接口,查询用户的同时,查询出用户对应的所有地址
- 实现根据用户id查询收货地址功能,需要验证用户状态,冻结用户抛出异常(练习)
使用静态工具解决循环依赖的情况
service创建方法
注意Db的选择,使用Lambda查询,传入Adress的字节码,储存为list
CollUtil判断地址集合是否为空
传入用户id集合,id有可能不存在,先将用户查询出来放集合,stream再将用户集合转为id集合。LambdaQuery+in通过userId查出所有地址,存入地址集合,拷贝转为VO集合,stream调用groupingBy将VO根据id分类转成map方便后续封装userVO。
预先传入size防止自动扩容提高效率,遍历封装
相比于遍历时查询地址性能更高
逻辑删除
逻辑删除就是基于代码逻辑模拟删除效果,但并不会真正删除数据。思路如下:
- 在表中添加一个字段标记数据是否被删除
- 当删除数据时把标记置为1
- 查询时只查询标记为0的数据
MybatisPlus提供了逻辑删除功能,无需改变方法调用的方式,而是在底层帮我们自动修改CRUD的语句。我们要做的就是在application.yaml文件中配置逻辑删除的字段名称和值即可:
mybatis-plus:
global-config:
db-config:
logic-delete-field: flag # 全局逻辑删除的实体字段名,字段类型可以是boolean、integer
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
逻辑删除本身也有自己的问题,比如:
- 会导致数据库表垃圾数据越来越多,影响查询效率
- SQL中全都需要对逻辑删除字段做判断,影响查询效率
因此,我不太推荐采用逻辑删除功能,如果数据不能删除,可以采用把数据迁移到其它表的办法。
枚举处理器
解决类型转换问题
- 枚举类中加注解
- 在application.yml中配置全局枚举处理器:
mybatis-plus:
configuration:
default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
枚举默认做JSON处理时以名称返回
添加@JsonValue告诉SpringMVC返回哪个值
JSON处理器
数据库中有JSON类型,Java没有
SringMVC默认Jackson,建议MP也选择Jackson
没有yaml全局配置,只能加注解
对象嵌套会产生复杂resultMap,打开autoResultMap,将查询结果的不同部分映射到嵌套对象及其属性上。
赋值时改为使用构建器
(配置加密)
MyBatisPlus从3.3.2版本开始提供了一个基于AES算法的加密工具,帮助我们对配置中的敏感信息做加密处理。
插件功能
分页插件
建议使用MP自带的分页插件不用再去引入PageHelper
MP的插件是基于拦截器做的,拦截SQL的执行并拓展功能
首先,要在配置类中注册MyBatisPlus的核心插件,同时添加分页插件:
@Configuration
public class MybatisConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
// 1.初始化核心插件
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 2.添加分页插件
PaginationInnerInterceptor pageInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
pageInterceptor.setMaxLimit(1000L); // 设置分页上限
interceptor.addInnerInterceptor(pageInterceptor);
return interceptor;
}
}
调用addInnerInterceptor添加插件,new的时候要指定数据库类型,设置分页上限,可选,避免一次查询过多,(setOverFlow循环查),具体用法参考官方文档
使用pageAPI,IService,Lambda,Db静态工具都有
泛型E是IPage的泛型及其子类(Page,PageDTO),主要用Page,包含页码,每页展示数,排序方式等,调用时传入Page对象,Wrapper查询条件,查询出参数填入page返回
of传入页码和展示数,addOrder传入OrderItem对象指定排序字段和排序方式(true升序false降序),可以再加一个排序。不指定查询条件只传入page。
通用分页实体
案例1
需求:遵循下面的接口规范,编写一个UserController接口,实现User的分页查询
第一步先封装查询(Query)和返回(VO,DTO)的实体类
创建分页查询实体
用户查询实体继承
返回DTO
Service
使用StrUtil进行非空校验,Page不要导错包了
使用Lambda查询,注意要传入page。判断页是否为空,空则返回空集合。
案例2
封装分页条件和解析过程繁琐,逻辑通用,要封装为工具
需求:
- 在PageQuery中定义方法,将PageQuery对象转为MyBatisPlus中的Page对象
- 在PageDTO中定义方法,将MyBatisPlus中的Page结果转为PageDTO结果
toMpPage方法
设置默认值防止没传,方法需要传入默认排序字段,声明为可变参数,可以有零个或多个。
多写几个方法方便使用
of方法
方法构建当前类,static通过类名直接调用。注意拷贝时,泛型没有字节码,所以需要第二个参数传入VO类字节码
使用函数式接口,自定义转换方法,放在stream流中的映射方法中
简化后的Service
可以处理特殊逻辑,名字后两位隐藏
注意:当前的方法都与实体类耦合,并且与MP相关联,可以定义专门工具类解决
--持续更新中--
(笔记写在word,图片导入有点慢,正在找办法)
(平时要上课,更新速度较慢)