SpringBoot +Freemarker+ Screw 生成数据库文档

com.zaxxer

HikariCP

3.4.5

mysql

mysql-connector-java

8.0.20

root

root

com.mysql.cj.jdbc.Driver

jdbc:mysql://localhost:3306/db_wego?useSSL=false&serverTimezone=GMT%2B8

HTML

false

freemarker

测试文档名称

数据库文档生成

${project.version}

compile

run

• 2. 生成

方式二

/**

• 文档生成

*/

public class GenDatabaseDescFileUtil {

public static void main(String[] args) {

//数据源

HikariConfig hikariConfig = new HikariConfig();

hikariConfig.setDriverClassName(“com.mysql.cj.jdbc.Driver”);

hikariConfig.setJdbcUrl(“jdbc:mysql://localhost:3306/db_wego?useSSL=false&serverTimezone=GMT%2B8”);

hikariConfig.setUsername(“root”);

hikariConfig.setPassword(“root”);

//设置可以获取tables remarks信息

hikariConfig.addDataSourceProperty(“useInformationSchema”, “true”);

hikariConfig.setMinimumIdle(2);

hikariConfig.setMaximumPoolSize(5);

DataSource dataSource = new HikariDataSource(hikariConfig);

//生成配置

EngineConfig engineConfig = EngineConfig.builder()

//生成文件路径

.fileOutputDir(“…/db”)

//打开目录

.openOutputDir(true)

//文件类型

.fileType(EngineFileType.HTML)

//生成模板实现

.produceType(EngineTemplateType.freemarker)

//自定义文件名称

.fileName(“自定义文件名称”).build();

//忽略表

ArrayList ignoreTableName = new ArrayList<>();

ignoreTableName.add(“test_user”);

ignoreTableName.add(“test_group”);

//忽略表前缀

ArrayList ignorePrefix = new ArrayList<>();

ignorePrefix.add(“test_”);

//忽略表后缀

ArrayList ignoreSuffix = new ArrayList<>();

ignoreSuffix.add(“_test”);

ProcessConfig processConfig = ProcessConfig.builder()

//指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置

//根据名称指定表生成

.designatedTableName(new ArrayList<>())

//根据表前缀生成

.designatedTablePrefix(new ArrayList<>())

//根据表后缀生成

.designatedTableSuffix(new ArrayList<>())

//忽略表名

.ignoreTableName(ignoreTableName)

//忽略表前缀

.ignoreTablePrefix(ignorePrefix)

//忽略表后缀

.ignoreTableSuffix(ignoreSuffix).build();

//配置

Configuration config = Configuration.builder()

//版本

.version(“1.0.0”)

//描述

.description(“数据库设计文档生成”)

//数据源

.dataSource(dataSource)

//生成配置

.engineConfig(engineConfig)

//生成配置

.produceConfig(processConfig)

.build();

//执行生成

new DocumentationExecute(config).execute();

}

}

方法三

• 1.修改application.yml文件，为其添加如下内容：

spring:

datasource:

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

url: jdbc:mysql://localhost:3306/db_blog?useSSL=false&serverTimezone=GMT%2B8&characterEncoding=utf8&useUnicode=true&allowPublicKeyRetrieval=true

username: root

password: root

• 2. 生成代码

@SpringBootTest

class GenDatabaseDescFileUtil {

@Autowired

ApplicationContext applicationContext;

@Test

void genDbDescHtmlFile() {

DataSource ds = applicationContext.getBean(DataSource.class);

// 生成文件配置

EngineConfig engineConfig = EngineConfig.builder()

// 生成文件路径，自己mac本地的地址，这里需要自己更换下路径

.fileOutputDir(“…/db”)

// 打开目录

.openOutputDir(false)

// 文件类型

.fileType(EngineFileType.HTML)

// 生成模板实现

.produceType(EngineTemplateType.freemarker).build();

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

笔者福利

以下是小编自己针对马上即将到来的金九银十准备的一套“面试宝典”，不管是技术还是HR的问题都有针对性的回答。

有了这个，面试踩雷？不存在的！

回馈粉丝，诚意满满！！！

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
一套“面试宝典”，不管是技术还是HR的问题都有针对性的回答。

有了这个，面试踩雷？不存在的！

回馈粉丝，诚意满满！！！

[外链图片转存中…(img-6qpklBE3-1713399625212)]
[外链图片转存中…(img-wVukYviE-1713399625212)]
[外链图片转存中…(img-R2pOdpUH-1713399625212)]
[外链图片转存中…(img-nObXsJsz-1713399625213)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！