基于Java GUI编写的数据库设计文档生成工具

---

前言

先说一句，2022，祝读者们新年快乐！
也有挺久没更新文章了，不能说是没时间，因为确实是懒，嗯，能这么理直气壮（不要脸）说的人估计就我了，嘿嘿
春节在家其实挺无聊的，于是花了两天时间，写了一款数据库设计文档生成工具。
为什么要做这个东西，一来，是工作需要，因为开发需要产出数据库设计文档，二来，虽然市面上的现成工具很多，但是都是源码式的，操作过程对我这种巨懒的人来说，有点不太友好了，于是为了方便自己后续的使用，自己写了一个

---

一、开发思路

对我来说，最方便就是界面傻瓜式地点点点，于是采用了 Java GUI 的方式来实现我的需求。
数据库设计文档生成，该怎么去实现呢，原理我理解其实就是如下的一个过程，输入数据源连接信息、采集数据库的元数据、输出到文档文件，如下图

二、工程介绍

1、工程代码结构如下

db2document
├── constant -- 系统常量
├── engine -- 文档输出模板引擎
    ├── freemark -- 具体模板引擎
├── jdbc -- 数据源元数据采集
├── model -- 元数据实体
├── ui -- GUI 界面
    ├── listenner -- 按钮监听器
├── util -- 工具类

2、支持数据源

目前只支持MySql，后续可以通过扩展支持其他的数据源。由于本人开发常用的只有MySql，所以暂时只做了这个，后续有时间考虑扩展，尽量多地支持常见的数据源。

3、设计

• 代码其实并不多，只有几个类，GUI的开发花了点时间（样式真的不好调，怀念以前用eclipse还可以用window builder拖拉拽来生成）
• 代码相对来说不算很糟糕，但是没有给以后的扩展留够足够的空间，这是个缺陷，欢迎提PR完善。
• 文档生成部分参照的开源项目 screw 的模板引擎，感谢开源（也算是受于开源，哺之开源了吧，哈）

---

三、演示

1、工具演示

2、文档效果

四、项目地址

项目地址我放在了 gitee，地址：https://gitee.com/lin_zhi_peng/db2document

五、总结

目前工程还未太完善，等后面封版，直接到release下载安装程序即可。
有动手能力的同学也可以直接用exe4j和 innosetup这两个工具来自行打包。
仅以此文章来记录一下开发过程，我喜欢用编程来改变自己的生活，算是一种积累吧

PS: 2022/2/5 更新：工程已定版，访问项目地址https://gitee.com/lin_zhi_peng/db2document/releases/v1.0.0
下载 db2documentSetup.exe 安装文件进行安装即可（Linux和Mac用户抱歉）