mybatis-plus
基本介绍
网址: https://mp.baomidou.com/guide/
作用: 所有的CRUD代码它都自动化了
同类: JPA、tk-mapper
特性:
1、无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
2、损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
3、强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
4、支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
5、支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
6、支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
7、支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
8、内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
9、内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
10、内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
11、内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速入门
使用第三方组件步骤介绍:
1、导入对应的依赖
2、研究依赖如何配置
3、代码如何编写
4、提高扩展技术能力!
快速入门步骤:
1、创建数据库mybatis_plus
CREATE DATABASE IF NOT EXISTS mybatis_plus
DEFAULT CHARACTER SET utf8mb4
DEFAULT COLLATE utf8mb4_0900_ai_ci;
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 )
);
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、导入依赖
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus是自己开发的,并非官方的!使用低版本为了看到原生的开发-->
<!--尽量不要同时导入mybatis-plus和mybatis,会存在版本差异-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
5、连接数据库!这一步和 mybatis 相同!
############################################################
# mysql 5数据库驱动com.mysql.jdbc.Driver
# mysql 8数据库驱动com.mysql.cj.jdbc.Driver(兼容低版本的数据库) 需要添加时区的配置 serverTimezone=GMT%2B8
############################################################
spring:
datasource:
username: root
password: root
url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
driver-class-name: com.mysql.cj.jdbc.Driver
6、传统方式pojo-dao(连接mybatis,配置mapper.xml文件)-service-controller,但是使用了mybatis-plus 之后
- pojo实体类
package com.keke.pojo;
import com.baomidou.mybatisplus.annotation.*;
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;
}
- mapper接口
package com.keke.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.keke.pojo.User;
import org.springframework.stereotype.Repository;
//在对应的Mapper上面继承基本的类BaseMapper
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
//所有的CRUD操作都已经编写完成了
//不需要像以前配置一大堆文件了
}
- 注意:需要在主启动类上扫描mapper包下所有的接口
package com.keke;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
//扫描mapper文件夹,也可以在每个mapper上都加上@Mapper注解,效果是一样的
@MapperScan("com.keke.mapper") //扫描mapper文件夹
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
- 测试类中测试
@SpringBootTest
class MybatisPlusApplicationTests {
// 继承了BaseMapper,所有的方法都来自父类
// 也可以编写自己的扩展方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//查询全部用户
//参数是一个Wrapper,条件构造器,这里先不用,null:表示查询所有用户
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
配置日志
我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以我们必须要看日志!
############################################################
# 配置日志
############################################################
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
CRUD扩展
插入操作
//测试插入
@Test
public void testInsert() {
User user = new User();
user.setName("柯柯不会Java");
user.setAge(3);
user.setEmail("1913422836@qq.com");
int result = userMapper.insert(user); //帮我们自动生成id
System.out.println(result); //受影响的行数
System.out.println(user); //发现id会自动回填
}
数据库插入的id的默认值为:全局的唯一id
主键生成策略
- 对应数据库中的主键(uuid、自增id、雪花算法、redis生成、zookeeper生成)
- 雪花算法:snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心:如北京、上海等,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生4096个 ID),最后还有一个符号位,永远是0。可以保证几乎全球唯一。具体实现的代码可以参看https://github.com/twitter/snowflake。
- @TableId注解
- 1.type = IdType.ID_WORKER:默认,全局唯一id,底层即雪花算法
- 2.type = IdType.AUTO:主键自增,该配置需要数据库字段一定要是自增
- 3.type = IdType.NONE:未设置主键
- 4.type = IdType.INPUT:手动输入,一旦手动输入id,就需要自己配置id了
- 5.type = IdType.UUID:全局唯一id uuid
- 6.type = IdType.ID_WORKER_STR:ID_WORKER的字符串表示法
- 自增为例
1、实体类的id属性上配置
@TableId(type = IdType.AUTO)
private Long id;
2、数据库字段一定要是自增!
3、再次测试插入即可!
更新操作
//测试更新
@Test
public void testUpdate() {
User user = new User();
//通过条件自动拼接动态sql
user.setId(1374336286617268228L);
user.setName("柯柯真的不会Java");
user.setAge(20);
//注意:updateById 但是参数是一个 对象
int result = userMapper.updateById(user);
System.out.println(result);
}
自动填充
创建时间、修改时间!这些个操作一遍都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!
- 方式一:数据库级别(工作中不建议使用,因工作中不允许修改数据库)
1、在表中新增字段create_time、update_time,并设置create_time、update_time的数据类型为datetime,默认值为CURRENT_TIMESTAMP,update_time设置为自动更新
2、再次测试插入方法,我们需要先把实体类同步!
private Date createTime;
private Date updateTime;
3、再次更新查看结果即可
- 方式二:代码级别
1、删除数据库的默认值、更新操作!
2、实体类字段属性上需要增加注解
//字段添加填充内容
@TableField(fill = FieldFill.INSERT) //表示添加的时候自动填充
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) //表示添加或更改的时候自动填充
private Date updateTime;
fill数值解释:(代码为官方包内)
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.baomidou.mybatisplus.annotation;
public enum FieldFill {
DEFAULT, // 默认不处理
INSERT, // 表示添加的时候自动填充
UPDATE, // 表示更改的时候自动填充
INSERT_UPDATE; // 表示添加或更改的时候自动填充
private FieldFill() {
}
}
3、编写处理器来处理这个注解即可!
package com.keke.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("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);
}
}
4、测试插入
5、测试更新、观察时间即可!
乐观锁
在面试过程中,我们经常会被问道乐观锁,悲观锁!这个其实非常简单!
**乐观锁 : **故名思意十分乐观,它总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试
**悲观锁:**故名思意十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作!
乐观锁实现方式:
-
取出记录时,获取当前 version
-
更新时,带上这个version
-
执行更新时, set version = newVersion where version = oldVersion
-
如果version不对,就更新失败
例:A线程在执行时,还没有确定,B线程抢先完成了,这个时候version=2,会导致A修改失败
-- A线程
update user name = 'kuangshen', version = version + 1 where id = 2 and version = 1;
-- B线程
update user name = 'kuangshen', version = version + 1 where id = 2 and version = 1;
测试mybatis—plus的乐观锁插件
1、给数据库中增加version字段!数据类型为int,默认为1
2、实体类加对应的字段
@Version //乐观锁的version注解
private Integer version;
3、注册组件
package com.keke.config;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.transaction.annotation.EnableTransactionManagement;
//扫描mapper文件夹,也可以在每个mapper上都加上@Mapper注解,效果是一样的,因为有了配置类,故可以把该注解移到这
@MapperScan("com.keke.mapper") //扫描mapper文件夹
@EnableTransactionManagement //自动管理事务,默认也是开启的
@Configuration //配置类
public class MybatisPlusConfig {
//springboot 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
4、测试一下!
//测试乐观锁成功
@Test
public void testOptimisticLocker() {
//1.查询用户信息
User user = userMapper.selectById(1L);
//2.修改用户信息
user.setName("keke");
user.setEmail("1913422836@qq.com");
//3.执行更新操作
userMapper.updateById(user); //先会执行查询操作,查出version的值,然后在修改的时候带上version的条件进行修改
}
//测试乐观锁失败 多线程下
@Test
public void testOptimisticLocker2() {
//线程1
User user = userMapper.selectById(1L);
user.setName("keke111");
user.setEmail("1903422836@qq.com");
//模拟另一个线程执行插队操作
User user2 = userMapper.selectById(1L);
user2.setName("keke222");
user2.setEmail("1903422836@qq.com");
userMapper.updateById(user2);
//可以使用自旋锁来多次尝试提交
userMapper.updateById(user); //如果没有乐观锁就会覆盖插队线程的值
}
查询操作
//测试查询
@Test
public void testSelectById() {
User user = userMapper.selectById(3L);
System.out.println(user);
}
//测试批量查询
@Test
public void testSelectBatchId() {
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
//按条件查询之一使用map操作
@Test
public void testSelectBatchIds() {
Map<String, Object> map = new HashMap<>();
//自定义查询条件
map.put("name", "柯柯不会Java");
map.put("age", 3);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
1、原始的 limit 进行分页
2、pageHelper 第三方插件
3、mybatis_plus 其实也内置了分页插件!
- 如何使用
1、配置拦截器组件,即在MybatisPlusConfig中添加如下代码
//分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
2、直接使用Page对象即可!
//测试分页查询
@Test
public void testPage() {
//参数一:当前页
//参数二:页面大小也变得简单了
//使用了分页插件之后,所有的分页操作
Page<User> page = new Page<>(2,5);
//效率其实并不高,因为查询之前会先进行总数的查询,但分页操作都会这样做
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
删除操作
//测试删除 \ 测试逻辑删除
@Test
public void testDeleteById() {
userMapper.deleteById(3L);
}
//通过id批量删除
@Test
public void testDeleteBatchId() {
userMapper.deleteBatchIds(Arrays.asList(1374336286617268227L, 1374336286617268226L));
}
//通过map删除
@Test
public void testDeleteMap() {
Map<String, Object> map = new HashMap<>();
map.put("name", "狂神说Java");
userMapper.deleteByMap(map);
}
逻辑删除
物理删除∶从数据库中直接移除
逻辑删除∶再数据库中没有被移除,而是通过一个变量来让他失效! deleted = 0 => deleted = 1
管理员可以查看被删除的记录,防止数据丢失,类似于回收站
测试一下:
1、在数据表中增加一个 deleted 字段,数据类型为int,默认为0
2、实体类中增加属性
@TableLogic //逻辑删除
private Integer deleted;
3、配置逻辑删除组件
// 逻辑删除组件!
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
############################################################
# 配置逻辑删除
############################################################
global-config:
db-config:
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
4、测试一下删除!
//测试删除 \ 测试逻辑删除
@Test
public void testDeleteById() {
userMapper.deleteById(3L);
}
结果:记录依旧在数据库,但是值确已经变化了
注意:后续查询的时候会自动过滤被逻辑删除的字段
性能分析插件
我们在平时的开发中,会遇到一些慢sql。测试! druid…
作用:性能分析拦截器,用于输出每条 SQL 语句及其执行时间
MP也提供性能分析插件,如果超过这个时间就停止运行!
1、导入插件
//sql执行效率插件
@Bean
@Profile({"dev", "test"}) //设置dev test环境开启,保证效率
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
//比如在工作中不允许执行时间超过1000ms的sql,可以在这里配置,只要超过规定的时间就会抛出异常
performanceInterceptor.setMaxTime(100); //ms 设置sql最大时间,如果超过了则不执行
performanceInterceptor.setFormat(true); //设置是否格式化sql,即控制台输出sql更加清晰
return performanceInterceptor;
}
记住,要在SpringBoot中配置环境为dev或者 test 环境!
2、测试使用
@Test
void contextLoads() {
//查询全部用户
//参数是一个Wrapper,条件构造器,这里先不用,null:表示查询所有用户
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
使用性能分析插件,可以帮助我们提高效率!
条件构造器
package com.keke;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.keke.mapper.UserMapper;
import com.keke.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;
import java.util.Map;
/**
* 条件查询器Wrapper
*/
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于20
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age", 20);
userMapper.selectList(wrapper).forEach(System.out::println); //和我们学习的map对比一下
}
@Test
void test2() {
//查询名字狂神说
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "柯柯不会Java");
User user = userMapper.selectOne(wrapper); //查询一个数据,出现多个结果使用list或者map
System.out.println(user);
}
@Test
void test3() {
//查询年龄在20~30岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 20, 30); //区间
Integer count = userMapper.selectCount(wrapper); //查询结果数
System.out.println(count);
}
//模糊查询
@Test
void test4() {
//查询name中不包含"e"且email中以t开头的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.notLike("name", "e")
.likeRight("email", "t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
@Test
void test5() {
//查询id小于3的用户,其中id在子查询中查出来
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id", "select id from user where id < 3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
@Test
void test6() {
//通过id降序排序查询用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
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 等各个模块的代码,极大的提升了开发效率。
测试:
package com.keke;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
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;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
import java.util.List;
public class AutoGenerateDataTest {
public static void main(String[] args) {
// 需要构建一个 代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
// 配置策略
// 1、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir"); // 获取当前系统的目录
gc.setOutputDir(projectPath+"/src/main/java"); // 输出目录
gc.setAuthor("柯柯"); // 生成作者注释
gc.setOpen(false); // 是否打开资源管理器,就是window文件夹
gc.setFileOverride(false); // 是否覆盖原来生成的
gc.setServiceName("%sService"); // 去掉所有Service的I前缀
gc.setIdType(IdType.ID_WORKER); // 主键策略
gc.setDateType(DateType.ONLY_DATE); // 日期类型
gc.setSwagger2(true); // 自动配置Swagger2文档
mpg.setGlobalConfig(gc);
// 2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog"); // 模块名
pc.setParent("com.keke"); // 即生成com.keke.blog的模块
pc.setEntity("entity"); // 实体类的命名
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
// 4.策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user"); // 设置要映射的表名,可传多个
strategy.setNaming(NamingStrategy.underline_to_camel); // 表名的命名为下划线_转驼峰命名
strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 数据库字段的命名为下划线_转驼峰命名
strategy.setEntityLombokModel(true); // 自动Lombok注解配置
strategy.setLogicDeleteFieldName("deleted"); // 设置逻辑删除字段
// 自动填充配置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
List<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
//乐观锁设置
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true); // 开启驼峰命名
strategy.setControllerMappingHyphenStyle(true); // 开启controller层的下划线命名,
// 例localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); // 执行
}
}
注:本文为学习狂神说老师讲解的mybatis_plus课程后的笔记内容,如有错误,欢迎批评指正!