夜雨聆风
开源|一款数据库表结构文档生成工具,彻底告别手动写文档的繁琐,支持 html,md,word 格式输出
前言
做过企业级开发的朋友应该都懂，写数据库表结构文档这件事有多让人头疼。
项目初期，大家兴致勃勃地讨论需求、画原型、敲代码，数据库设计文档往往被搁置一旁。等到项目交付，客户突然要一份完整的表结构说明，这时候才发现文档要么残缺不全，要么干脆没有。更崩溃的是，有些文档还是手写维护的，表结构改了十几版，文档还停留在V1版。
后期运维阶段，新同事入职要熟悉系统，对着几百张表一脸茫然；线上出了问题需要排查，翻半天找不到字段含义；版本迭代改了字段类型，文档却没同步更新，给后人埋下一堆坑。
这种”文档欠债”的困境，几乎每个技术团队都经历过。手动维护不仅耗时耗力，还容易遗漏，一旦忘记更新，后续的工作就会处处受阻。
那有没有一款工具，能帮我们自动生成、自动同步数据库文档呢？
还真有。今天要介绍的这款开源工具，专门处理这个痛点，让你从繁琐的文档工作中彻底解放出来。
介绍
这款名为 Screw 的工具，名字取自雷锋日记里的”螺丝钉精神”，虽然细小，却是机器运转不可或缺的部分。作者在企业开发中深受文档维护之苦，2020年利用业余时间开发完成，开源后迅速成为众多开发者的效率利器。
前端
Screw 的文档输出界面设计简洁清爽，没有花哨的装饰，专注于信息的清晰呈现。生成的 HTML 文档采用响应式布局，在电脑和手机上都能舒适阅读。Word 和 Markdown 格式的排版也相当规整，直接就能放进项目交付材料或者技术分享文档里。
后端
底层采用 Java 开发，核心逻辑是读取数据库元数据，通过模板引擎渲染成各种格式的文档。设计上充分考虑了扩展性，新增数据库支持或者自定义输出格式都比较容易。
特点
简洁轻量，即插即用
整个工具就一个核心依赖，引入 Maven 后几行代码就能跑起来。没有复杂的配置项，没有沉重的架构负担，就像一把顺手的螺丝刀，拿起来就能用。
多数据库兼容
MySQL、MariaDB、TiDB、Oracle、SQL Server、PostgreSQL 这些主流数据库都支持，连 Cache DB 这类相对小众的数据库也能应对。国产数据库如达梦、人大金仓、瀚高等也在持续适配中。
多种格式输出
HTML 适合在线浏览和分享，Word 便于编辑和打印，Markdown 则融入技术文档体系。三种格式覆盖绝大多数使用场景。
灵活的过滤机制
可以只生成某些表，也可以按前缀后缀批量过滤。比如忽略所有测试表、临时表，或者只生成核心业务表的文档，避免无关信息干扰。
自定义模板
基于 Freemarker 模板引擎，完全可以按照自己的审美和公司规范定制文档样式。觉得默认模板不够好看？动手改一改就行。
技术架构
整体架构很清晰：数据源配置层负责连接各种数据库，元数据抓取层解析表结构、字段、索引等信息，处理配置层管理生成规则，最后通过模板引擎输出目标格式的文档。
这种分层设计让各个模块职责明确，想扩展新数据库只需实现对应的元数据抓取逻辑，想支持新格式只需新增模板文件。
部署方式
普通 Java 项目引入
在 pom.xml 中加入 screw-core 依赖，编写一个配置类设置数据源和输出参数，调用 DocumentationExecute 即可生成文档。代码量很少，集成到现有项目的工具类或者测试目录里都很方便。
<dependency> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-core</artifactId> <version>${lastVersion}</version> </dependency>
Maven 插件方式
更推荐的做法是直接配置 screw-maven-plugin。在项目的 build 节点里配好数据库连接信息和输出参数，编译阶段就会自动生成文档。这种方式零侵入，不污染业务代码，团队协作时也能保证文档随代码版本同步更新。
配置里可以文档标题、版本号、描述信息，还能控制是否自动打开输出目录。执行 mvn compile 后，文档就静静躺在 target 目录里了。
开源协议
采用 LGPL 3.0 协议开源，这意味着你可以免费使用、修改，甚至在商业项目中集成。
需要注意的是，如果你对工具本身做了修改并发布，需要开源你的改动部分。单纯作为工具使用生成文档，对商业应用没有任何限制，可以放心接入公司项目。
即刻体验一波
假设你手头有个电商项目，数据库里躺着用户表、订单表、商品表、库存表等几十张表。以前写文档，得一张张打开 Navicat 复制字段名、类型、注释，粘贴到 Word 里调格式，半天过去眼睛都花了。
现在配置好数据库连接，输出为 HTML 格式，执行后一份排版精美的文档就生成了。表名、字段名、数据类型、长度、是否可空、默认值、注释说明，所有信息一目了然。索引和主键信息也完整呈现，外键关系清晰标注。
换成 Word 格式，直接就能放进交付文档；换成 Markdown，往 Git 或者文档站点一贴，团队协同时随时查阅。
有张测试表不想放进正式文档？配置 ignoreTableName 过滤掉就行。只想生成核心业务表？用 designatedTablePrefix 前缀批量筛选。这些细节设计让工具真正贴合实际工作流。
业务场景
项目交付场景
客户突然要数据库设计文档，以前可能得加班整理好几天。现在运行一下工具，几分钟生成专业文档，交付质量瞬间提升。
团队协作场景
新成员加入项目，面对陌生的数据库结构往往无从下手。一份实时同步的表结构文档，能大幅降低熟悉成本，减少沟通摩擦。
技术沉淀场景
项目迭代过程中表结构不断调整，手动维护的文档逐渐失真。把工具集成到 CI 流程，每次构建自动生成最新文档，技术资产持续保鲜。
多环境管理场景
开发环境、测试环境、生产环境的表结构可能存在差异。针对不同环境分别生成文档，快速比对排查问题。
结语
工具的价值在于处理真实问题。没有试图做一个大而全的数据库管理平台，而是专注做好一件事：让数据库文档的生成和维护变得简单可靠。这种克制的产品思维，恰恰是企业开发中最需要的。
如果你也在为数据库文档发愁，不妨试试这个”螺丝钉”工具。小而美的设计，往往能在关键时刻发挥大作用。
若需要获取源码可后台私回：Screw
往期项目
开源ima和OpenClaw的平替|ChatClaw，支持聊天AI问答+任务自动化，沙箱隔离，飞书/钉钉划词AI回复、本地知识库管理
开源|一款企业级Web文件管理系统，支持百种格式在线预览、秒传去重、历史版本回溯、多端同步与团队空间协作
开源|一款自带国密算法的全栈开发平台，等保测评、信创适配轻松搞定
开源|一份35万字的AI助手实战教程，支持多平台接入、1800+技能扩展、多Agent协作的超级个体工作手册
开源|一款轻量级微信消息推送服务，支持 Docker 部署与自动化通知集成
了解更多
