在 Spring Boot 框架中,我们经常需要进行数据库开发,编写 CRUD 代码是一个重复且繁琐的工作。为了提高开发效率和代码质量,我们可以利用 Mybatisplus-generator+freemarker 自定义代码生成程序。
通过配置 Mybatisplus-generator,我们可以轻松地生成实体类、Mapper、Service、Controller 等常用的代码文件。同时,借助 freemarker 模板引擎,我们可以自定义代码文件的生成规则和规范,让生成的代码更加符合实际业务需求。
具体来说,我们可以通过以下步骤编写一个独属于我们自己的 Spring Boot 代码生成程序:
编写一个独属于你的springboot代码生成程序
前提需要:mysql与mysql相关依赖 mysql-connector-java
1.添加依赖
在 pom.xml 中添加 Mybatisplus-generator 和 freemarker 的依赖。
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
2.配置 Mybatisplus-generator
在 resources 目录下创建配置文件 application.yml,添加以下内容:
mybatis-plus:
global-config:
db-config:
logic-delete-value: 0
logic-not-delete-value: 1
id-type: auto
field-strategy: not_empty
table-prefix: xxx_
# 自定义全局配置
false-keyword: null
column-format: under_line_to_camel
# 日期类型自动填充
meta-object-handler: com.baomidou.mybatisplus.extension.handlers.MybatisDefaultMetaObjectHandler
# 启动 Swagger 文档生成器
swagger2: true
其中,我们可以通过 global-config 配置全局的 Mybatis-plus-generator 的行为。比如,我们可以配置表前缀、逻辑删除字段、日期类型自动填充等。
3.配置 freemarker 模板
在 resources 目录下创建 templates 文件夹,并在该文件夹下创建对应的模板文件。例如,我们可以创建 entity.java.ftl 等用于生成实体类文件,目录结构如下图所示:
可以直接在外部库中找到Mybatis-plus-generator库,搬用其中template下的示例模板。
4.编写代码生成器程序
编写代码生成器程序的核心就是通过 Mybatisplus-generator 自动根据数据库表结构和自定义模板生成代码文件。在代码生成器程序中,我们需要完成以下任务:
- 配置数据源,告诉 Mybatisplus-generator 如何连接数据库。
- 配置包路径,告诉 Mybatisplus-generator 生成的代码文件应该放在哪个包下。
- 配置策略,告诉 Mybatisplus-generator 如何根据数据库表生成代码文件。
- 配置模板,告诉 Mybatisplus-generator 使用哪些自定义模板。
- 执行代码生成,让 Mybatisplus-generator 开始生成代码文件。
以下是一个简单的代码生成器程序,可以用作参考:
注:freemarker默认是最新版本,Mybatisplus-generator为3.5.2版本。不同版本的freemarker实现方式不一样,建议前往官网查看具体信息
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.Collections;
public class FastAutoGeneratorCreater {
public static void main(String[] args) {
// 配置模板
FastAutoGenerator.create("jdbc:mysql://localhost:3306/test_db_tenant?useSSL=false&autoReconnect=true&characterEncoding=utf8",//这里选择数据库表
"root", //这里写username
"111111") //这里写password
// 全局配置,生成的代码路径
.globalConfig(builder ->
builder.author("ChenFengYeSe") // 设置作者
.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("D:\\SpringCloudLearning\\SpringBootStudy\\src\\main\\java\\") // 指定输出目录 最好是绝对路径
)
// 包配置
.templateEngine(new FreemarkerTemplateEngine(