MyBatis Plus
前提:mybatis、spring、springmvc
为什么学习它?它可以节省我们大量工作时间,所有的CRUD代码它都可以自动化完成!
同源:JPA、tk-mappper、MybatisPlus
目的:偷懒!
简介
1、是什么?
Mybatis本来就是简化JDBC操作的
官网:https://mp.baomidou.com/
Mybatis Plus,简化mybatis!

官方原话: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 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速入门
地址:https://mp.baomidou.com/guide/quick-start.html#初始化工程
使用第三方组件:
- 导入对应的依赖
- 研究依赖如何配置
- 代码如何编写
- 提高扩展技术能力!
步骤:
-
创建数据库
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'); -- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
-
编写项目,初始化项目!使用spring boot初始化
-
导入依赖
<dependencies> <!--web--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--数据库驱动--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!--mybatis-plus--> <!--mybatis-plus 是自己开发,并非官方的!--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.5</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies>
说明:我们使用mybatis-plus可以节省我们大量的代码,尽量不要同时导入 mybatis 和 mybatis-plus !版本的差异!
-
连接数据库!这一步和 mybatis相同!
# mysql 5 驱动不同 com.mysql.jdbc.Driver spring.datasource.username=root spring.datasource.password=root 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 # mysql 8 驱动不同 com.mysql.cj.jdbc.Driver 需要增加时区的配置 serverTimezone=GMT%2B8 #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
6、传统方式pojo-dao(连接mybatis,配置mapper.xml文件)-service-controller
-
使用了 mybatis-plus 之后
-
pojo
@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private Integer age; private String email; }
-
mapper接口
//在对应的Mapper上面继承基本的类 BaseMapper @Repository //代表持久层 public interface UserMapper extends BaseMapper<User> { //所有的CRUD操作都已经编写完成了 //你不需要像以前的配置一大堆文件了! }
-
注意点,我们需要在主启动类上去扫描我们的mapper包下的所有接口
@MapperScan("com.kuang.mapper")
-
测试类中测试
@SpringBootTest class MybaitsPlusApplicationTests { //继承了 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-Plus都写好了
配置日志
我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以我们必须要看日志!
application.properties
# 配置日志 org.apache.ibatis.logging.stdout.StdOutImpl默认配置,控制台输出。也可以配置为log4j,slf4j
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后,后面的学习就需要注意这个自动生成的SQL,会喜欢上Mybatis-plus!
结果:

CURD扩展
插入操作
Insert插入
@Test
public void testInsert(){
User user = new User();
user.setName("测试用户");
user.setAge(3);
user.setEmail("1234323@qq.com");
int insert = userMapper.insert(user); // 帮我们自动生成id
System.out.println(insert); // 受影响的行数
System.out.println(user); // 发现,id会自动回填
}
结果:

数据库插入的id的默认值为:全局的唯一id
主键生成策略
默认
@TableId(type = IdType.ID_WORKER)默认 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)
-
数据库字段一定要是自增!
-
再次测试插入即可!
其余的源码解释
public enum IdType { /** * 数据库ID自增 */ AUTO(0), // 数据库id自增 /** * 该类型为未设置主键类型 */ NONE(1), // 未设置主键 /** * 用户输入ID * 该类型可以通过自己注册自动填充插件进行填充 */ INPUT(2), // 手动输入 /* 以下3种类型、只有当插入对象ID 为空,才自动填充。 */ /** * 全局唯一ID (idWorker) */ ID_WORKER(3), // 默认的全局唯一id /** * 全局唯一ID (UUID) */ UUID(4), // 全局唯一的id uuid /** * 字符串全局唯一ID (idWorker 的字符串表示) */ ID_WORKER_STR(5); // ID_WORKER 字符串表示发 private int key; IdType(int key) { this.key = key; }}
//对应数据库中的主键(uuid、自增id、雪花算法、redis、zookeeper)@TableId(type = IdType.INPUT) // 一旦手动输入id之后,就需要自己配置id了!
更新操作
//测试更新@Testpublic void testUpdate(){ User user = new User(); // 通过条件自动生成拼接动态sql user.setId(6L); user.setName("vip用户"); user.setAge(18); // 注意:updateById 但是参数是一个 对象! int i = userMapper.updateById(user); System.out.println(i);}
结果:

所有的sql都是自动帮你动态配置的!
自动填充
创建时间、修改时间!这些个操作一遍都是自动化完成的,我们不希望手动更新!
阿里巴巴开发收册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别(工作中不允许你修改数据库)
-
在表中新增字段 create_time、update_time
不知道为什么,以下截图sqlyog中设计表里没更新选项,需要把update_time字段的更新勾上
-
再次测试插入方法,我们需要先把实体类同步!
pojo:
private Date createTime;private Date updateTime;
因为上面没更新选项,所以时间没变,还是空。然后,手动填入,因此此方法没行通。
方式二:代码级别
-
删除数据库的默认值,更新操作!
-
实体类字段属性上需要增加注解
pojo:
//字段添加填充内容@TableField(fill = FieldFill.INSERT)private Date createTime;@TableField(fill = FieldFill.INSERT_UPDATE)private Date updateTime;
-
编写处理器来处理这个注解即可!
handler 包下的 MyMetaObjectHandler 类
@Slf4j@Component // 一定不要忘记把处理器加到IOC容器中!public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { log.info("start insert fill……"); // setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) 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); }}
-
测试插入
-
测试更新,观察时间即可!
乐观锁
在面试过程中,我们经常会被问道乐观锁,悲观锁!这个其实非常简单!
乐观锁:顾名思义十分乐观,他总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试。
悲观锁:顾名思义十分悲观,他总是认为总是出现问题,无论干什么都会上锁!再去操作!
我们这里主要讲解 乐观锁机制!
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
乐观锁:1、先查询,获得版本号 version=1--Aupdate user set name="ceshi",version=version+1 where id=2 and version=1--B 线程抢先完成,这个时候 version=2,会导致 A 修改失败!update user set name="ceshi",version=version+1 where id=2 and version=1
测试一下MP的乐观锁插件
-
给数据库中增加version字段!
-
我们实体类加对应的字段
@Version // 乐观锁Version注解private Integer version;
-
注册组件 config 包下的 MybatisPlusConfig 类
// 扫描我们的 mapper 文件夹@MapperScan("com.kuang.mapper")@EnableTransactionManagement@Configuration // 配置类public class MybatisPlusConfig { //注册乐观锁插件 @Bean public OptimisticLockerInterceptor optimisticLockerInterceptor() { return new OptimisticLockerInterceptor(); }}
-
测试一下!
//测试乐观锁成功!@Testpublic void testOptimisticLocker(){ // 1.查询用户信息 User user = userMapper.selectById(1L); // 2.修改用户信息 user.setName("ceshi"); user.setEmail("554543@qq.com"); // 3.执行更新操作 userMapper.updateById(user);}//测试乐观锁失败!多线程下@Testpublic void testOptimisticLocker2(){ // 线程 1 User user = userMapper.selectById(1L); user.setName("ceshi111"); user.setEmail("554543@qq.com"); // 模拟另外一个线程执行了插队操作 User user2 = userMapper.selectById(1L); user2.setName("ceshi222"); user2.setEmail("554543@qq.com"); userMapper.updateById(user2); //自旋锁来多次尝试提交! userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值!}
结果:
查询操作
// 测试查询@Testpublic void testSelectById(){ User user = userMapper.selectById(1L); System.out.println(user);}// 测试批量查询!@Testpublic void testSelectByBatchId(){ List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3)); users.forEach(System.out::println);}// 按条件查询之一使用map操作@Testpublic void testSelectByBatchIds(){ HashMap<String, Object> map = new HashMap<>(); // 自定义要查询 map.put("name","测试用户"); map.put("age",3); List<User> users = userMapper.selectByMap(map); users.forEach(System.out::println);}
分页查询
分页在网站使用的十分之多!
- 原始的 limit 进行分页
- pageHelper 第三方插件
- MP 其实也内置了分页插件
如何使用!
-
配置拦截器组件即可 config 包下的 MybatisPlusConfig 类
// 分页插件@Beanpublic PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor();}
-
直接使用Page对象即可!
// 测试分页查询@Testpublic void testPage(){ // 参数一:当前页 // 参数二:页面大小 // 使用了分页插件之后,所有的分页操作页变得简单! Page<User> page = new Page<>(1, 5); userMapper.selectPage(page,null); page.getRecords().forEach(System.out::println); System.out.println(page.getTotal());}
删除操作
基本的删除操作
// 测试删除@Testpublic void testDeleteById(){ userMapper.deleteById(1414411218739916805L);}// 通过id批量删除@Testpublic void testDeleteBatchId(){ userMapper.deleteBatchIds(Arrays.asList(1414411218739916804L,1414411218739916803L));}// 通过map删除@Testpublic void testDeleteMap(){ HashMap<String, Object> map = new HashMap<>(); map.put("name","测试用户"); userMapper.deleteByMap(map);}
我们在工作中会遇到一些问题:逻辑删除!
逻辑删除
物理删除:从数据库中直接移除
逻辑删除:在数据库中没有被移除,而是通过一个变量来让他失效!deleted=0 => deleted=1
管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!
测试一下:
-
在数据表中增加一个
deleted
字段 -
实体类中增加属性
@TableLogic // 逻辑删除private Integer deleted;
-
配置!
低版本需要配置如下这一步,高版本已不需要了:
因为依赖引入的 mybatis-plus-boot-starter 是 3.0.5 版本的,属于低版本,需要配以下内容
// 逻辑删除组件!@Beanpublic ISqlInjector sqlInjector(){ return new LogicSqlInjector();}
application.properties
# 配置逻辑删除mybatis-plus.global-config.db-config.logic-delete-value=1mybatis-plus.global-config.db-config.logic-not-delete-value=0
-
测试一下删除!
记录依旧在数据库,但是值确已经变化了
查询全部时,会自动过滤被逻辑删除的字段

以上的所有CRUD操作及其扩展操作,我们都必须精通掌握!会大大提高你的工作和写项目的效率!
性能分析插件
我们在平时的开发中,会遇到一些慢sql。测试!druid……
作用:性能分析拦截器,用于输出每条SQL语句及其执行时间
MP也提供性能分析插件,如果超过这个时间就停止运行!
-
导入插件
config 包下的 MybatisPlusConfig 类:
// SQL执行效率插件@Bean@Profile({"dev","test"}) // 设置 dev test 环境开启,保证我们的效率public PerformanceInterceptor performanceInterceptor(){ PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); // 在工作中,不允许用户等待(如果sql语句执行超过以下设置的秒数就会报错) performanceInterceptor.setMaxTime(100); // ms 设置sql执行的最大时间,如果超过了则不执行 performanceInterceptor.setFormat(true); // 是否格式化代码 return performanceInterceptor;}
记住,要在 SpringBoot 中配置环境为 dev 或者 test 环境!
-
测试使用!
//测试查询全部@Testvoid contextLoads() { //参数是一个 Wrapper ,条件构造器,这里我们先不要 null //查询全部用户 List<User> users = userMapper.selectList(null); users.forEach(System.out::println);}
结果:
使用性能分析插件,可以帮助我们提供效率!
条件构造器
十分重要:Wrapper
我们写一些复杂的sql就可以使用它来替代!

-
测试一
-
查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12
@SpringBootTestpublic 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); // 和我们刚才学习的map对比一下 }}
结果:
-
-
测试二:
-
查询名字为vip用户
@Testvoid test2(){ //查询名字为vip用户 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("name","vip用户"); User user = userMapper.selectOne(wrapper); // 查询一个数据,出现多个结果使用 List 或者 Map System.out.println(user);}
效果:
-
-
测试三:
-
查询年龄在 20-30 岁之间的用户
@Testvoid test3(){ //查询年龄在 20-30 岁之间的用户 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.between("age",20,30); Integer count = userMapper.selectCount(wrapper);// 查询结果数 System.out.println(count);}
结果:
-
-
测试四,记住查看输出的SQL进行分析:
-
模糊查询
@Testvoid test4(){ // 模糊查询 QueryWrapper<User> wrapper = new QueryWrapper<>(); //likeLeft左 %t 和 likeRight右 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); }
结果:
-
-
测试六:
-
根据id进行排序
@Testvoid test6(){ QueryWrapper<User> wrapper = new QueryWrapper<>(); // 通过id进行排序 wrapper.orderByDesc("id"); List<User> users = userMapper.selectList(wrapper); users.forEach(System.out::println);}
结果:
-
其余的测试,可以自己看看官方文档试试!
网址:https://mp.baomidou.com/guide/wrapper.html#abstractwrapper
代码自动生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
前提:需要引入依赖 mybatis-plus-boot-starter
,配好端口,引入配置类 MybatisPlusConfig
,发布环境,连接数据库
依赖:
<dependencies> <!--web--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--数据库驱动--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!--mybatis-plus--> <!--mybatis-plus 是自己开发,并非官方的!--> <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> <!--swagger2--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!--swagger-ui--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.30</version> </dependency></dependencies>
测试:只需要数据库库对应,改下面3子系统的名称和下面4要映射的表即可
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;// 代码自动生成器public class MyCode { 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.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/ceshi?useUnicode=true&useSSL=false&characterEncoding=utf8"); dsc.setDriverName("com.mysql.cj.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("root"); mpg.setDataSource(dsc); // 3、包配置 PackageConfig pc = new PackageConfig(); pc.setModuleName("blog"); // 设置子系统的名 pc.setParent("com.zcwin"); pc.setEntity("pojo"); pc.setMapper("mapper"); pc.setService("service"); pc.setController("controller"); mpg.setPackageInfo(pc); // 4、策略配置 StrategyConfig strategy = new StrategyConfig(); strategy.setInclude("user","ceshi"); // 设置要映射的表名 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(); }}
效果:
