MybatisPlus学习笔记
1.简介
MyBatis-Plus (简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
特性:
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
2.快速开始
创建数据库mybatis_plus:
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');
创建Spring boot工程:
导入依赖:
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
编写配置文件:
# 应用名称
spring.application.name=mybatisplus
# 应用服务 WEB 访问端口
server.port=8002
spring.datasource.username=root
spring.datasource.password=root12345
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
spring.datasource.driver-class-name= com.mysql.cj.jdbc.Driver
创建实体类:
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
编写mapper接口:
package com.candy.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.candy.pojo.User;
@Repository
public interface UserMapper extends BaseMapper<User> {
}
然后在启动类中加注解,扫描mapper文件夹:
@MapperScan("com.candy.mapper")
测试:
@SpringBootTest
class MybatisplusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//参数是一个wapper 条件构造器
List<User> userLists= userMapper.selectList(null);
userLists.forEach(System.out::println);
}
}
查询成功!!!
3.配置日志
现在sql是不可见的,但是我们希望可以看到是怎么执行的
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
标准日志——StdOutImpl
测试:
4.插入测试及雪花算法
4.1 CRUD扩展
insert 插入
测试:
@Test
public void tInsert(){
User user =new User();
user.setName("tnt");
user.setAge(2);
user.setEmail("11@qq.com");
int re = userMapper.insert(user);
System.out.println(re);
System.out.println(user);
}
主键生成策略:
对应数据库中的主键(uuid、自增id、雪花算法、redis、zookeeper)
分布式系统唯一id生成方案:https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法(snowflake):
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。雪花算法支持的TPS可以达到419万左右(2^22*1000)。
主键自增:
数据库对应字段应该设置自增,要不然会报错:
测试:
源码分析:
update更新
所有sql语句都是动态拼接的!!
public void tUpdate(){
User user =new User();
user.setId(6L);
user.setName("宋亚轩");
user.setAge(18);
user.setEmail("11@qq.com");
int i = userMapper.updateById(user);
System.out.println(i);
System.out.println(user);
}
自动填充
创建时间、修改时间都是自动化完成的!
方式一:数据库级别(不建议使用)
1.在项目中增加create_time、update_time
2.更新实体类:
3.测试:
方式二:代码级别
1.删除数据库默认值,更新操作:
2.实体类字段属性上增加注解:
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3.编写注解处理器:
package com.candy.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.util.Date;
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill ....");
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
测试:
@Test
public void tInsert(){
User user =new User();
user.setName("aqiu");
user.setAge(11);
user.setEmail("zeze@qq.com");
int re = userMapper.insert(user);
System.out.println(re);
System.out.println(user);
}
done!:happy:
乐观锁:顾名思义,它总是认为不会出现问题,无论干什么都不去上锁。如果出现问题,再次更新值测试
悲观锁:顾名思义,它总是认为会出现问题,无论干什么都会上锁,再去操作
乐观锁实现方式:
- 取出记录时,获取当前 version
- 更新时,带上这个 version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果 version 不对,就更新失败
举个例子🌰:
乐观锁:1.先查询,获得版本号 version = 1(version = xxx)
2.更新记录使version= version +1
update user set name="tnt",version = version +1
where id =1 and version =1;
测试:
1.增加version字段:
2.实体类添加属性并加注解:
@Version
private Integer version;
3.注册组件:
@MapperScan("com.candy.mapper")
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
//注册插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//乐观锁
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
注:上面的方法来自官网
4.测试:
@Test
public void tLeguan(){
//查询用户信息
User user = userMapper.selectById(5L);
//修改用户信息
user.setName("丁程鑫");
user.setEmail("22@qq.com");
//执行更新操作
userMapper.updateById(user);
}
select查询
测试查询多个用户:
@Test
public void tSelectBatch(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1,2,3));
System.out.println(users);
}
测试条件查询:
@Test
public void tTiaojian(){
HashMap<String,Object> map =new HashMap<>();
//自定义查询
map.put("name","时代少年团");
map.put("age",2);
List<User> user = userMapper.selectByMap(map);
user.forEach(System.out::println);
}
分页查询
1.原始的limit
2.第三方插件pageHeloer
3.Mybatisplus分页插件
Mybatisplus分页插件:
1.配置拦截器组件
//注册插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//乐观锁
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//分页
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
2.直接使用page对象即可
@Test
public void tPage(){
//参数:当前页,页面长度
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page,null);
System.out.println(page);
}
delete删除
测试批量删除:
@Test
public void tDelete(){
userMapper.deleteBatchIds(Arrays.asList(2,3));
}
逻辑删除:在数据库中没有移除,而是通过一个变量来让它失效!类似于回收站!
物理删除:从数据库中直接移除
1.在数据库表中添加增加is_delete字段:
2.实体类中添加属性:
@TableLogic
private Integer isDelete;
3.配置:
#配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4.测试:
@Test
public void tDelete(){
userMapper.deleteBatchIds(Arrays.asList(1,4));
}
4.2 条件构造器Wrapper
条件查询测试:
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//查询name、email并且age>2不为空的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age",18);
userMapper.selectList(wrapper).forEach(System.out::println);
}
}
模糊查询测试:
@Test
void test3() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.notLike("name","鑫")//名字不包含鑫
.likeRight("email","1");//邮箱以1开头
userMapper.selectMaps(wrapper).forEach(System.out::println);
}
4.3 代码生成器(3.5.1版本)
public static void main(String[] args) {
//1、配置数据源
FastAutoGenerator.create("jdbc:mysql://localhost:3306/数据库名", "root", "root123456")
//2、全局配置
.globalConfig(builder -> {
builder.author("SixCandy") // 设置作者名
.outputDir(System.getProperty("user.dir") + "/src/main/java") //设置输出路径:项目的 java 目录下
.commentDate("yyyy-MM-dd hh:mm:ss") //注释日期
.dateType(DateType.ONLY_DATE) //定义生成的实体类中日期的类型 TIME_PACK=LocalDateTime;ONLY_DATE=Date;
.fileOverride() //覆盖之前的文件
.enableSwagger() //开启 swagger 模式
.disableOpenDir(); //禁止打开输出目录,默认打开
})
//3、包配置
.packageConfig(builder -> {
builder.parent("com") // 设置父包名
.moduleName("mp") //设置模块包名
.entity("entity") //pojo 实体类包名
.service("service") //Service 包名
.serviceImpl("serviceImpl") // ***ServiceImpl 包名
.mapper("mapper") //Mapper 包名
.xml("mapper") //Mapper XML 包名
.controller("controller") //Controller 包名
.other("utils") //自定义文件包名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir")+"/src/main/resources/mapper")) //配置 mapper.xml 路径信息:项目的 resources 目录下
})
//4、策略配置
.strategyConfig(builder -> {
builder.addInclude("user", "student") // 设置需要生成的数据表名
.addTablePrefix("t_", "c_") // 设置过滤表前缀
//4.1、Mapper策略配置
.mapperBuilder()
.superClass(BaseMapper.class) //设置父类
.formatMapperFileName("%sMapper") //格式化 mapper 文件名称
.enableMapperAnnotation() //开启 @Mapper 注解
.formatXmlFileName("%sXml"); //格式化 Xml 文件名称
//4.2、service 策略配置
.serviceBuilder()
.formatServiceFileName("%sService") //格式化 service 接口文件名称,%s进行匹配表名,如 UserService
.formatServiceImplFileName("%sServiceImpl") //格式化 service 实现类文件名称,%s进行匹配表名,如 UserServiceImpl
//4.3、实体类策略配置
.entityBuilder()
.enableLombok() //开启 Lombok
.disableSerialVersionUID() //不实现 Serializable 接口,不生产 SerialVersionUID
.logicDeleteColumnName("deleted") //逻辑删除字段名
.naming(NamingStrategy.underline_to_camel) //数据库表映射到实体的命名策略:下划线转驼峰命
.columnNaming(NamingStrategy.underline_to_camel) //数据库表字段映射到实体的命名策略:下划线转驼峰命
.addTableFills(
new Column("create_time", FieldFill.INSERT),
new Column("modify_time", FieldFill.INSERT_UPDATE)
) //添加表字段填充,"create_time"字段自动填充为插入时间,"modify_time"字段自动填充为插入修改时间
.enableTableFieldAnnotation() // 开启生成实体时生成字段注解
//4.4、Controller策略配置
.controllerBuilder()
.formatFileName("%sController") //格式化 Controller 类文件名称,%s进行匹配表名,如 UserController
.enableRestStyle() //开启生成 @RestController 控制器
})
//5、模板
.templateEngine(new VelocityTemplateEngine())
/*
.templateEngine(new FreemarkerTemplateEngine())
.templateEngine(new BeetlTemplateEngine())
*/
//6、执行
.execute();
}