MyBatis-Plus介绍及Spring Boot 3集成指南
作者：修己xj
我们每个Java开发者都在使用springboot+mybatis开发时，我们经常发现自己需要为每张数据库表单独编写XML文件，并且为每个表都需要编写一套增删改查的方法，较为繁琐。为了解决这一问题，MyBatis-Plus应运而生。在本文中，我们将介绍MyBatis-Plus的应用以及如何在Spring Boot 3中集成MyBatis。
什么是MyBatis-Plus？
github地址：https://github.com/baomidou/mybatis-plus
MyBatis-Plus 是一个 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
其在github目前已经有15.9k star,足以看出大家对其的喜爱。
Spring Boot 3集成MyBatis-Plus
在你的Spring Boot项目的pom.xml中添加MyBatis-Plus的依赖：
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.6</version> <exclusions> <exclusion> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>3.0.3</version> </dependency>
我们此处引入 MyBatis Plus 的版本为最新版本 3.5.6，并排除了其中的 mybatis-spring 依赖，并且另外引入了 mybatis-spring 的版本为 3.0.3。我们此处排除 MyBatis Plus中的mybatis-spring的依赖，另外引入了高版本的 mybatis，是因为MyBatis Plus中引入的mybatis版本为2.1.2版本，在有些springboot3的版本中会有依赖不兼容的问题。
在启动类中配置注解@MapperScan，用于配置Mapper接口的扫描路径。
@SpringBootApplication
@MapperScan("cn.xj.ihs.**.mapper")
public class IHSApplication {
public static void main(String[] args) {
SpringApplication.run(IHSApplication.class, args);
}
}Spring Boot 3集成MyBatis-Plus代码生成器
在你的Spring Boot项目的pom.xml中添加myBatis-plus-generator的依赖：
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.5</version> </dependency> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.3</version> </dependency>
在测试包下创建 MyBatisPlusGenerator.java,以交互的模式快速且优雅生成你想要的代码。
public class MyBatisPlusGenerator {
// 处理 all 情况
protected static List<String> getTables(String tables) {
return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
}
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://192.168.10.171:3306/xj_test", "root", "xj2022")
// 全局配置
.globalConfig((scanner, builder) -> {
//设置注释信息-作者
builder.author(scanner.apply("请输入作者名称？"));
//设置swagger注解
//builder.enableSwagger();
//设置代码生成的路径
builder.outputDir(System.getProperty("user.dir")+"/src/main/java");
})
// 包配置
.packageConfig((scanner, builder) -> {
builder.parent(scanner.apply("请输入包名？"))
//设置xml文件路径
.pathInfo(Collections.singletonMap(OutputFile.xml, System.getProperty("user.dir")+"/src/main/resources/mapper"));
})
// 策略配置
.strategyConfig((scanner, builder) -> {
builder.addInclude(MyBatisPlusGenerator.getTables(scanner.apply("请输入表名，多个英文逗号分隔？所有输入 all")))
.controllerBuilder().enableRestStyle().enableHyphenStyle().build();
builder.serviceBuilder()
.formatServiceFileName("%sService")
.formatServiceImplFileName("%sServiceImp")
.build();
//entity的策略配置
builder.entityBuilder()
//启用Lombok插件
.enableLombok()
.enableTableFieldAnnotation()
.versionColumnName("version")
.logicDeleteColumnName("is_delete")
//设置字段名的命名策略为下划线转驼峰命名
.columnNaming(NamingStrategy.underline_to_camel)
//主键策略递增
.idType(IdType.AUTO)
.formatFileName("%sEntity")
.build();
})
.execute();
}
}运行代码，输入作者，生成代码的包路径，数据库表来生成代码：
这样，我们就能够快速生成一套代码了。我们只需在生成的代码基础上添加我们的业务处理逻辑即可。
至此，你已经完成了MyBatis-Plus与Spring Boot 3的集成。通过MyBatis-Plus，你可以更加高效地开发数据访问层，减少重复代码的编写，提升系统的开发效率和可维护性。
总结
本文介绍了MyBatis-Plus的基本特性及其与Spring Boot 3的集成步骤。通过使用MyBatis-Plus，开发者可以快速地搭建和开发数据访问层，同时提高代码质量和开发效率。希望本文能对你理解和使用MyBatis-Plus有所帮助。
到此这篇关于MyBatis-Plus介绍及Spring Boot 3集成指南的文章就介绍到这了,更多相关MyBatis-Plus集成Spring Boot内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！