一键生成数据库表结构文档认准：screw工具（超级好用^

1. 简介

在企业级开发当中，后台数据就是我们整个项目的核心之处，对于数据我常花时间来进行维护。当需要维护我们的数据库时，或者需要查看数据库中的表结构，这个时候要有相应的数据库表结构文档供开发或者运维人员查看。这项工作看似很简单，但是实际手工维护到文档之中是一件非常繁琐、也容易出错的一件事。在此，开发人员设计出了一款插件screw（螺丝钉），这款插件非常的nice，它的初衷就是为了一键生成出我们的数据库表结构文档，详细清晰明了。特此本人从网上找到这款插件，并对此做出详细的介绍和使用说明，也方便与小伙伴们进行学习交流呀！

2. 特点

（1）简洁、轻量、设计良好
（2）多数据库支持
（3）多种格式文档
（4）灵活扩展
（5）支持自定义模块

3. 数据库支持

☑ MySQL
☑ MariaDB
☑ TIDB
☑ Oracle
☑ SqlServer
☑ PostgreSQL
☑ Cache DB (2016)
其他的数据库还在开发之中，更多的版本迭代可以在Gitee中查看相关的源码，源码的网址为：screw在Gitee中的源码网址

4. 文档支持

☑ html
☑ word
☑ markdown

5. 使用方式

5.1. 方式一：引入依赖+编写代码

① 引入依赖：

        <!-- screw核心 --><dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.3</version></dependency><!-- HikariCP  数据库连接池--><dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>3.4.5</version></dependency><!--mysql driver--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.20</version></dependency>

② 编写代码：

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;import javax.sql.DataSource;
import java.util.Arrays;
import java.util.List;/*** @ClassName: GenerateDatabaseDocument* @Description:* @Author: YuHao* @Date: 2022/3/25*/
public class GenerateDatabaseDocument {public static void main(String[] args) {// 数据源HikariConfig hikariConfig = new HikariConfig();hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/****?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8");hikariConfig.setUsername("****");hikariConfig.setPassword("****");// 设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);// 1、生成文件配置EngineConfig engineConfig = EngineConfig.builder()// 生成文件路径.fileOutputDir("E:/")// 打开目录.openOutputDir(false)// 文件类型:WORD为doc文档，MD为Markdown文档，HTML则为HTML的网页格式.fileType(EngineFileType.WORD)// 生成模板实现.produceType(EngineTemplateType.freemarker).build();// 忽略表名List<String> ignoreTableName = Arrays.asList("test");// 忽略表前缀List<String> ignorePrefix = Arrays.asList("test_", "test");// 忽略表后缀List<String> ignoreSuffix = Arrays.asList("_test", "test");// 2、配置想要忽略的表ProcessConfig processConfig = ProcessConfig.builder().ignoreTableName(ignoreTableName).ignoreTablePrefix(ignorePrefix).ignoreTableSuffix(ignoreSuffix).build();// 3、生成文档配置（包含以下自定义版本号、描述等配置连接）Configuration config = Configuration.builder().version("1.0.0").description("数据库文档").dataSource(dataSource).engineConfig(engineConfig).produceConfig(processConfig).build();// 4、执行生成new DocumentationExecute(config).execute();}
}

5.2. 方式二：Maven插件

<build><plugins><plugin><groupId>cn.smallbun.screw</groupId><artifactId>screw-maven-plugin</artifactId><version>${lastVersion}</version><dependencies><!-- HikariCP --><dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>3.4.5</version></dependency><!--mysql driver--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.20</version></dependency></dependencies><configuration><!--username--><username>****</username><!--password--><password>****</password><!--driver--><driverClassName>com.mysql.cj.jdbc.Driver</driverClassName><!--jdbc url--><jdbcUrl>jdbc:mysql://127.0.0.1:3306/****</jdbcUrl><!--生成文件类型 文件类型:WORD为doc文档，MD为Markdown文档，HTML则为HTML的网页格式--><fileType>HTML</fileType><!--打开文件输出目录--><openOutputDir>false</openOutputDir><!--生成模板--><produceType>freemarker</produceType><!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称--><fileName>测试文档名称</fileName><!--描述--><description>数据库文档生成</description><!--版本--><version>${project.version}</version><!--标题--><title>数据库文档</title></configuration><executions><execution><phase>compile</phase><goals><goal>run</goal></goals></execution></executions></plugin></plugins>
</build>

以上两种方式都是可行的，尝试过后生成效果都是一样的。不管是用方式一和方式二来使用此款插件，只需要将以上的"****"对应上我们的数据库表，数据库用户名和密码，运行。本人建议还是使用第一种方式吧，不管是运行或者修改文件类型是在类中修改就可以了，更加的方便直观。

6. 使用效果

通过插件的使用生成三种文件类型如下所示：
① html页面

② word文档

③ markdown文档
由于本人在这里是用记事本打开的md文件，所以截图页面是比较丑的，其实在一般情况下，查看数据库表结构文档我们用①和②就能满足业务的需求。

7. 结束语

简洁好用的数据库表结构文档生成工具screw生成文件文档一键就能搞定，这必须得安利一波，大家如果觉得好用并且觉得开发人员的开源工具编写不易，可以去源码的网址screw在Gitee中的源码网址对开发人员进行相关的评述和打赏啦，我只是做一个功能相关演示介绍和一名普通的搬运工，O(∩_∩)O哈哈~。

路过的小伙伴，如果博文有帮助到你解决问题，可以点赞+关注一波呀~本人将会持续更新相关学习博文，感谢您的支持哦！！！

一键生成数据库表结构文档认准：screw工具（超级好用^_^）

目录