MyBatisPlus(MP)学习记录(分页查询的开启+日志打印配置+乐观锁+映射匹配+字段匹配和表名匹配+null值判定+代码生成器等等)
MP介绍(官网链接)
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
前言
本篇文章展示的MP教学中涉及到的版本如下:
- IDEA :2022.1
- SpringBoot : 2.7.7
- Java : 1.8
- DataSource :com.alibaba:druid 1.1.16
- MyBatisPlus :3.4.1
- MySQL :8.0.26
入门
1.创建SpringBoot项目
参考博主的IDEA创建SpringBoot项目教程这篇博文,需要注意一点,选择boot版本的时候尽量选择3.0以下的,否则低版本的java将创建失败,另外一点,提供的依赖只需选择MySQL Driver即可,因为本篇文章只是MP的入门,一个MySQL的依赖就足够的。
2.相关配置
mybatis-plus依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
数据源Druid依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.16</version>
</dependency>
数据库配置信息:
3. 单独配置分页功能
配置类的书写:
package org.zzzzzz.config;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() { // 分页拦截器的添加
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return mpInterceptor;
}
}
4.在测试类中进行分页方法测试
@Test
public void testGetByPage() {
// 第二页,每页四条数据
IPage page = new Page(2, 4);
bookDao.selectPage(page, null);
page.getPages(); // 一共有多少页
page.getRecords(); // 查询出的数据
page.getTotal(); // 所有的数据
page.getCurrent(); // 当前页数
page.getSize(); // 每页的大小
}
日志的开启(方便调试):
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
查看测试信息(包含日志)
5.条件查询
- 条件查询格式
// 方式一
QueryWrapper qw = new QueryWrapper();
qw.lt("id", 7);
List<Book> list = bookDao.selectList(qw);
System.out.println(list);
// 方式二
QueryWrapper<Book> qw = new QueryWrapper();
qw.lambda().lt(Book::getId, 7);
List<Book> list = bookDao.selectList(qw);
System.out.println(list);
// 方式三 :链式编程
LambdaQueryWrapper<Book> lqw = new LambdaQueryWrapper<Book>();
// lqw.lt(Book::getId, 5).gt(Book::getId, 7); 并且关系
lqw.gt(Book::getId, 10).or().lt(Book::getId, 5); // 或者关系
List<Book> list = bookDao.selectList(lqw);
System.out.println(list);
- 条件查询null值判定方式
BookQuery bookQuery = new BookQuery();
bookQuery.setId(xx); // Id上限
bookQuery.setId2(yy); // Id下限
LambdaQueryWrapper<Book> lqw = new LambdaQueryWrapper<Book>();
// 设置下限
lqw.gt(null != bookQuery.getId2(), Book::getId, bookQuery.getId2());
// 设置上限
lqw.lt(null != bookQuery.getId(), Book::getId, bookQuery.getId());
List<Book> list = bookDao.selectList(lqw);
System.out.println(list);
- 查询投影
查询结果包含模型类中部分属性
// 使用Lambda的方式
LambdaQueryWrapper<Book> lqw = new LambdaQueryWrapper<Book>();
lqw.select(Book::getId, Book::getName); // 查询指定字段
List<Book> list = bookDao.selectList(lqw);
System.out.println(list);
查询结果包含模型类中未定义的属性
// 只能使用常规方式
QueryWrapper<Book> qw = new QueryWrapper();
qw.select("count(*) as count, type"); // 查询数据的条数
qw.groupBy("type");
List<Map<String, Object>> mapList = bookDao.selectMaps(qw);
System.out.println(mapList);
其他复杂情况回归到最开始在Dao接口中写SQL的时候(MyBatis)
// 无代码,需要依据具体情况写SQL语句
- 查询条件
条件过多,查询官方文档即可。
https://baomidou.com/pages/10c804/#abstractwrapper - 映射匹配
解决的问题:数据库表的字段名与pojo类中的属性名不一致、表名与pojo类名不对称导致查询时不匹配、某字段不参与查询(考虑安全性:密码、身份证号、手机号等等)、属性值后续添加但不在表字段中等等。
- id生成策略(MP中的枚举类)
注解格式:@TableId(type= IdType.AUTO)
注:也可以设置xml文件里的MP全局配置(大量实体类的规范(比较广,意会一下即可)一致的情况下) - 批量删除(id)与批量查询(id)
没有什么特别要指出来的,就是两个api的调用。 - 逻辑删除(给每条数据增加一个标记字段(deleted),以及实体类增加字段)
需要设定被删除的记录,他们的标记是什么(一般是1),没被删除的记录,他们的标记是什么(一般是0)。这些只需要在xml配置中写即可。
注:一旦进行删除操作,那么实际的SQL语句为UPDATA语句,而不是DELETE语句,它会使用UPDATA语句进行标记的更新,实现逻辑删除。
注:如果想要查询那些已经被逻辑删除的记录,需要自己手写Dao层的SQL语句。 - MP添加乐观锁(解决小型并发问题:秒杀、抢票等等)
表中与实体类中添加字段version(也算是一个标记),在MP的配置类中添加一个乐观锁的拦截器。(注:要想使乐观锁启用,对记录进行修改的时候,一定要包含字段version。在开发中一般是先查询后更新,遵循了上面的规则。) - MP代码生成器(模板+自定义配置)
依赖的导入:
<!--代码生成器-->
<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.java
package org.zzzzzz;
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;
public class CodeGenerator {
public static void main(String[] args) {
//1.获取代码生成器的对象
AutoGenerator autoGenerator = new AutoGenerator();
//设置数据库相关配置
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/ssm_db?serverTimezone=UTC");
dataSource.setUsername("root");
dataSource.setPassword("root");
autoGenerator.setDataSource(dataSource);
//设置全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir")+"/mp_generator/src/main/java"); //设置代码生成位置
globalConfig.setOpen(false); //设置生成完毕后是否打开生成代码所在的目录
globalConfig.setAuthor("openallzzz"); //设置作者
globalConfig.setFileOverride(true); //设置是否覆盖原始生成的文件
globalConfig.setMapperName("%sDao"); //设置数据层接口名,%s为占位符,指代模块名称
globalConfig.setIdType(IdType.ASSIGN_ID); //设置Id生成策略
autoGenerator.setGlobalConfig(globalConfig); //设置为全局配置
//设置包名相关配置
PackageConfig packageInfo = new PackageConfig();
packageInfo.setParent("org.zzzzzz"); //设置生成的包名,与代码所在位置不冲突,二者叠加组成完整路径
packageInfo.setEntity("domain"); //设置实体类包名
packageInfo.setMapper("dao"); //设置数据层包名
autoGenerator.setPackageInfo(packageInfo);
//策略设置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("tbl_book"); //设置当前参与生成的表名,参数为可变参数
strategyConfig.setTablePrefix("tbl_"); //设置数据库表的前缀名称,模块名 = 数据库表名 - 前缀名 例如: Book = tbl_book - tbl_
strategyConfig.setRestControllerStyle(true); //设置是否启用Rest风格
strategyConfig.setVersionFieldName("version"); //设置乐观锁字段名
strategyConfig.setLogicDeleteFieldName("deleted"); //设置逻辑删除字段名
strategyConfig.setEntityLombokModel(true); //设置是否启用lombok
autoGenerator.setStrategy(strategyConfig);
//2.执行代码生成器生成操作
autoGenerator.execute();
}
}