目录
简介
Spring Boot是一个用于开发Java应用程序的快速、便捷的框架。为了进一步提高开发效率,Spring Boot提供了一个强大的代码生成器工具,可以自动生成常见的代码模板。本文将介绍Spring Boot代码生成器的使用方法以及一些常用的代码模板,以帮助开发者快速构建项目。
实现步骤
一、新建Spring Boot项目
二、引用相应依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- MySQL数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<!-- MyBatis-Plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.2</version>
</dependency>
<!-- Lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- Spring Boot 测试 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- velocity 模板语言 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<!-- MyBatis-Plus 核心 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-core</artifactId>
<version>3.4.3</version> <!-- 根据你的需要,选择合适的版本 -->
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
三、配置数据库文件
# 数据库配置
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mvcdemo1?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 日志输出
logging.level.com.Bull=debug
四、进行快速生成
最后进行快速生成就完事了
生成后的项目框架如图
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
import java.util.Collections;
public class Code_Generator {
public static void main(String[] args) {
String url = "jdbc:mysql://localhost:3306/springboot-vue?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8";
String username = "root";
String password = "root";
String author = "hui";
String outputDir = "G:\\Java\\demo\\src\\main\\java";
String basePackage = "com.hui";
String mapperLocation = "G:\\Java\\demo\\src\\main\\resources\\mapper\\";
String tableName = "sys_user";
String tablePrefix = "sys_";
FastAutoGenerator.create(url, username, password)
.globalConfig(builder -> {
builder.author(author) // 设置作者
//.enableSwagger() // 开启 swagger 模式
//.fileOverride() // 覆盖已生成文件
.outputDir(outputDir); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent(basePackage) // 设置父包名
.moduleName("") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.xml, mapperLocation)); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude(tableName) // 设置需要生成的表名
.addTablePrefix(tablePrefix); // 设置过滤表前缀
})
.templateEngine(new VelocityTemplateEngine()) // 使用默认的Velocity引擎模版
.execute();
}
}
总结
当涉及到重复性的代码生成时,使用代码生成器可以极大地提高开发效率。代码生成器是一种工具,它可以根据预定义的模板和配置信息自动生成代码文件,包括实体类、Mapper接口、Service类、Controller类等等。
MyBatis-Plus是一个流行的Java持久层框架,提供了强大的代码生成器功能。使用MyBatis-Plus的代码生成器,您可以根据数据库表结构自动生成对应的Java代码,减少手动编写重复的CURD(增删改查)操作代码的工作量。
代码生成器可以帮助您快速生成整个项目的基础代码,遵循一定的开发规范和约定,提高代码的一致性和可维护性。您只需要提供数据库连接信息、表名、包名等必要的配置,代码生成器就能根据模板生成相应的代码文件,并将其放置在指定的位置。
在使用MyBatis-Plus的代码生成器时,通常需要指定以下几个关键的配置项:
- 数据库连接信息:包括数据库的URL、用户名和密码,用于连接到数据库获取表结构信息。
- 输出目录:指定生成的代码文件的存放位置,一般是项目的源代码目录。
- 基础包名:指定生成的Java代码所属的包名,一般是项目的根包名。
- 表名和表前缀:指定需要生成代码的表名,可以设置表名的过滤条件,如表前缀。
- 模板引擎:MyBatis-Plus支持多种模板引擎,如Velocity、Freemarker等,您可以根据个人喜好选择合适的模板引擎。
使用代码生成器的一般流程如下:
- 配置代码生成器的参数,包括数据库连接信息、输出目录、包名等。
- 指定需要生成代码的表名和表前缀。
- 选择合适的模板引擎,并设置相应的模板文件。
- 运行代码生成器,它将连接到数据库,读取表结构信息,并根据模板生成对应的代码文件。
- 检查生成的代码文件,根据需要进行自定义的修改和调整。
- 将生成的代码文件导入到项目中,开始使用自动生成的代码。
总而言之,代码生成器是一个强大的工具,它可以极大地减少重复性的开发工作,提高开发效率。使用MyBatis-Plus的代码生成器,我们可以根据数据库表结构自动生成对应的Java代码,为大家的项目快速生成基础代码,节省时间和精力。