我们每个Java开发者都在使用springboot+mybatis开发时,我们经常发现自己需要为每张数据库表单独编写XML文件,并且为每个表都需要编写一套增删改查的方法,较为繁琐。为了解决这一问题,MyBatis-Plus应运而生。在本文中,我们将介绍MyBatis-Plus的应用以及如何在Spring Boot 3中集成MyBatis。
官方地址:https://baomidou.com/
github地址:https://github.com/baomidou/mybatis-plus
MyBatis-Plus 是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。有以下特性:
其在github目前已经有15.9k star,足以看出大家对其的喜爱。
在你的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项目的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有所帮助。