从零搭建开发脚手架 Spring Boot集成Mybatis-plus之一

最新推荐文章于 2025-06-25 13:46:12 发布

原创最新推荐文章于 2025-06-25 13:46:12 发布 · 1.1k 阅读

24 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #mybatis #后端

简介

===========================================================

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 操作智能分析阻断，也可自定义拦截规则，预防误操作

框架结构

=============================================================

framework

依赖集成

=============================================================

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求 JDK 8+

依赖

Spring Boot 与MP 版本不清楚的，可以看下mybatis-plus-boot-starter中依赖的Boot版本

引入 Spring Boot Starter 父工程：

org.springframework.boot

spring-boot-starter-parent

2.4.3

引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、h2 依赖：

Latest Version: 传送门

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-test

test

com.baomidou

mybatis-plus-boot-starter

3.4.2

mysql

mysql-connector-java

org.projectlombok

lombok

true

配置

在 application.yml 配置文件中添加 H2 数据库的相关配置：

spring:

datasource:

username: root

password: 123456

url: jdbc:mysql://localhost:3306/laker?serverTimezone=GMT%2B8&characterEncoding=utf8&useSSL=false

driver-class-name: com.mysql.cj.jdbc.Driver

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication

@MapperScan(“com.laker.demo.mapper”)

