MyBatis-Plus长文图解笔记

崔笑颜

发布于 2020-12-07 09:39:30

2150

发布于 2020-12-07 09:39:30

简介

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生
愿景我们的愿景是成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。

特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

框架结构

快速入门

创建数据库表（mybatis——plus）
创建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');

编写项目，初始化项目！使用SpringBoot初始化！
导入依赖

mysql mysql-connector-java

org.projectlomboklombokcom.baomidoumybatis-plus-boot-starter3.0.5

yml文件中配置数据库**

spring: datasource: password: 123456 username: root url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8 driver-class-name: com.mysql.jdbc.Driver

编写pojo类，mapper接口**
pojo

@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private Integer age; private String email; }

@Test
void contextLoads() {
    //查询
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}

CRUD扩展

插入操作

Insert插入

@Test public void testInsert(){ User user = new User(); user.setName("图灵"); user.setAge(20); user.setEmail("123345567@qq.com"); //result是影响行数 int result = userMapper.insert(user); System.out.println(result); //会自动id回填，默认雪花算法 System.out.println(user); }

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/163d6aada9a14d5aa7b39e5f11eea414~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

数据库插入的id的默认值为：全局的唯一的id

主键生成策略

1、雪花算法：

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！

2、主键自增

2.1 需要在实体类字段上添加@TableId(type = IdType.AUTO) 2.2 数据库对应的字段一定要是自增的 ![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/571316346a6c4b8eacbd4db5f77a0f63~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" /> 2.3结果 ![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f13eace8ca7542d6b2eb04d86b84b5e0~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />
其他的源码解释

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(){ User user = new User(); user.setId(1334744418774695938L); //这里只改年龄 user.setAge(19); int i = userMapper.updateById(user); System.out.println(i); }

更新操作是动态SQL

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/fd9cbf1a7d8c48659ca60b2387b873ea~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

自动填充

创建时间、修改时间！这些个操作一遍都是自动化完成的，我们不希望手动更新！阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化！
代码级别

修改数据库

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/cec954b2329a4509b87f1eebb8d1da13~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

修改实体类，在时间属性上添加注解

Data @AllArgsConstructor @NoArgsConstructor public class User { @TableId(type = IdType.AUTO) private Long id; private String name; private Integer age; private String email;

@TableField(fill = FieldFill.INSERT)
private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Date UpdateTime;

}

@TableField(fill = FieldFill.INSERT) 在创建新这条数据时，更新时间。 @TableField(fill = FieldFill.INSERT_UPDATE)，在创建和更新这条数据时，更新时间。

编写配置类 @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); } }

分别运行添加和修改，结果：

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/6c937bc7980a4175a6136464dfaa21a2~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

分页查询

1、编写配置类，拦截器

package com.alan.mybatis.plus.config;

import com.baomidou.mybatisplus.core.injector.ISqlInjector; import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector; import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor; import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile;

/**

@Author Alan Ture
@Description / @Configuration public class MyBatisPlusConfig { /*
- 分页插件 */ @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); }

}

2、直接使用Page对象即可。

//分页测试查询 @Test public void testPage(){ // 参数一：当前页 // 参数二：页面大小 Page page = new Page<>(1,5); userMapper.selectPage(page,null); page.getRecords().forEach(System.out::println); System.out.println(page.getTotal()); }

删除操作

1、根据id删除记录

// 测试删除 @Test public void testDeleteById(){ userMapper.deleteById(1334744418774695938L); }

// 通过id批量删除 @Test public void testDeleteBatchId(){ userMapper.deleteBatchIds(Arrays.asList(1334745985150111745L,1334745985150111746L)); } // 通过map删除 @Test public void testDeleteMap() { HashMap<String, Object> map = new HashMap<>(); map.put("name", "图灵"); userMapper.deleteByMap(map); }

逻辑删除

物理删除：从数据库中直接移除逻辑删除：再数据库中没有被移除，而是通过一个变量来让他失效！ deleted = 0 => deleted = 1

1、数据库添加字段

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/84d030c61bbc4b32b5ab535d7b05f73a~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

2、实体类添加字段，并添加注解

@TableLogic//逻辑删除 private Integer deleted;

3、配置类配置

// 逻辑删除组件！ @Bean public ISqlInjector sqlInjector() { return new LogicSqlInjector(); }

4、yml配置（删除为0，没有删除为1）

mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl global-config: db-config: logic-delete-value: 0 logic-not-delete-value: 1

5、测试删除

// 测试删除 @Test public void testDeleteById(){ userMapper.deleteById(1L); }

实际走的是更新操作

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/49637420bdf4414086cc7da295795679~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

结果

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/e3f7d67cbd574eb494943a03d2db0d92~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

性能分析插件

我们在平时的开发中，会遇到一些慢sql。测试！ druid, 作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间 MP也提供性能分析插件，如果超过这个时间就停止运行！

1、导入插件（记住，要在SpringBoot中配置环境为dev或者 test 环境！）

properties.yml设置开发环境

spring: profiles: active: dev /**

SQL执行效率插件
设置 dev test 环境开启，保证我们的效率 */ @Bean @Profile({"dev","test"}) public PerformanceInterceptor performanceInterceptor() { PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); // ms设置sql执行的最大时间，如果超过了则不执行 performanceInterceptor.setMaxTime(10); // 是否格式化代码 performanceInterceptor.setFormat(true); return performanceInterceptor; }

2、测试使用（超过规定时间会报异常）

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9c7dd94c20cd401a807a5601959b8939~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

条件构造器 Wrapper

我们写一些复杂的sql就可以使用它来替代！

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4eff5143cc0e4f269c45d5409b4862ab~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

1、测试一，isNotNull不为空，ge大于等于

@Test public void contextLoads() { // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12 QueryWrapper wrapper = new QueryWrapper<>(); wrapper .isNotNull("name") .isNotNull("email") .ge("age",20); userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下

}

![](data:;base64,<?xml version=)" alt="" data-src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/180ab00be07b4c23a2e73de5300f72c5~tplv-k3u1fbpfcp-zoom-1.image" data-width="800" data-height="600" />

2、测试二，eq查询相等数据

@Test public void test2(){ // 查询名字Jone QueryWrapper wrapper = new QueryWrapper<>(); wrapper.eq("name","Jone"); User user = userMapper.selectOne(wrapper); // 查询一个数据，出现多个结果使用List或者 Map System.out.println(user); }

代码自动生成器

package com.alan.mybatis.plus;

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 GenCode { 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("Alan Ture"); 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/mybatis_plus? 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.alan"); 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("create_time", FieldFill.INSERT); TableFill gmtModified = new TableFill("update_time", FieldFill.INSERT_UPDATE); ArrayList 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(); //执行 } }