前言

前一节我们搭建了后端工程，并且集成了 Druid 数据源，这一节我们基于上一节创建的工程，集成 ORM 框架 MyBatis Plus。

在第一节技术选型中，我写了 Spring Data Jpa 和 MyBatis Plus 两个 ORM 框架，最终我决定还是使用 MyBatis Plus。

一、什么是 MyBatis Plus

MyBatis Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

MyBatis Plus 的愿景是成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。

tips：MyBatis-Plus 荣获【 2019 年度开源中国最受欢迎的软件，开发工具类 TOP 1 】，这里可以看出 MyBatis Plus 的火爆程度，因为它实在是很好用滴。

二、MyBatis Plus 的特点

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

三、Spring Boot 集成 MyBatis Plus

如果对 MyBatis Plus 不熟悉的同学，建议去 MyBatis Plus 官网 学习一下，如果你会 Mybatis，学习 MyBatis Plus 应该是很快的。

1、添加 MyBatis Plus POM 依赖

当前（2020-07-11）最新版本为 3.3.2，这里我们使用的是3.3.1版本

<mybatis-plus.version>3.3.1</mybatis-plus.version><!-- mybatis-plus -->
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>${mybatis-plus.version}</version>
</dependency>

2、使用 CodeGenerator 生成代码

在这一步，我们使用 mybatis plus 代码生成器 创建 sys_user 表的相关类。

具体步骤我就不在这里写了，大家可以看我的之前写的博客，写的很详细（传送门）。

创建完成之后的目录结构如下

3、添加 Swagger POM 依赖

生成完代码后，我们发现 User 类报错，这是由于我们在生成代码的时候配置了Swagger2文档生成工具，所以我们需要先导入Swagger2的相关依赖，这里我们先导入依赖，详细的集成，我们放到下节再讲。

// 实体属性 Swagger2 注解
gc.setSwagger2(true);

<swagger.version>2.9.2</swagger.version><!-- swagger2 相关依赖 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>${swagger.version}</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>${swagger.version}</version>
</dependency>

4、创建 MyBatis Plus 配置类

在当前启动类目录下创建一个 config 包，然后创建 MyBatisPlusConfig.class。重点是配置类上面的两个注解，一定要加上。

package com.xiaoming.config;import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;/*** mybatis plus 配置类** @author xiaoming* @date 2020-07-11 17:41**/
@MapperScan(basePackages = "com.xiaoming.module.*.mapper")
@Configuration
public class MyBatisPlusConfig {
}

到这里我们就能直接使用 MyBatisPlus 进行项目的开发了。

5、编写查询方法测试

编写 UserController 类，如下

@RestController
@RequestMapping("/sys/user")
public class UserController {@Autowiredprivate UserService userService;@GetMappingpublic List<User> list() {return userService.list();}}

运行程序然后在页面上进行访问 http://localhost:9527/xm-admin/sys/user

可以看到，我们能够获取到数据库中 user 表信息，说明集成 mybatis plus 成功。

6、配置控制台打印 sql 语句

我们使用 mybatis plus 默认看不到程序执行的 sql 语句，我们可以通过编写配置文件开启它。如下

application-dev.yml

mybatis-plus:configuration:# 控制台打印sqllog-impl: org.apache.ibatis.logging.stdout.StdOutImpl

重启程序，再次访问 http://localhost:9527/xm-admin/sys/user，这个时候我们查看一下控制台的日志。

我们可以看到，在控制台输出了执行的 sql 语句，并且打印出来查询出来的数据，这个功能一般只在开发中开启，上线到生产环境需要关闭，所以我们把配置放到 application-dev.yml 配置文件即可。

总结

Spring Boot 集成 MyBatis Plus 到这里就算介绍完毕了，相对来说还是挺简单的。下一小节就把上面提到的 Swagger 集成到我们的项目中。