public class Application {

public static void main(String[] args) {

SpringApplication.run(QuickStartApplication.class, args);

}

编码

编写实体类 User.java（此处使用了 Lombok简化代码）

@Data

public class User {

private Long id;

private String name;

private Integer age;

private String email;

}

编写Mapper类 UserMapper.java

public interface UserMapper extends BaseMapper {

}

开始使用

添加测试类，进行功能测试：

@RunWith(SpringRunner.class)

@SpringBootTest

public class SampleTest {

@Autowired

private UserMapper userMapper;

@Test

public void testSelect() {

List userList = userMapper.selectList(

new QueryWrapper()

.lambda()

.ge(User::getAge, 18)

);

// SELECT * FROM user WHERE age >= 18

}

到这里入门demo就够了，以下皆为扩展高级功能.

核心功能

=============================================================

代码生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

自定义模板有哪些可用参数？GithubAbstractTemplateEngine 类中方法 getObjectMap 返回 objectMap 的所有值都可用。

演示效果图：

relationship

添加依赖

MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：

添加代码生成器依赖（必选）

com.baomidou

mybatis-plus-generator

3.4.2

添加模板引擎依赖，MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。（必选其中的一个）

Velocity（默认）：

org.apache.velocity

velocity-engine-core

2.3

Freemarker：

org.freemarker

freemarker

2.3.31

Beetl：

com.ibeetl

beetl

3.3.2.RELEASE

注意！如果您选择了非默认引擎，需要在 AutoGenerator 中设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine

generator.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine

generator.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)

generator.setTemplateEngine(new CustomTemplateEngine());

// other config

…

编码

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中

public class CodeGenerator {

/**

读取控制台内容

public static String scanner(String tip) {

Scanner scanner = new Scanner(System.in);

StringBuilder help = new StringBuilder();

help.append(“请输入” + tip + “：”);

System.out.println(help.toString());

if (scanner.hasNext()) {

String ipt = scanner.next();

if (StringUtils.isNotBlank(ipt)) {

return ipt;

}

throw new MybatisPlusException(“请输入正确的” + tip + “！”);

}

public static void main(String[] args) {

// 代码生成器

AutoGenerator mpg = new AutoGenerator();

// 全局配置

String projectPath = globalConfig(mpg);

// 数据源配置

dataSourceConfig(mpg);

// 生成代码包配置

PackageConfig pc = packageConfig(mpg);

diyConfig(mpg, projectPath, pc);

// 配置模板

TemplateConfig templateConfig = new TemplateConfig();

// 配置自定义输出模板

//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别

// templateConfig.setEntity(“templates/entity2.java”);

// templateConfig.setService();

// templateConfig.setController();

// 这里默认的xml生成的位置与mapper在一个目录，不实用，改为diyConfig中自定义到 resources/mapper下

templateConfig.setXml(null);

mpg.setTemplate(templateConfig);

// 策略配置

strategyConfig(mpg, pc);

mpg.setTemplateEngine(new FreemarkerTemplateEngine());

mpg.execute();

}

private static void diyConfig(AutoGenerator mpg, String projectPath, PackageConfig pc) {

// 自定义配置

InjectionConfig cfg = new InjectionConfig() {

@Override

public void initMap() {

// to do nothing

}

};

// 如果模板引擎是 freemarker

String templatePath = “/templates/mapper.xml.ftl”;

// 如果模板引擎是 velocity

// String templatePath = “/templates/mapper.xml.vm”;

// 自定义输出配置

List focList = new ArrayList<>();

// 自定义配置会被优先输出

focList.add(new FileOutConfig(templatePath) {

@Override

public String outputFile(TableInfo tableInfo) {

// 自定义输出文件名，如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！

return projectPath + “/src/main/resources/mapper/” + pc.getModuleName()

“/” + tableInfo.getEntityName() + “Mapper” + StringPool.DOT_XML;

}

});

cfg.setFileCreate(new IFileCreate() {

@Override

public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {

// 判断自定义文件夹是否需要创建

checkDir(“调用默认方法创建的目录，自定义目录用”);

if (fileType == FileType.MAPPER) {

// 已经生成 mapper 文件判断存在，不想重新生成返回 false

return !new File(filePath).exists();

}

// 允许生成模板文件

return true;

}

});

// 自定义输出文件

cfg.setFileOutConfigList(focList);

mpg.setCfg(cfg);

}

private static void strategyConfig(AutoGenerator mpg, PackageConfig pc) {

StrategyConfig strategy = new StrategyConfig();

strategy.setNaming(NamingStrategy.underline_to_camel);

strategy.setColumnNaming(NamingStrategy.underline_to_camel);

// “你自己的父类实体,没有就不用设置!”

// strategy.setSuperEntityClass(“你自己的父类实体,没有就不用设置!”);

// 【实体】是否为lombok模型（默认 false）

strategy.setEntityLombokModel(true);

// 生成 @RestController 控制器

strategy.setRestControllerStyle(true);

// 公共父类 “你自己的父类控制器,没有就不用设置!”

// strategy.setSuperControllerClass(“你自己的父类控制器,没有就不用设置!”);

// 写于父类中的公共字段

// strategy.setSuperEntityColumns(“id”);

strategy.setInclude(scanner(“表名，多个英文逗号分割”).split(“,”));

strategy.setControllerMappingHyphenStyle(true);

strategy.setTablePrefix(pc.getModuleName() + “_”);

mpg.setStrategy(strategy);

}

private static PackageConfig packageConfig(AutoGenerator mpg) {

PackageConfig pc = new PackageConfig();

// sys 父包模块名

pc.setModuleName(scanner(“模块名”));

// 父包名。如果为空，将下面子包名必须写全部，否则就只需写子包名

pc.setParent(“com.laker.demo”);

/**

上面的代码生成位置及包名称
com.laker.demo.sys

mpg.setPackageInfo(pc);

return pc;

}

private static void dataSourceConfig(AutoGenerator mpg) {

DataSourceConfig dsc = new DataSourceConfig();

dsc.setUrl(“jdbc:mysql://localhost:3306/laker?useUnicode=true&useSSL=false&characterEncoding=utf8”);

// dsc.setSchemaName(“public”);

dsc.setDriverName(“com.mysql.cj.jdbc.Driver”);

dsc.setUsername(“root”);

dsc.setPassword(“123456”);

mpg.setDataSource(dsc);

}

private static String globalConfig(AutoGenerator mpg) {

GlobalConfig gc = new GlobalConfig();

String projectPath = System.getProperty(“user.dir”);

// 生成文件的输出目录

gc.setOutputDir(projectPath + “/src/main/java”);

// 作者姓名

gc.setAuthor(“laker”);

// 是否打开输出目录

gc.setOpen(true);

// 实体属性 Swagger2 注解

// gc.setSwagger2(true);

// 是否覆盖已有文件

gc.setFileOverride(false);

// 开启 BaseResultMap

gc.setBaseResultMap(true);

// 开启 baseColumnList

gc.setBaseColumnList(true);

mpg.setGlobalConfig(gc);

return projectPath;

}

更多详细配置，请参考代码生成器配置一文。

编写配置

MyBatis-Plus 的代码生成器提供了大量的自定义参数供用户选择，能够满足绝大部分人的使用需求。

配置 GlobalConfig

GlobalConfig globalConfig = new GlobalConfig();

globalConfig.setOutputDir(System.getProperty(“user.dir”) + “/src/main/java”);

globalConfig.setAuthor(“jobob”);

globalConfig.setOpen(false);

配置 DataSourceConfig

DataSourceConfig dataSourceConfig = new DataSourceConfig();

dataSourceConfig.setUrl(“jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8”);

dataSourceConfig.setDriverName(“com.mysql.jdbc.Driver”);

dataSourceConfig.setUsername(“root”);

dataSourceConfig.setPassword(“password”);

自定义模板引擎

请继承类 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine

自定义代码模板

自带内部模板为

//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)

//注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别

TemplateConfig templateConfig = new TemplateConfig()

.setEntity(“templates/entity2.java”);

AutoGenerator mpg = new AutoGenerator();

复习的面试资料

这些面试全部出自大厂面试真题和面试合集当中，小编已经为大家整理完毕（PDF版）

第一部分：Java基础-中级-高级

第二部分：开源框架（SSM：Spring+SpringMVC+MyBatis）

第三部分：性能调优（JVM+MySQL+Tomcat）

第四部分：分布式（限流：ZK+Nginx；缓存：Redis+MongoDB+Memcached；通讯：MQ+kafka）

第五部分：微服务（SpringBoot+SpringCloud+Dubbo）

第六部分：其他：并发编程+设计模式+数据结构与算法+网络

进阶学习笔记pdf

Java架构进阶之架构筑基篇（Java基础+并发编程+JVM+MySQL+Tomcat+网络+数据结构与算法）

Java架构进阶之开源框架篇（设计模式+Spring+SpringMVC+MyBatis）

Java架构进阶之分布式架构篇（限流（ZK/Nginx）+缓存（Redis/MongoDB/Memcached）+通讯（MQ/kafka））

Java架构进阶之微服务架构篇（RPC+SpringBoot+SpringCloud+Dubbo+K8s）

741699)]

第四部分：分布式（限流：ZK+Nginx；缓存：Redis+MongoDB+Memcached；通讯：MQ+kafka）

[外链图片转存中…(img-ZFBl7fbn-1719186741700)]

第五部分：微服务（SpringBoot+SpringCloud+Dubbo）

[外链图片转存中…(img-tWoYMeHA-1719186741700)]

第六部分：其他：并发编程+设计模式+数据结构与算法+网络

[外链图片转存中…(img-a7xx012G-1719186741700)]

进阶学习笔记pdf

Java架构进阶之架构筑基篇（Java基础+并发编程+JVM+MySQL+Tomcat+网络+数据结构与算法）

[外链图片转存中…(img-NAKvZTtZ-1719186741701)]

Java架构进阶之开源框架篇（设计模式+Spring+SpringMVC+MyBatis）

[外链图片转存中…(img-jfJfJrPL-1719186741701)]

[外链图片转存中…(img-9RYP3tnk-1719186741701)]

[外链图片转存中…(img-QHbZ1c8m-1719186741702)]

Java架构进阶之分布式架构篇（限流（ZK/Nginx）+缓存（Redis/MongoDB/Memcached）+通讯（MQ/kafka））

[外链图片转存中…(img-B8xiRojm-1719186741702)]

[外链图片转存中…(img-HMT0DlgU-1719186741702)]

[外链图片转存中…(img-hxH4HU2q-1719186741703)]

Java架构进阶之微服务架构篇（RPC+SpringBoot+SpringCloud+Dubbo+K8s）

[外链图片转存中…(img-Vb295VV9-1719186741703)]

[外链图片转存中…(img-fb5meFQv-1719186741703)]