MybatisPlus简讲 -- 狂神说JAVA版
MybatisPlus 简讲
- 快速入门
- 配置日志
- CRUD扩展
- Insert 插入
- 主键生成策略
- 更新操作
- 自动填充
- 乐观锁
- 查询操作
- 分页查询
- 删除操作
- 逻辑删除
- 性能分析插件
- 条件构造器
- 代码自动生成
快速入门
-
创建数据库
mybatis_plus
-
创建 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) ); ## 插入数据 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> </dependency> <!-- lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!--mybatisPlus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.5</version> </dependency>
-
-
链接数据库
-
# mysql 5 驱动不同 spring.datasource.username=root spring.datasource.password=root spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver # mysql 8 驱动不同,需要增加时区的配置 serverTimezone=GMT%2B8
-
-
mybatis || mybatisPlus
-
传统方式pojo-dao (链接mybatis,配置mapper.xml文件)-service-controller
-
使用了Mybatis-Plus之后
-
pojo
package com.ytzl.pojo; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @Data @AllArgsConstructor @NoArgsConstructor public class User { private long id; private String name; private Integer age; private String email; public User(String name, Integer age, String email) { this.name = name; this.age = age; this.email = email; } }
-
mapper接口
package com.ytzl.mapper; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.ytzl.pojo.User; import org.springframework.stereotype.Repository; // 在对应的 mapper 上面继承基本的接口 BaseMapper @Repository // 代表持久层 public interface UserMapper extends BaseMapper<User> { }
-
注意点:我们需要在主启动类上去扫描我们的 mapper 包下的所有接口
@MapperScan("com.ytzl.mapper")
-
测试类中的测试
package com.ytzl; import com.ytzl.mapper.UserMapper; import com.ytzl.pojo.User; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import java.util.List; @SpringBootTest class Poject1NewMybatisPlusApplicationTests { @Autowired private UserMapper userMapper; @Test void contextLoads() { // 参数是一个 Warpper 条件构造器,这里我们先不用 null // 查询全部用户 List<User> users = userMapper.selectList(null); users.forEach(System.out::println); } }
-
结果
-
-
配置日志
我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以我们必须看日志!
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后,后面的学习就需要注意这个自动生成的SQL,就会喜欢mybatis-plus
CRUD扩展
Insert 插入
//测试插入
@Test
public void testInsert(){
User user = new User("杨清壹",20,"1691495957@qq.com");
// 自动生成 id
int result = userMapper.insert(user);
System.out.println("受影响的行数: "+result);
System.out.println("User==>"+user);
}
数据库插入的 id 的默认值为 :全局的唯一 id
主键生成策略
@TableId(type = IdType.XXX)
private long id;
默认ID_WORKER 全局唯一ID
分布式系统唯一 id 生成策略:https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法:
-
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。
-
其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。
主键自增
我们需要配置主键自增:
- 实体类字段上
@TableId(type = IdType.AUTO)
- 数据库字段一定要是自增
3、再次测试插入即可
其余的源码解释
public enum IdType {
AUTO(0),// 数据库id自增
NONE(1),// 未设置主键
INPUT(2),// 手动输入
ID_WORKER(3),// 默认的全局 id
UUID(4),// 全局唯一id uuid
ID_WORKER_STR(5); // ID_WORKER 字符串表示法
}
更新操作
//测试更新
@Test
public void testUpdate(){
// 根据对象中的id 更新对象中的新数据
// 通过条件自动拼接 动态SQL
User user = new User(7,"孔智超",18,"1213456783@qq.com");
// 注意: 虽然名字叫upDataById 但参数是一个对象
userMapper.updateById(user);
}
所有的sql都是自动配置的
自动填充
创建时间,修改时间! 这些个操作一般都是自动化完成的,不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_creat、gmt_modified 几乎所有的表都要配置上!而且需要自动化
方式一: 数据库级别(工作中不允许使用)
1、在表中新增字段 creat_time,update_time
2、再次测试插入方法,我们需要先把实体类同步!
private Date creatTime;
private Date updateTime;
3、再次更新查看结果即可
方式二: 代码级别
- 删除数据库的默认值
2、实体类字段上加入注解
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date creatTime;
// 字段添加或修改时,填充内容
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3、编写处理器来处理这个注解即可
package com.ytzl.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.util.Date;
@Slf4j
@Component // 一定不要忘记把处理器加到IOC容器中!
public class MyMetaObjectHandler implements MetaObjectHandler {
// 插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill....");
this.setFieldValByName("creatTime",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);
}
}
4、测试插入
5、测试更新、观察时间即可
乐观锁
在面试过程中,经常会被问到乐观锁,悲观锁!
乐观锁: 顾名思义十分乐观,它总是认为不会出现问题,无论干什么都不会去上锁,如果出现了问题,就再次更新值测试
悲观锁: 顾名思义十分悲剧,他总是认为总是会出现问题,无论干什么都会上锁再去操作
乐观锁实现方式:
- 取出记录时,获取当前 version
- 更新时,带上这个 version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果 version 不对,就更新失败
乐观锁:
1、先查询,获得版本号 > version = 1
-- A 线程
update user set name = "哥们" , version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成,这个时候版本会+1,也就是 version = 2 ,会导致 A 修改失败
update user set name = "哥们" , version = version + 1
where id = 2 and version = 1
测试一下 MP 的乐观锁插件
- 给数据库中增加 version 字段
2、完善实体类
@Version // 乐观锁Version注解
private Integer version;
3、注册组件
package com.ytzl.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
// 扫描我们的mapper文件夹
@MapperScan("com.ytzl.mapper")
@EnableTransactionManagement // 自动控制事务
@Configuration // 配置类
public class MyBatisPlusConfig {
// 注册乐观锁插件
/**
* 旧版
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
4、测试一下
// 测试乐观锁成功
@Test
public void testOptimisticLocker1(){
// 1.查询用户信息
User user = userMapper.selectById(2L);
// 2.修改用户信息
user.setName("张展鹏");
user.setAge(20);
// 3.执行更新操作
userMapper.updateById(user);
}
// 测试乐观锁失败 多线程下
@Test
public void testOptimisticLocker2(){
// 线程1
User user = userMapper.selectById(3L);
user.setName("田洪源");
user.setAge(18);
// 模拟另外一个线程插队操作
User user2 = userMapper.selectById(3L);
user2.setName("陶培峰");
user2.setAge(22);
userMapper.updateById(user2); // 线程插队
// 自选锁进行测试
userMapper.updateById(user); // 如果没有乐观锁,就会覆盖插队线程的值
}
查询操作
/**
* 测试查询
*/
@Test
public void testSelectById(){
User user = userMapper.selectById(2);
System.out.println(user);
}
/**
* 测试批量查询
*/
@Test
public void testSelectByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
/**
* 按条件查询 map
*/
@Test
public void testSelectByBatchIds(){
HashMap<String, Object> map = new HashMap<>();
// 自定义查询
map.put("name","张展鹏");
map.put("age",20);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
分页在网站使用的十分之多!
- 原始的 limit 分页
- pageHelper 第三方插件
- MP 内置分页插件
如何使用!
- 配置拦截器组件即可
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
2、直接使用Page对象即可
/**
* 测试分页查询
*/
@Test
public void testPage(){
// 参数一: 当前页
// 参数二: 页面大小
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println("数据总条数:"+page.getTotal());
}
删除操作
基本的删除操作
/**
* 测试删除
*/
@Test
public void testDeleteById(){
userMapper.deleteById(4L);
}
/**
* 批量删除
*/
@Test
public void testDeleteByBatchId(){
userMapper.deleteBatchIds(Arrays.asList(3,5));
}
/**
* 按条件删除
*/
@Test
public void testDeleteByBatchNames(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","张展鹏");
map.put("age",18);
userMapper.deleteByMap(map);
}
我们在工作中会遇到一些问题: 逻辑删除!
逻辑删除
物理删除:从数据库中直接移除 deleted = 0
逻辑删除:从数据库中没有被移除,而是通过一个变量来让它失效! deleted = 0 => deleted =>1
管理员可以查看被删除的记录!防止数据丢失,类似于回收站
测试一下:
- 在数据表中,增加一个 deleted 字段
2、实体类中增加属性
@TableLogic // 逻辑删除
private Integer deleted;
3、配置
/**
* 逻辑删除
*/
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value= 1
mybatis-plus.global-config.db-config.logic-not-delete-value= 0
4、测试一下删除
记录依旧在数据库,但是值确已经变化了
再次查询测试
性能分析插件
在平时的开发中,会遇到一些慢sql。测试! druid
作用:性能分析拦截器,用户输出每条 SQL 语句及其执行时间
MP也提供了性能分析插件,如果超过这个时间就会停止运行
-
导入插件
/** * SQL 执行效率插件 */ @Bean @Profile({"dev","test"}) // 设置dev test 环境开启,保证我们的效率 public PerformanceInterceptor performanceInterceptor(){ PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); performanceInterceptor.setMaxTime(1); // 设置SQL 执行的最大时间,如果超过了就不执行 performanceInterceptor.setFormat(true); return new PerformanceInterceptor(); }
注意:要在 SpringBoot 中配置环境为 dev 或test 环境
# 设置开发环境 spring.profiles.active=dev
-
测试使用
/** * 按条件查询 map */ @Test public void testSelectByBatchIds(){ HashMap<String, Object> map = new HashMap<>(); // 自定义查询 map.put("name","张展鹏"); map.put("age",20); List<User> users = userMapper.selectByMap(map); users.forEach(System.out::println); }
使用性能分析插件,可以帮助我们提高效率!
条件构造器
十分重要:Wrapper
我们写一些复杂的 sql 就可以使用它来替代!
1、测试一
/**
* 查询全部用户
*/
@Test
void contextLoads() {
//查询 name 不为空的用户,并且邮箱不为空的用户,年龄大于等于12岁的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);//和我们的map对比一下
}
2、测试二
/**
* 查询 name 为 杨清壹 的用户
*/
@Test
void test2(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","杨清壹");
User user = userMapper.selectOne(wrapper); // 查询一个数据,出现多个结果使用List 或者 map
System.out.println(user);
}
3、测试三
/**
* 查询 age 在20-30之间的用户数量
*/
@Test
void test3(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30); // 区间
Integer selectCount = userMapper.selectCount(wrapper);// 查询结果数
System.out.println(selectCount);
}
4、测试四
/**
* 模糊查询
*/
@Test
void test4(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 左查询百分号在左边 %1 表示1结尾的数据/右查询百分号在右边 1% 表示1开头的数据
wrapper
.notLike("name","蒋")
.likeRight("email","1");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
5、测试五
/**
* 子查询 拼接sql查询
*/
@Test
void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查询中查出来
wrapper.inSql("id","select id from user where id<10");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
6、测试六
/**
* 降序排序
*/
@Test
void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过 id 进行排序
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
代码自动生成
dao、pojo、service、controller都自己编写生成!
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
1、第一步,导入依赖
<!-- 数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- mybatisPlus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!-- 自动生成依赖-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
2、第二步,编写配置
server.port=1011
# 开发环境
spring.profiles.active=dev
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
# 配置数据库
spring.datasource.name=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
3、第三步,编写代码
//构建代码生成器对象
AutoGenerator autoGenerator = new AutoGenerator();
/*配置策略*/
//全局配置
GlobalConfig config = new GlobalConfig();
//代码生成的目录
String path = System.getProperty("user.dir");
//设置代码最终输出的目录
config.setOutputDir(path+"");
//设置作者
config.setAuthor("");
//配置是否打开目录,false 为不打开
config.setOpen(false);
//是否覆盖已有的
config.setFileOverride(false);
//去除service前缀
config.setServiceName("%sService");
//主键
config.setIdType(IdType.ID_WORKER);//默认的
//设置时间类型
config.setDateType(DateType.ONLY_DATE);//只显示日期
//是否生成Swagger文档
config.setSwagger2(false);
//设置策略
autoGenerator.setGlobalConfig(config);
/*设置数据源*/
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver"); //驱动
dataSourceConfig.setUrl(""); //连接地址
dataSourceConfig.setUsername(""); //数据库名
dataSourceConfig.setPassword(""); //数据库密码
dataSourceConfig.setDbType(DbType.MYSQL); //数据库类型
//设置数据源
autoGenerator.setDataSource(dataSourceConfig);
/*项目包的配置*/
PackageConfig packageConfig = new PackageConfig();
packageConfig.setModuleName("yy");//模块名
packageConfig.setParent("com.yy");//设置父目录
packageConfig.setEntity("pojo");//实体类包名
packageConfig.setMapper("mapper");//mapper映射文件包名
packageConfig.setService("service");//业务接口包名
packageConfig.setServiceImpl("serviceIml");//业务层实现类包名
packageConfig.setController("controller");//控制层包名
//添加项目包配置
autoGenerator.setPackageInfo(packageConfig);
/*策略配置*/
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude();//表名
strategyConfig.setNaming(NamingStrategy.underline_to_camel);//配置数据表与实体类名之间映射的策略
strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);//配置数据表的字段与实体类的属性名之间映射的策略
strategyConfig.setEntityLombokModel(true);//是否启用Lombok
strategyConfig.setLogicDeleteFieldName("");//逻辑删除字段名
TableFill field1 = new TableFill("**",null);//自动填充的字段 -数据插入时间
TableFill field2 = new TableFill("**",null);//自动填充的字段 -数据修改时间
//自动填充配置集合
ArrayList<TableFill> list = new ArrayList<>();
list.add(field1);
list.add(field2);
strategyConfig.setTableFillList(list);
strategyConfig.setVersionFieldName("version");//乐观锁
strategyConfig.setRestControllerStyle(true);//配置 rest风格的控制器
strategyConfig.setControllerMappingHyphenStyle(true);//配置驼峰转连字符
//添加策略配置
autoGenerator.setStrategy(strategyConfig);
//执行
autoGenerator.execute();
4、第四步,查看效果