闲不住，手写了数据库文档生成工具

shigen坚持更新文章的博客写手，擅长Java、python、vue、shell等编程语言和各种应用程序、脚本的开发。记录成长，分享认知，留住感动。 个人IP：shigen

逛博客的时候，发现了一个很有意思的文章：数据库表结构导出工具。带着好奇，我也去DIY了一个，先看看效果：

实现效果

这个就是主要的程序界面，可以选择生成md文档或者docx文档。具体的文档内容如下：

md文档

md文档内容

docx文档

docx文档

功能可以成功的实现，现在我们来分析一下原理，核心就是几条sql语句：

原理分析

查看全部的表

查看全部的表

使用show tables就可以看到当前数据库下边的所有的数据表。

查看表结构

查看表结构

使用desc xxx即可查看表的详细结构，包含字段的全部信息。

查看字段注释

字段的注释需要额外的sql了：

字段注释

当然，shigen也看到过连表查询出字段的注释的，可以进一步的改进。

总结

做一波小总结：其实数据库文档生成，就是用一些sql语句获得对应的表信息和字段信息，使用文本拼接写入到文件里。

代码分享

那本次设计的代码也在这里，欢迎大家学习交流：

与shigen一起，每天不一样！