java一键生成《数据库设计文档》

mysql

mysql-connector-java

8.0.16

junit

junit

4.11

test

cn.smallbun.screw

screw-core

1.0.5

org.freemarker

freemarker

2.3.30

com.zaxxer

HikariCP

3.4.5

• HikariCP简介

HikariCP是由日本程序员开源的一个数据库连接池组件，代码非常轻量，并且速度非常的快。

根据官方提供的数据，在i7,开启32个线程32个连接的情况下，进行随机数据库读写操作，

HikariCP的速度是现在常用的C3P0数据库连接池的数百倍。

Springboot2.0默认连接池，官方也是推荐使用HikariCP。

（2）mysql中db1数据库里面的表

（3） 用screw自动生成数据库文档：

/**

• @author 王恒杰

• @version 1.0

• @date 2021/11/14 15:32

• @email 1078993387@qq.com

• @Address 天津

• @Description:

*/

public class Test {

/**

• 路径

*/

private static final String MYSQL_URL = “jdbc:mysql://localhost:3306”;

/**

• 数据库名

*/

private static final String MYSQL_NAME = “db1?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai”;

/**

• mysql用户名

*/

private static final String MYSQL_USERNAME = “root”;

/**

• mysql密码

*/

private static final String MYSQL_PASSWORD = “root”;

/**

• 文件输出目录

*/

private static final String FILE_OUTPUT_DIR = “E:\”;

/**

• 可以设置 Word 或者 Markdown 格式

*/

private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;

private static final String DOC_FILE_NAME = “java实现数据库表设计文档”;

private static final String DOC_VERSION = “V1.0.0”;

private static final String DOC_DESCRIPTION = “数据库表设计描述”;

public static void main(String[] args) {

// 创建 screw 的配置

Configuration config = Configuration.builder()

// 版本

.version(DOC_VERSION)

// 描述

.description(DOC_DESCRIPTION)

// 数据源

.dataSource( buildDataSource())

// 引擎配置

.engineConfig(buildEngineConfig())

// 处理配置

.produceConfig(buildProcessConfig())

.build();

// 执行 screw，生成数据库文档

new DocumentationExecute(config).execute();

}

/**

• 创建数据源

*/

private static HikariDataSource buildDataSource() {

// 创建 HikariConfig 配置类

HikariConfig hikariConfig = new HikariConfig();

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

hikariConfig.setJdbcUrl(MYSQL_URL + “/” + MYSQL_NAME);

hikariConfig.setUsername(MYSQL_USERNAME);

hikariConfig.setPassword(MYSQL_PASSWORD);

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

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

hikariConfig.setMinimumIdle(2);

hikariConfig.setMaximumPoolSize(5);

// 创建数据源

HikariDataSource hikariDataSource = new HikariDataSource(hikariConfig);

return hikariDataSource;

}

/**

• 创建 screw 的引擎配置

*/

private static EngineConfig buildEngineConfig() {

return EngineConfig.builder()

// 生成文件路径

.fileOutputDir(FILE_OUTPUT_DIR)

// 打开目录

.openOutputDir(false)

// 文件类型

.fileType(FILE_OUTPUT_TYPE)

// 文件类型

.produceType(EngineTemplateType.freemarker)

// 自定义文件名称

.fileName(DOC_FILE_NAME)

.build();

}

/**

• 创建 screw 的处理配置，一般可忽略

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

*/

private static ProcessConfig buildProcessConfig() {

return ProcessConfig.builder()

// 根据名称指定表生成

.designatedTableName(Collections.emptyList())

// 根据表前缀生成

.designatedTablePrefix(Collections.emptyList())

// 根据表后缀生成

.designatedTableSuffix(Collections.emptyList())

// 忽略数据库中address这个表名

.ignoreTableName(Arrays.asList(“address”))

// 忽略表前缀，就是db1数据库中表名是t_开头的都不生产数据库文档(t_student,t_user这两张表)

.ignoreTablePrefix(Collections.singletonList(“t_”))

// 忽略表后缀(就是db1数据库中表名是_teacher结尾的都不生产数据库文档：stu_teacher)

.ignoreTableSuffix(Collections.singletonList(“_teacher”))

.build();

}

• 控制台打印部分信息

三：java自动生成的《数据库文档》

=====================================================================================

数据库设计文档

==========================================================================

数据库名： db1

文档版本： V1.0.0

文档描述： 数据库表设计描述

| 表名 | 说明 |

| — | — |

| admin | |

| card | |

| dep | |

| emp | |

| person | |

| student | |

| teacher | |

| user | |

表名： admin

说明：

数据列：

| 序号 | 名称 | 数据类型 | 长度 | 小数位 | 允许空值 | 主键 | 默认值 | 说明 |

| — | — | — | — | — | — | — | — | — |

| 1 | id | int | 10 | 0 | N | Y | | |

| 2 | name | varchar | 20 | 0 | N | N | | |

| 3 | password | varchar | 20 | 0 | N | N | | |

表名： card

说明：

数据列：

| 序号 | 名称 | 数据类型 | 长度 | 小数位 | 允许空值 | 主键 | 默认值 | 说明 |

| — | — | — | — | — | — | — | — | — |

| 1 | id | int | 10 | 0 | N | Y | | |

| 2 | number | varchar | 30 | 0 | Y | N | | |

| 3 | pid | int | 10 | 0 | Y | N | | |

表名： dep

说明：

数据列：

| 序号 | 名称 | 数据类型 | 长度 | 小数位 | 允许空值 | 主键 | 默认值 | 说明 |

| — | — | — | — | — | — | — | — | — |

| 1 | id | int | 10 | 0 | N | Y | | |

| 2 | name | varchar | 20 | 0 | N | N | | |

| 3 | address | varchar | 50 | 0 | N | N | | |

表名： emp

说明：

数据列：

| 序号 | 名称 | 数据类型 | 长度 | 小数位 | 允许空值 | 主键 | 默认值 | 说明 |

| — | — | — | — | — | — | — | — | — |

| 1 | id | int | 10 | 0 | N | Y | | |

| 2 | username | varchar | 20 | 0 | N | N | | |

最后

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

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

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

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

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

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

[外链图片转存中…(img-v7p9LOT6-1715365099432)]

[外链图片转存中…(img-Sd3Bifzi-1715365099433)]

[外链图片转存中…(img-zVQ7wZd2-1715365099433)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

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