目录
MybatisPlus
MybatisPlus是Mybatis的加强版----MybatisPlus帮助文档(http://www.baomidou.com)
润物无声:制作增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑。
效率至上:只需简单配置,即可快速进行单表 CRUD 操作,从而节省大量时间。
丰富功能:代码生成、自动分页、逻辑删除、自动填充、拦截器等功能一应俱全。
入门案例:
在原来Mybatis实现mapper.xml语句的时候,需要自己一个一个语句的敲,麻烦!
而MybatisPlus能帮助我们解决这个问题,快速简便。
使用MybatisPlus的步骤:
(1)引入MybatisPlus的起步依赖:
(2)定义Mapper:
在项目中使用MybatisPlus不需要在Mapper和Mapper.xml中书写语句,直接调用BaseMapper的方法。
首先定义一个Mapper的实体类,然后调用Mapper的方法。
这个是Mybatis 的原始代码
、
常见注解:
type默认使用雪花算法
如果变量名是数据库关键字,则需要加引号' ',比如@TableField(" 'order' "),
变量名在数据库中没有,则需要加@TableField(exist=false)
常见配置:
MybatisPlus的配置项继承了Mybatis原生配置和一些特有的配置。例如:
条件构造器:
条件构造器是用来实现复杂的sql语句。
条件构造器Wrapper最顶级的条件构造抽象类,主要有下述四个子类,我们可以使用它们来构造相关条件从而进行数据库交互操作。
QueryWrapper:用于封装查询条件
UpdateWrapper:用于封装更新条件
LambdaQueryWrapper:用于使用Lambda语法封装查询条件
LambdaUpdateWrapper:用于使用Lambda语法封装更新条件
两个案例:
基于QueryWrapper的语句。
基于LambdaQueryWrapper的语句。
条件构造器的用法:
QueryWrapper和LambdaQueryWrapper通常用来构造select、delete、update 的where条件部分。
Update和LambdaUpdateWrapper通常只有在Set语句比较特殊才使用。
尽量使用LambdaQueryWrapper和LambdaUpdateWrapper,避免硬编码。
自定义SQL:
我们可以利用MybatisPlus中的Wrapper来构造复杂的Where条件,然后自定义Sql语句剩下的部分
有些sql语句MybatisPlus很难实现Where条件之外的语句,所以可以利用自定义SQl书写where条件语句之外的部分。
1、基于Wrapper构造Where条件
2、在mapper 方法参数中用param注解声明Wrapper变量名称,必须是ew
3、自定义sql,并使用Wrapper条件
IService接口:
常用的IService接口:
有了IService接口就可以简化Service层的开发
UserService接口继承IService,UserServiceImpl实现类继承ServiceImpl实现类。
IService接口的使用流程:
1、自定义Service接口继承IService接口,IService要指定泛型。
public interface IUserService extends IService<User>{}
2、自定义Service实现类,实现自定义接口并继承ServiceImpl类,ServiceImpl类要明确mapper和User两个泛型。
public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements IUserService{}
简单案例:
首先注入IUserService接口的变量,然后直接使用IService的相关方法。
IService开发 基础 / 复杂 业务接口。
看这两个视频能基本掌握基础的开发语句,包括单体框架和新学的IService接口。
黑马SpringCloud P9 and P10. 包括可以跟苍穹外卖项目单体框架类型进行对比,Controller层有什么不一样。
http://【2024最新SpringCloud微服务开发与实战,java黑马商城项目微服务实战开发(涵盖MybatisPlus、Docker、MQ、ES、Redis高级等)】https://www.bilibili.com/video/BV1S142197x7?p=9&vd_source=f0be03e7e4ced5d131269db1c3c2d39a
IService的Lambda方法
复杂查询:
批量新增:
http://t.csdnimg.cn/djJuR
代码生成器
以往使用MybatisPlus要做的几件事就是
引入依赖---写实体类代码,还要给实体类加上对应的注解---给实体类写上对应的mapper---写Service接口---写Service接口的实现类,指定泛型。
结构大都数都是一样的,只需要根据实体类的变化改变,而实体类是根据数据库表变化的。
所以代码生成器的作用就是自动生成这些代码。
有两个插件可以自动生成代码。
1、Mybatis X 插件 ----在帮助文档里面有说明MybatisPlus帮助文档(http://www.baomidou.com)
2、按照图片的步骤操作提交就可以了。
DB静态工具
主要作用:避免循环依赖
例如:
1.查询用户的接口,查询出用户的同时,查询出用户对应的所有地址
2.批量查询用户的接口,查询用户的同时,查询出用户对应的所有地址
如果要实现上述功能,那么在查询用户表的时候还要注入地址表,查询地址表的时候还要注入用户表,这样就形成了循环依赖,而利用静态工具类进行的查询,就可以解决这个问题。
首先,这是两张表的结构:
1.查询用户的接口,查询出用户的同时,查询出用户对应的所有地址
@Override
public void selectUserAddressById(Long id) {
// 查询用户
User user = this.getById(id);
if (user == null){
throw new RuntimeException("用户不存在");
}
// 查询用户地址
// 引用MybatisPlus的
List<TOrder> list = Db.lambdaQuery(TOrder.class).eq(TOrder::getUserId, id).list();
System.out.println(list);
}
2.批量查询用户的接口,查询用户的同时,查询出用户对应的所有地址
@Override
public List<TOrder> findAddressByIds(List<Integer> ids) {
// 查询用户
List<User> users = this.listByIds(ids);
if (users.size() == 0){
throw new RuntimeException("用户不存在");
}
// 获取用户id集合
List<Integer> userIds = users.stream().map(User::getId).collect(Collectors.toList());
// 查询用户地址
List<TOrder> list = Db.lambdaQuery(TOrder.class).in(TOrder::getUserId, userIds).list();
// 对用户集合进行分组处理,同一用户的放在一起
Map<Integer, List<TOrder>> collect = new HashMap<>(0);
if (CollectionUtils.isEmpty(list)) {
collect = list.stream().collect(Collectors.groupingBy(TOrder::getUserId));
}
// 获取用户地址
List<TOrder> tOrders = collect.get(userIds);
return tOrders;
逻辑删除
逻辑删除就是基于代码逻辑模拟删除效果,但并不会真正删除数据。
比如在淘宝中的订单,要删除订单,但数据并没有被删除。
思路如下:
在表中添加一个字段标记数据是否被删除
当数据被置为1时代表被删除
查询的时候只需查询0的数据
逻辑删除的sql:
update user set deleted = 1 where id = 1 and deleted = 0
Select * from user where deleted = 0
MybatisPlus提供了逻辑删除的功能,无需改变方法调用的方式,而是在底层帮我们自动修改CRUD的语句。
我们要在application.yaml中设置逻辑删除的字段名和值。
mybatis-plus:
global-config:
db-config:
logic-delete-field: deleted # 逻辑删除字段名(默认为 deleted)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
测试类:
@AutoWired
private IAddressService addressService;
@Test
void test() {
// 删除订单
AddressService.removeById(60);
// 查询订单
Address address = AddressService.getById(60);
System.out.println(address);
}
注意:
逻辑删除本身也有自己的问题,比如:
会导致数据库表垃圾数据越来越多,影响查询效率
SQL中全都需要对逻辑删除字段做判断,影响查询效率因此,不太推荐采用逻辑删除功能,如果数据不能删除,可以采用把数据迁移到其它表的办法 。
枚举处理器
在User实体类中有一个状态字段status
:
对于这样的码表字段,一般会定义一个枚举类,做业务判断的时候直接基于枚举类进行比较。但是该字段在数据库采用的是int
类型,对应的实体类中是Integer
类型,因此业务操作时必须手动把枚举类与Integer
进行转换,相对麻烦。
为此,MybatisPlus提供了一个处理枚举类的类型转换器,可以对枚举类型与数据库类型进行自动转换。
(1)定义一个用户状态的枚举类UserStatus
// com.star.learning.enums.UserStatus
@Getter
public enum UserStatus {
NORMAL(1, "正常"),
FREEZE(2, "冻结")
;
private final int value;
private final String desc;
UserStatus(int value, String desc) {
this.value = value;
this.desc = desc;
}
}
(2)将User类中的status
字段改为UserStatus类型
// com.star.learning.pojo.User
/**
* 使用状态(1正常 2冻结)
*/
//private Integer status;
private UserStatus status;
(3)使用@EnumValue
注解标记枚举属性:
要让MybatisPlus处理枚举类与数据库类型自动转换,就必须告诉MybatisPlus,枚举中的哪个字段的值作为数据库值。MybatisPlus提供了@EnumValue
注解来标记枚举属性:
// com.star.learning.enums.UserStatus
@EnumValue
private final int value;
// ...
(4)配置枚举处理器
在application.yaml文件中添加配置:
# src\main\resources\application.yaml
mybatis-plus:
configuration:
# 默认枚举类处理器(从3.5.2开始无需配置)
default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
不使用@JsonValue返回给前端的结果是
MybatisPlus支持通过@JsonValue
注解,用于标记JSON序列化时展示的字段:
// com.star.learning.enums.UserStatus
@EnumValue
private final int value;
@JsonValue
private final String desc;
再次执行以上接口,返回前端的信息是:
JSON处理器
在数据库的t_user
表中,有一个类型为JSON
的字段info
(从MySQL5.7开始支持JSON
类型),保存的数据是JSON字符串:
而在对应的实体类中保存的是String类型的。
这样设计时,查询到的info
字段就是一个JSON字符串,而要读取其中的属性,还需要将JSON字符串转换为对象。而写入数据库时,需要将对象转换为JSON字符串,较为繁琐。
为此,MybatisPlus提供了很多特殊类型字段的类型处理器,解决特殊字段类型与数据库类型转换的问题,例如处理JSON问题就可以使用JacksonTypeHandler处理器。
(1)定义一个实体类UserInfo,对应info
字段保存的信息:
// com.star.learning.pojo.UserInfo
@Data
public class UserInfo {
private Integer age;
private String intro;
private String gender;
}
(2)将User类的info
字段修改为UserInfo类型,并使用@TableField
注解声明该字段的类型处理器为JacksonTypeHandler,同时在实体类的@TableName
注解上添加autoResultMap = true
属性:
// com.star.learning.pojo.User
@Data
@TableName(value = "t_user", autoResultMap = true)
public class User {
// ...
@TableField(typeHandler = JacksonTypeHandler.class)
private UserInfo info;
}
分页插件
MybatisPlus提供了很多插件,进一步拓展其功能。目前已有的插件包括:
使用最多的是分页插件。
配置分页插件
在未配置分页插件的情况下,MybatisPlus是不支持分页功能的,IService接口和BaseMapper类中的分页方法都无法正常使用。
要配置分页插件,需要新建一个配置类:
// com.star.learning.config.MyBatisConfig
@Configuration
public class MyBatisConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
// 初始化核心插件
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 添加分页插件
PaginationInnerInterceptor pageInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
pageInterceptor.setMaxLimit(1000L); //设置分页上限
interceptor.addInnerInterceptor(pageInterceptor);
return interceptor;
}
}
分页API基本使用如下:
@Test
public void testPageQuery() {
// 1.分页查询,new Page()的两个参数分别是:页码、每页大小
Page<User> page = new Page<>(2, 2);
page = userService.page(page);
// 2.总条数
System.out.println("total = " + page.getTotal());
// 3.总页数
System.out.println("pages = " + page.getPages());
// 4.数据
List<User> records = page.getRecords();
records.forEach(System.out::println);
}
分页的核心是Page类,除了可以设置当前页和每页大小,还支持排序参数,例如将以上单元测试修改如下:
// 1.分页查询,new Page()的两个参数分别是:页码、每页大小
Page<User> page = new Page<>(2, 2);
// 支持排序参数,第二个参数的true表示升序,false表示降序
page.addOrder(new OrderItem("balance", true));
// 支持多个排序参数
page.addOrder(new OrderItem("id", true));
// ...
通用分页实体
看这个博主的最后一个部分