MyBatisPlus
今日目标
基于MyBatisPlus完成标准Dao的增删改查功能
掌握MyBatisPlus中的分页及条件查询构建
掌握主键ID的生成策略
了解MyBatisPlus的代码生成器
MybatisPlus入门与简介
入门案例
- MybatisPlus(简称MP)是基于MyBatis框架基础上开发的增强型工具,旨在简化开发、提供效率。
- 开发方式
- 基于MyBatis使用MyBatisPlus
- 基于Spring使用MyBatisPlus
- 基于SpringBoot使用MyBatisPlus
- 创建新的模块,选择Spirng初始化,并配置相关模块的配置信息
- 选择当前模块所需要的技术集(仅保留JDBC)
- 手动添加mp起步依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
由于mp并未被收录到idea的系统内置配置,无法直接选择加入
- 在application.yml文件中设置jdbc参数
spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC
username: root
password: root
如果使用Druid数据源,需要导入对应坐标
- 制作实体类与表结构(类名与表名对应,属性名与字段名对应)
- 定义数据接口,继承BaseMapper
@Mapper
public interface UserDao extends BaseMapper<User> {
}
- 在测试类中注入dao接口,测试功能
@SpringBootTest
class Mybatisplus01ApplicationTests {
@Autowired
private UserDao userDao;
@Test
void contextLoads() {
List<User> userList = userDao.selectList(null);
System.out.println(userList);
}
}
MybatisPlus概述
- MyBatisPlus(简称MP)是基于MyBatis框架基础上开发的增强型工具,旨在简化开发、提高效率
- 官网: https://mybatis.plus/ https://mp.baomidou.com/
特性:
- 无侵入:只做增强不做改变,不会对现有工程产生影响
- 强大的 CRUD操作:内置通用Mapper,少量配置即可实现单表CRUD操作
- 支持 Lambda:编写查询条件无需担心字段写错
- 支持主键自动生成
- 内置分页插件
- …
标准层数据开发
标准数据层CRUD功能
Lombok
- Lombok,一个Java类库,提供了一组注解,简化POJO实体类开发。
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
- 常用注解:@Data
@Data
public class User {
private Long id;
private String name;
private String password;
private Integer age;
private String tel;
}
- 为当前实体类在编译期设置对应的get/set方法,无参/无参构造方法,toString方法, hashCode方法,equals方法等
分页功能
- MP分页拦截器
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mpInterceptor(){
//1. 定义MP拦截器
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
//2. 添加具体的拦截器
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return mpInterceptor;
}
}
- 执行分页查询
@Test
void testByPage(){
IPage page =new Page(2,4);
userDao.selectPage(page,null);
System.out.println(page.getCurrent());//当前页码值
System.out.println(page.getSize());//每页显示数
System.out.println(page.getPages());//一共多少页
System.out.println(page.getTotal());//总共多少条
System.out.println(page.getRecords());//数据
}
开启日志:
#开启mp日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
DQL编程
条件查询
-
MyBatisPlus将书写复杂的sQL查询条件进行了封装,使用编程的形式完成查询条件的组合gwe
-
格式一:常规格式
// 方式一 按条件查询
QueryWrapper qw = new QueryWrapper();
qw.lt("age",18);
List<User> users = userDao.selectList(qw);
System.out.println(users);
- 格式二:链式编程格式
QueryWrapper<User> qw = new QueryWrapper<User>();
qw.lambda().lt("age",18).gt("age",2);
List<User> users = userDao.selectList(qw);
System.out.println(users);
- 格式三:lambda格式(推荐)
//方式三:lambda格式按条件查询
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
lambdaQueryWrapper.lt(User::getAge, 19);
List<User> users = userDao.selectList(lambdaQueryWrapper);
System.out.println(users);
- 格式四:lambda格式(推荐)
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
//10-30
//lambdaQueryWrapper.lt(User::getAge, 50).gt(User::getAge, 10);
//<10 and >30
lambdaQueryWrapper.lt(User::getAge,15).or().gt(User::getAge,60);
List<User> users = userDao.selectList(lambdaQueryWrapper);
System.out.println(users);
null 值处理
- if 语句控制条件追加
//模拟页面传递过来的查询数据
UserQuery uq = new UserQuery();
uq.setAge(10);
uq.setAge2(30);
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
//null判定
lambdaQueryWrapper.lt(User::getAge,uq.getAge2());
if (null != uq.getAge()){
lambdaQueryWrapper.gt(User::getAge,uq.getAge());
}
List<User> users = userDao.selectList(lambdaQueryWrapper);
System.out.println(users);
- 条件参数控制(支持链式编程)
//模拟页面传递过来的查询数据
UserQuery uq = new UserQuery();
uq.setAge(10);
uq.setAge2(30);
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
//null判定
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
lambdaQueryWrapper.lt(null != uq.getAge2(),User::getAge,uq.getAge2());
lambdaQueryWrapper.gt(null != uq.getAge(),User::getAge,uq.getAge());
List<User> users = userDao.selectList(lambdaQueryWrapper);
System.out.println(users);
查询投影
- 查询结果包含模型类中部分属性
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
lambdaQueryWrapper.select(User::getId,User::getName);
List<User> users = userDao.selectList(lambdaQueryWrapper);
System.out.println(users);
- 查询结果包含模型类中未定义的属性
//查询投影
QueryWrapper<User> qw = new QueryWrapper<User>();
qw.select("count(*) as count,tel");
qw.groupBy("tel");
List<Map<String,Object>> userList = userDao.selectMaps(qw);
System.out.println(userList);
查询字段设定
- 用户登录(eq匹配)
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.eq(User::getName,"Jerry").eq(User::getPassword,"jerry");
User user = userDao.selectOne(lqw);
System.out.println(user);
- 购物设定价格区间、户籍设定年龄区间( le ge匹配﹐或between匹配)
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//方案一:设定上下限
lqw.lt(User::getAge, 50).gt(User::getAge, 10);
//范围查询 lt le gt ge between
lqw.between(User::getAge,10,21);
List<User> users = userDao.selectList(lqw);
System.out.println(users);
- 查信息,搜索新闻(非全文检索版:like匹配)
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.likeLeft(User::getName, "J");
//SELECT id,name,password,age,tel FROM user WHERE (name LIKE ?)
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
- 统计报表(分组查询聚合函数)
Querywrapper<User> qw = new Querywrapper<User>();
qw.select( "gender", "count(*) as nums") ;
qw.groupBy("gender") ;
List<Map<String,object>> maps = userDao.selectMaps(qw);system.out.println(maps);
字段映射与表名映射
- 问题1:表字段与编码属性设计不同步
@TableField(value="pwd")
private String password;
- 问题2:编码中添加了数据库中未定义的属性
@TableField( exist = false)
private Integer online;
- 采用默认查询开放了更多的字段查看权限
@TableField(value="pwd" ,select = false)
private String password;
排序查询
@Test
void testGetAll(){
LambdaQueryWrapper<User> lwq = new LambdaQueryWrapper<>();
/**
* condition :条件,返回boolean,
当condition为true,进行排序,如果为false,则不排序
* isAsc:是否为升序,true为升序,false为降序
* columns:需要操作的列
*/
lwq.orderBy(true,false, User::getId);
userDao.selectList(lw
}
- orderBy排序
- condition:条件,true则添加排序,false则不添加排序
- isAsc:是否为升序,true升序,false降序
- columns:排序字段,可以有多个
- orderByAsc/Desc(单个column):按照指定字段进行升序/降序
- orderByAsc/Desc(多个column):按照多个字段进行升序/降序
- orderByAsc/Desc
- condition:条件,true添加排序,false不添加排序
- 多个columns:按照多个字段进行排序
# 关闭mybatisplus启动图标
banner: off
# 关闭SpringBoot启动图标(banner)
banner-mode: off
知识点@TableField
名称 | @TableField |
---|---|
类型 | 属性注解 |
位置 | 模型类属性定义上方 |
作用 | 设置当前属性对应的数据库表中的字段关系 |
相关 属性 | value(默认):设置数据库表字段名称 exist:设置属性在数据库表字段中是否存在,默认为true,此属性不能与value合并使用 select:设置属性是否参与查询,此属性与select()映射配置不冲突 |
- 表名与编码开发设计不同步
@TableName ( "tbl_user")public class User{}
知识点@TableName
名称 | @TableName |
---|---|
类型 | 类注解 |
位置 | 模型类定义上方 |
作用 | 设置当前类对应于数据库表关系 |
相关属性 | value(默认):设置数据库表名称 |
DML编程控制
- 不同的表应用不同的id生成策略
- 日志:自增( 1,2,3,4,…)
- 购物订单:特殊规则(FQ23948AK3843)
- 外卖单:关联地区日期等信息(10 04 20200314 34 91)
- 关系表:可省略id
- …
知识点@TableId
名称 | @TableId |
---|---|
类型 | 属性注解 |
位置 | 模型类中用于表示主键的属性定义上方 |
作用 | 设置当前类中主键属性的生成策略 |
相关属性 | value(默认):设置数据库表主键名称 type:设置主键属性的生成策略,值查照IdType的枚举值 |
id 生成策略控制
-
AUTO(0):使用数据库id自增策略控制id生成
-
NONE(1):不设置id生成策略
-
INPUT(2):用户手工输入id
-
ASSIGN_ID(3):雪花算法生成id(可兼容数值型与字符串型)
-
ASSIGN_UUID(4):以UUID生成算法作为id生成策略
-
NONE: 不设置id生成策略,MP不自动生成,约等于INPUT,所以这两种方式都需要用户手动设
置,但是手动设置第一个问题是容易出现相同的ID造成主键冲突,为了保证主键不冲突就需要做很
多判定,实现起来比较复杂 -
AUTO:数据库ID自增,这种策略适合在数据库服务器只有1台的情况下使用,不可作为分布式ID使用
-
ASSIGN_UUID:可以在分布式的情况下使用,而且能够保证唯一,但是生成的主键是32位的字符
串,长度过长占用空间而且还不能排序,查询性能也慢 -
ASSIGN_ID:可以在分布式的情况下使用,生成的是Long类型的数字,可以排序性能也高,但是
生成的策略和服务器时间有关,如果修改了系统时间就有可能导致出现重复主键 -
综上所述,每一种主键策略都有自己的优缺点,根据自己项目业务的实际情况来选择使用才是最明
智的选择
雪花算法(SnowFlake),是Twitter官方给出的算法实现 是用Scala写的。其生成的结果是一个
64bit大小整数,它的结构如下图:
**#**与数据库的表名链接,表前面字段名
table-prefix: tbl_
全局配置
mybatis-plus:
global-config:
db-config:
table-prefix: tbl_
#配置完成后,每个模型类的主键ID策略都将成为assign_id.
多记录删除
- 按照主键删除多条记录
List<Long> ids= Arrays.asList(new Long[]{2,3});
userDao.deleteBatchIds (ids);
- 根据主键查询多条记录
List<Long> ids= Arrays.asList(new Long[ ]{2,3});
List<User> userList = userDao.selectBatchIds(ids );
逻辑删除
-
删除操作业务问题,:业务数据从数据库中丢弃
-
逻辑删除:为数据设置是否可用状态字段,删除时设置状态字段为不可用状态,数据保留在数据库中
可以在数据库中的表中和代码中domain数据层代码中对应的类添加标记的字段。
例如图中的 deleted 字段,可以使未删除的员工默认值为0,当删除该员工时,字段改为 1 。
有两种方法可以进行操作
- 第一种
在类中添加@Tablelogic注解,注解里面有两个值,value属性中的值代表的是未删除的,delval属性中的值代表的是已经删除的。
@TableLogic(value = "0",delval = "1")
private Integer deleted;
对应表中deleted字段。可以进行删除操作的测试,会发现能运行成功,但是在表中查看会发现删除数据对应的deleted从默认的0改成了1
- 第二种
在配置文件中进行操作
# 逻辑删除操作
logic-delete-field: deleted
logic-not-delete-value: 0
logic-delete-value: 1
在配置文件中操作后不用在代码中写注释。
-
数据库表中添加逻辑删除标记字段
-
实体类中添加对应字段,并设定当前字段为逻辑删除标记字段
-
配置逻辑删除字面值
-
执行的删除语句变为了更新语句
UPDATE tbl_user SET deleted=1 WHERE id=? AND deleted=0
乐观锁
- 业务并发现象带来的问题:秒杀
- 数据库表中添加锁标记字段
- 实体类中添加对应字段,并设定当前字段为逻辑删除标记字段
@Version
private Integer version;
- 配置乐观锁拦截器实现锁机制对应的动态SQL语句拼装
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mpInterceptor(){
//1. 定义MP拦截器
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
//2. 添加具体的分页拦截器
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
//添加乐观锁的拦截器
mpInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return mpInterceptor;
}
}
- 使用乐观锁机制在修改前必须先获取到对应数据的verion方可正常进行
@Test
void testUpdate1(){
User user = userDao.selectById(3l);
user.setName("jock777");
userDao.updateById(user);
}
执行修改前先执行查询语句:
SELECT id ,name, age,tel,deleted, version FROM tbl_user WHERE id=?
执行修改时使用version字段作为乐观锁检查依据:
UPDATE tbl_user SET name=?, age=?, version=? WHERE id=? AND version=? AND deleted=0
快速开发:代码生成器
- 模板:MyBatisPlus提供
- 数据库相关配置:读取数据库获取信息
- 开发者自定义配置:手工配置
在pom.xml配置文件这个添加对应的依赖。
<!--代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!--velocity模板引擎-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
创建代码生成类CodeGenerator
package com.zpd;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
/**
* @Description
* @Author zpd
* @Date 2022/10/26
*/
public class CodeGenerator {
public static void main(String[] args) {
AutoGenerator autoGenerator = new AutoGenerator();
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?useSSL=false");
dataSource.setUsername("root");
dataSource.setPassword("root");
autoGenerator.setDataSource(dataSource);
//设置全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir")+"/src/main/java");
globalConfig.setOpen(false);//设置完毕是否打开代码所在的目录
globalConfig.setAuthor("zpd");//设置作者
globalConfig.setFileOverride(true);//设置是否覆盖原始生成的文件
globalConfig.setMapperName("%sDao");//设置数据层接口名,%s为占位符,指代模块名称
globalConfig.setIdType(IdType.ASSIGN_ID);//设置Id生成策略
autoGenerator.setGlobalConfig(globalConfig);
//设置包名相关配置
PackageConfig packageConfig = new PackageConfig();
packageConfig.setParent("com.sjy");//设置生成的包名
packageConfig.setEntity("domain");//实体类的包名
packageConfig.setMapper("dao");//数据层包名
autoGenerator.setPackageInfo(packageConfig);
//策略设置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("tbl_user","tbl_log");//当前生成的表名,参数为可变参数
strategyConfig.setTablePrefix("tbl_");//设置数据库表的
strategyConfig.setRestControllerStyle(true);//是否为Rest风格
strategyConfig.setVersionFieldName("version");//乐观锁
strategyConfig.setLogicDeleteFieldName("deleted");//逻辑删除
strategyConfig.setEntityLombokModel(true);//启用lombook
autoGenerator.setStrategy(strategyConfig);
//执行操作
autoGenerator.execute();
}
}
然后运行代码直接生成好我们需要的框架模板。