Mybatis-plus使用笔记
MyBatisPlus概述
需要的基础:把Mybatis、Spring、SpringMVC就可以学习这个
MyBatisPlus的作用:节省大量的工作时间,所有的CRUD代码它都可以自动化完成
简介
官方文档:https://baomidou.com/
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求,以后简单的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 操作智能分析阻断,也可自定义拦截规则,预防误操作
使用第三方组件:
1、导入对应的依赖
2、研究依赖如何配置
3、代码如何编写
4、提高扩展能力技术
步骤
1、创建数据库
2、创建对应的表,例:user
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');
--在真是开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create(创建时间)、gmt_modified(更新\修改时间)
3、编写项目,初始化项目!使用SpringBoot初始化(第二集)
4、导入依赖
mysql
mysql-connector-java
org.projectlombok
lombok
com.baomidou
mybatis-plus-boot-starter
3.5.1
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-test
test
说明:我们使用mybatis-plus可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus
5、连接数据库!这一步和Mybatis相同
#mysql 5 驱动不同 com.mysql.jdbc.Driver 补充:高版本是兼容低版本的
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
#useSSL:是否使用安全连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#MySQL8 驱动不同 com.mysql.cj.jdbc.Driver 、需要增加时区的配置
6、传统方式pojo-dao(连接mybatis,配置mapper-xml文件)、service-controller
6、使用了mybatis-plus之后
- pojo
//User类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class user {
private Long id;
private String name;
private Integer age;
private String email;
}
- mapper接口
//mapper接口
@Repository //代表dao(持久层的) 要是该组件生效需要扫描并识别
//在对应的mapper上面继承基本的类 BaseMapper
public interface UserMapper extends BaseMapper {
//------所有的CRUD都编写完成了-------
//---不需要向以前的配置一大堆文件----
}
- 使用测试
@SpringBootTest
class MybatisPlusApplicationTests {
//继承了BaseMapper所有的方法,我们自己也可以编写方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//查询全部用户
//参数 wrapper 是一个条件构造器,这里我们先不用 null 表示没有条件
List users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
- 测试结果
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)
- 注意点,我们需要在启动类上去扫描我们的mapper接口
//扫描我们的mapper文件夹
@MapperScan("com/anyuan/mapper")
思考问题?
1、SQL谁帮我们写的? Mybatis-plus写的
2、方法哪里来的? Mybatis-plus都写好了
配置日志
我们所有的sql现在是不可见的,我们希望知道他是怎么执行的,所以我们必须要看日志
#配置日志
#这里使用默认的控制台输出
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
CRUD扩展
测试插入
// 测试插入
@Test
void contextLoad1() {
//该方法帮我们自动生成id
User user = new User(null, "kuang", 3, "1322665145613");
int result = userMapper.insert(user);
System.out.println(result);//受影响的行数
System.out.println(user);//发现id会自动回填
}
注意:数据库插入的默认值为:全局的唯一id
主键生成策略
分布式系统唯一id生成方法:
雪花算法
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。
主键自增
我们需要配置逐渐自增
1、实体类字段上加 @TableId(type = IdType.AUTO)
2、数据库字段一定要是自增的
3、再次测试插入即可
其余的源码解释
public enum IdType {
AUTO(0),//数据库id自增
NONE(1),//未设置主键
INPUT(2),//手动输入
ASSIGN_ID(3),//默认策略 使用一个 64 bit 的 long 型的数字作为全局唯一 id。
ASSIGN_UUID(4);//自动生成不含中划线的 UUID 作为主键。主键类型为 String,对应 MySQL 的表字段为 VARCHAR(32)
}
测试更新
//测试更新
@Test
void contextLoad2() {
//该方法帮我们自动生成id
User user = new User(5L, "kuangsheng", 3, "1322665145613@qq.com");
int result = userMapper.updateById(user);
System.out.println(result);//受影响的行数
}
自动填充
创建时间、修改时间!这些个操作一般都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上,而且需要自动化
方式一:数据库级别(工作中不允许修改数据库,所以不建议使用)
1、在表中新增字段create_time,update_time
create_time默认值:CURRENT_TIMESTAMP
update_time默认值:CURRENT_TIMESTAMP 将 更具时间戳更新时间 勾选上
2、再次测试,我们需要先把实体类同步
private Date createTime;
private Date updateTime;
方式二:代码级别
1、删除数据库级别的默认值,更新操作
2、实体类的字段属性上增加注解操作
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3、编写处理器来处理注解
@Component //要是该功能能够使用,需要将其加入到IOC容器中
@Slf4j //加上日志
public class MyDateObjectHandler implements MetaObjectHandler {
//插入式的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ........");
this.setFieldValByName("create_time",new Date(),metaObject);
this.setFieldValByName("update_time",new Date(),metaObject);
}
//更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill ........");
this.setFieldValByName("update_time",new Date(),metaObject);
}
}
4、测试
乐观锁
在面试过程中,我们经常会被问到乐观锁,悲观锁!这个其实非常简单
乐观锁:顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不去上锁!如果出了问题,再次更新值测试
悲观锁:顾名思义十分悲观,他总是认为总是出现问题,无论干什么都会上锁!再去操作!
涉及字段:version 或 new version
主要讲解乐观锁机制!https://baomidou.com/pages/0d93c0/
- 去除记录时,获取当前version
- 更新时,带上这个version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果 version 不对,就更新失败
乐观锁:
1、先查询,获得版本号 version = 1
-- A线程
update user set name = "kuang", version = version + 1
where id = 2 and version = 1
-- B线程抢先修改,使得vsersion = 2,会导致A线程修改失败
update user set name = "kuang", version = version + 1
where id = 2 and version = 1
测试MP的乐观锁(MP是 Mybatis_plus的简称)
1、在数据库中添加 version 字段 设置默认值为1
2、在代码中添加 version 属性
@Version //乐观锁Version注解
private Integer version;
3、注册主件
//扫描我们的mapper文件夹
@MapperScan("com/anyuan/mapper")
@Configuration //代表该类是配置类
@EnableTransactionManagement // 自动管理事务
public class MybatisPlusConfig {
//注册乐观锁插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
4、测试乐观锁
// 测试乐观锁成功案例
@Test
void contextLoad3() {
//1、查询用户信息
User user = userMapper.selectById(1L);
//2、修改用户信息
user.setName("kuangsheng说");
user.setEmail("123456@qq.com");
//3、执行更新操作
userMapper.updateById(user);
}
// 测试乐观锁失败案例!多线程下
@Test
void contextLoad4() {
//线程1
User user = userMapper.selectById(1L);
user.setName("kuangsheng说11111");
user.setEmail("123456@qq.com");
System.out.println(user);
//模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user2.setName("kuangsheng说2222");
user2.setEmail("123456@qq.com");
userMapper.updateById(user2);
userMapper.updateById(user);//如果没有乐观锁,就会覆盖插队线程的值
}
查询操作
//测试查询 查询单个用户
@Test
public void test4(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
//测试查询 查询多个用户
@Test
public void test5(){
List users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
//测试查询 条件查询方式一,使用map操作
@Test
public void test6(){
//使用map封装
HashMap map = new HashMap<>();
//自定义查询
map.put("name", "狂胜说Java");
List users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
分页在网站使用的十分之多
1、原始的limit进行分页
2、pageHelper进行分页 第三方插件
3、MP其实也内置了分页插件
如何使用!
1、配置拦截器组件即可
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//注册乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//注册分页插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
return interceptor;
}
2、直接使用page对象即可
//测试分页查询
@Test
public void test7(){
//参数一 :当前页
//参数二:页面大小
Page page = new Page<>(2, 5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
}
删除操作
基本的删除操作
1、根据id删除记录
//测试删除
@Test
public void test8(){
userMapper.deleteById(1498253637560852487L);
}
//批量删除
@Test
public void test9(){
userMapper.deleteBatchIds(Arrays.asList(1L,3L));
}
//通过map删除
@Test
public void test10(){
Map map = new HashMap();
map.put("id", 2L);
userMapper.deleteByMap(map);
}
逻辑删除
物理删除:从数据库中直接移除
逻辑删除:在数据库中没有被移除,而是通过一个变量让他失效!deleted = 0 => deleted = 1
管理员可以查看被删除的数据!防止数据的丢失,类似于回收站
1、在数据表中增加一个deleted
字段
2、pojo实体类中增加属性
@TableLogic //逻辑删除注解
private Integer deleted;
3、增加配置
文档案例 https://baomidou.com/pages/6b03c5/#步骤-1-配置com-baomidou-mybatisplus-core-config-globalconfig-dbconfig
mybatis-plus:
global-config:
db-config:
logic-delete-field: flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
实际代码操作
#配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
mybatis-plus.global-config.db-config.logic-delete-field=deleted
4、测试一下逻辑删除
性能分析插件
该插件在官方文档中已经被移除
在平时的开发中,会遇到一些满sql。测试!
MP也提供了性能分析插件,如果超过这个时间就停止运行!
1、导入插件
2、测试使用
条件构造器
十分重要:Wrapper
我们写一下复杂的sql就可以使用他来代替
https://baomidou.com/pages/10c804/#abstractwrapper
代码自动生成器
dao、pojo、service、controller都给我自己去编写
官方文档中的使用方法跟视频对不上,具体参考该链接https://blog.csdn.net/qq_42682745/article/details/120626012
使用前需要添加依赖
com.baomidou
mybatis-plus-generator
3.5.1
org.springframework.boot
spring-boot-starter-freemarker
具体代码:
//代码自动生成器
public class anyuanCode {
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8", "root", "123456")
.globalConfig(builder -> {
builder.author("anyuan") // 设置作者
.commentDate("yyyy-MM-dd")//设置时间
// .enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("F:\\idea项目\\zhang_hen\\src\\main\\java"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com.anyuan") // 设置父包名
.entity("pojo")//设置实体类包名
.service("service")//设置service包名
.serviceImpl("service.serviceImpl")//设置实体类包名
.controller("controller")//设置实体类包名
.mapper("mapper")//设置实体类包名
.xml("mapper")//设置mapper.xml包名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, "F:\\idea项目\\zhang_hen\\src\\main\\resources\\mapper")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("user") // 设置需要生成的表名
.addTablePrefix("t_", "c_") // 设置过滤表前缀
.serviceBuilder()//service配置策略
.formatServiceFileName("%sService")//service类名 %s适配,更具表明替换
.formatServiceImplFileName("%sServiceImpl")
.entityBuilder()//实体类适配策略
.enableLombok()//开启Lombok
.logicDeleteColumnName("deleted")//说明逻辑删除字段
.enableTableFieldAnnotation()//属性加上说明注解
.controllerBuilder()//controller策略配置
.formatFileName("%sController")
.enableRestStyle()//开启RestController
.mapperBuilder()//mapper配置策略
.superClass(BaseMapper.class)//继承 BaseMapper
.formatMapperFileName("%sMapper")
.enableMapperAnnotation()//@mapper 开启
.formatXmlFileName("%sMapper");
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
}
以上参考狂神视频:https://www.bilibili.com/video/BV17E411N7KN?from=search&seid=8172637008092965568&spm_id_from=333.337.0.0