本文基于B站UP主【狂神说Java】视频教程【【狂神说Java】MyBatisPlus最新完整教程通俗易懂】进行整理记录,仅用于个人学习、交流使用。
视频地址:https://www.bilibili.com/video/BV17E411N7KN
相关资料:https://gitee.com/kuangstudy/openclass?_from=gitee_search
MyBatisPlus官方地址:https://baomidou.com/
目录标题
一、简介
1.是什么?
官网:https://baomidou.com/
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
MyBatisPlus可以节省我们大量的时间,所有CRUD代码都可以自动完成
同类型工具:JPA, tk-mapper ,MyBatisPlus
偷懒用的!
2.特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
二、快速入门
1.简单使用
地址:https://baomidou.com/guide/quick-start.html#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B
使用第三方插件:
- 导入对应的依赖
- 研究依赖如何配置
- 代码如何编写
- 提高扩展技术能力
步骤
1.创建数据库 mybatis_plus
2.创建数据库
创建表
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)
);
--真实开发环境中,version(乐观锁),deleted(逻辑删除),gmt_create(创建时间),gmt_modified(修改时间)
插入数据
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');
3.编写项目,初始化项目! 使用SpringBoot初始化!
4.导入依赖
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
说明:我们使用mybatis-plus 可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus因为版本有差异!
5.连接数据库!这一步和mybatis相同!
# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver . 需要增加时区的配置 serverTimezone=GMT%2B8
# 向下兼容
spring.datasource.username=codeyuaiiao
spring.datasource.password=3615yuhaijiao
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
6.传统的方式pojo-dao(连接mybatis,配置mapper.xml文件)-service-controller
6.使用了mybatis-plus之后
-
pojo
@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private Integer age; private String email;
-
mapper接口
import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.codeyuaiiao.pojo.User; import org.springframework.stereotype.Repository; //在对应的mapper上面继承基本的类 BaseMapper @Repository//代表持久层 public interface UserMapper extends BaseMapper<User> { //所有CRUD操作都已经编写完成了 //你不需要向以前一样配置一大堆文件了! }
注意点:需要在主启动类MybatisPlusApplication
上扫描我们Mapper包下的所有接口
@MapperScan("com.codeyuaiiao.mapper")
-
测试类中测试
@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
- 方法谁帮我们写的?—mybatis-pluss
2.配置日志
我们所有的sql是不可见的,我们希望知道他是怎么执行的,所以我们必须看日志!
# 配置日志 (默认控制台输出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
含有日志输出
配置完日志之后你会喜欢上mybatis-plus!
三、CRUD扩展
1.插入数据
@Test
public void testInsert(){
User user = new User();
user.setName("zhangsan");
user.setAge(3);
user.setEmail("747557612@qq.com");
int result = userMapper.insert(user);
System.out.println(result);
System.out.println(user);
}
注意点:数据库插入的id默认值为:全局的唯一id
2.主键生成策略
雪花算法(默认) ID_WORKER 全局唯一id
对应数据库中的主键(uuid.自增id.雪花算法.redis.zookeeper)
分布式系统唯一id生成:https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法 (Twitter的snowflake算法)
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0.可以保证几乎全球唯一
主键自增 AUTO
我们需要配置主键自增:
-
实体类字段上
@TableId(type = IdType.AUTO)
@TableId(type = IdType.AUTO) private Long id;
-
数据库字段一定要是自增!
其余源码解释
public enum IdType {
AUTO(0),//数据库ID自增
NONE(1),//该类型为未设置主键类型
INPUT(2),//用户输入ID//该类型可以通过自己注册自动填充插件进行填充
//以下3种类型、只有当插入对象ID 为空,才自动填充。
ID_WORKER(3),//全局唯一ID (idWorker)
UUID(4),//全局唯一ID (UUID)
ID_WORKER_STR(5);//字符串全局唯一ID (idWorker 的字符串表示)
3.更新数据
动态sql
注意:updateById()参数是 一个对象!
//测试更新
@Test
public void testUpdate(){
User user = new User();
user.setId(2L);
user.setName("lisi");
//注意:updateById()参数是 一个对象!
int i = userMapper.updateById(user);//影响行数
System.out.println(i);
}
动态SQL : 所有的sql都是动态帮你配置的
4.自动填充
创建时间 . 修改时间! 这些个操作都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:
所有的数据库表:**gmt_create(创建时间) .gmt_modified(更新时间)**几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别 (在实际开发中并不会使用,实际开发中不允许修改数据库)
1.在表中新增字段 create_time , update_time
2.再次测试插入方法,我们需要先把实体类同步
private Date createTime;
private Date updateTime;
再次更新查看结果即可
方式二:代码级别
1.删除数据库默认值
2.实体类字段属性上添加注解
//记住用util包下的Date!!
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3.编写处理器来处理这个注解
package com.lut.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.测试更新,观察时间即可!
5.乐观锁&悲观锁
乐观锁: 顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不去上锁!如果出现了问题,再次更新值测试
悲观锁;顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!
我们这里主要讲解 乐观锁机制!
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时,set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
操作流程
1.给数据库表添加version字段,默认为1
2.给实体类添加 @version字段
@Version //代表是一个乐观锁
private Integer version;
3.注册组件
新建配置类,注册乐观锁插件
package com.lut.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@MapperScan("com.lut.mapper")
@EnableTransactionManagement
@Configuration //配置类
public class MyBatisPlusConfig {
//注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
}
4.测试乐观锁
//测试乐观锁--失败
@Test
public void TestOptimisticLocker(){
//线程1
User user = userMapper.selectById(1L);
user.setName("wangwu111");
user.setAge(11);
//模拟第二个线程插队
User user2 = userMapper.selectById(1L);
user2.setName("wangwu222");
user2.setAge(22);
userMapper.updateById(user2);
userMapper.updateById(user);
}
没有使用乐观锁:第一个值会覆盖第二个值
**使用乐观锁:**第二个值修改后,第一个值无法再修改
6.查询操作
//测试查询
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
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(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","Tom");
map.put("age","28");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
7.分页查询
分页网站频繁使用
- 原始使用limit进行分页
- pageHelper第三方插件
- MybatisPlus内置了分页插件
如何使用?
-
配置拦截器
// 分页插件 @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); }
-
直接使用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());//总条数 System.out.println(page.hasNext());//是否有下一页 true System.out.println(page.hasPrevious());//是否有上一页 false }
分页查询相关其他几个方法:
8.删除操作
// 测试删除
@Test
public void testdelete(){
userMapper.deleteById(6L);
}
// 测试批量删除
@Test
public void testdeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1287326823914405893L,1287326823914405894L));
}
//通过map删除
@Test
public void testDeleteByMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","zhangsan");
userMapper.deleteByMap(map);
}
我们在工作中会遇到一些问题:逻辑删除!
9.逻辑删除
物理删除:从数据库中直接移除
逻辑删除:在数据库中没有被移除,而是通过一个变量让他生效!deleted=0 --> deleted=1
管理员可以查看被删除的记录!防止数据的丢失!类似于回收站!
开发
-
在数据库表中增加一个deleted字段,默认值为0,代表没有被删除
-
实体类中增加属性
@TableLogic // 逻辑删除 private Integer deleted;
-
配置
// 逻辑删除组件 @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
-
测试删除
本质上是更新操作
-
测试查询
会自动过滤 deleted=1的数据
以上所有的CRUD操作及其扩展操作,我们必须精通掌握!会大大提高工作效率!
四、性能分析插件
我们在平时的开发中,会遇到一些慢sql.
MP也提供了性能分析插件,如果超过这个时间就停止运行!
1.导入插件
//测试性能插件
@Bean
@Profile({"dev","test"}) //设置dev 和 test环境开启
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(1);//超时时间,为了测试设置的时间比较短1ms,实际开发可以设置大一点
//performanceInterceptor.setMaxTime(100);//超时时间
performanceInterceptor.setFormat(true);//SQL语句格式化
return performanceInterceptor;
}
记住在SpringBoot中配置环境为 dev或者test环境
application.properties中添加设置开发环境
#设置开发环境
spring.profiles.active=dev
2.测试查询
@Test
public void testSelectBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
五、条件构造器
详细内容查阅官方文档:https://baomidou.com/guide/wrapper.html
以下内容只做部分测试。
package com.lut;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.lut.mapper.UserMapper;
import com.lut.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;
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
@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对比一下
}
@Test
void test2(){
// 查询名字狂神说
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","狂神说");
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(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 t%
wrapper
.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
// 模糊查询
@Test
void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查询中查出来
wrapper.inSql("id","select id from user where id<3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
//测试六
@Test
void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序
wrapper.orderByAsc("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 等各个模块的代码,极大的提升了开发效率。
只需要改实体类名字 和包名 还有 数据库配置即可
测试:
import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.annotation.FieldFill; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableField; 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;
// 代码自动生成器
public class KuangCode {
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);
gc.setFileOverride(false);
// 是否覆盖
gc.setServiceName("%sService");
// 去Service的I前缀
gc.setIdType(IdType.ID_WORKER);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
//2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/kuang_community? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL); mpg.setDataSource(dsc);
//3、包的配置
PackageConfig pc = new PackageConfig();
//只需要改实体类名字 和包名 还有 数据库配置即可
pc.setModuleName("blog"); pc.setParent("com.kuang");
pc.setEntity("entity"); pc.setMapper("mapper");
pc.setService("service"); pc.setController("controller");
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("blog_tags","course","links","sys_settings","user_record"," user_say");
// 设置要映射的表名
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);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate); tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);
// localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); //执行
}
}
七、出现的BUG
1.UnsatisfiedDependencyException
UnsatisfiedDependencyException: Error creating bean with name ‘userMapper’ defined
参考博客:https://blog.csdn.net/qq_41870790/article/details/102989523
问题原因
mysql依赖版本太低
解决办法
原依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.41</version>
</dependency>
12345
方法一:修改原来的 依赖版本为5.1.41为更高的版本 我修改为6.0.6
方法二:直接将<version>去掉,不指定版本那么会默认使用spring-boot-starter指定的版本
2.模板依赖
3.0.7版本移除 对 mybatis-plus-generator 包的依赖,自己按需引入,尽在还需要导入模板依赖,
<!-- 模板引擎 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
作者:耿鬼不会笑
时间:2021年2月