永不生锈的螺丝钉！一款简洁好用的数据库表结构文档生成器 ...

大家好，我是 Java陈序员。
在企业级开辟中，我们经常会有编写数据库表结构文档的需求，经常必要手写维护文档，非常繁琐。
今天，给大家介绍一款数据库表结构文档生成工具。

关注微信公众号：【Java陈序员】，获取开源项目分享、AI副业分享、超200本经典盘算机电子书籍等。

项目介绍

screw  —— 螺丝钉（代表企业级开辟中一颗永不生锈的螺丝钉），是一款简洁好用的数据库表结构文档生成工具。

screw  主打简洁、轻量，支持多种数据库、多种格式文档，可自界说模板举行机动拓展。

• 支持 MySQL、MariaDB、TIDB、Oracle 多种数据库。
  

• 支持生成 HTML、Word、MarkDown 三种格式的文档。
  

快速上手

screw  有普通方式、Maven 插件的两种方式来生成文档。
普通方式

1、引入依靠

1. <dependency>
2.     <groupId>mysql</groupId>
3.     <artifactId>mysql-connector-java</artifactId>
4.     <version>8.0.29</version>
5. </dependency>
8. <dependency>
9.     <groupId>cn.smallbun.screw</groupId>
10.     <artifactId>screw-core</artifactId>
11.     <version>1.0.5</version>
12. </dependency>

复制代码

2、编写代码

1. public class DocumentGeneration {
3.     /**
4.      * 文档生成
5.      */
6.     @Test
7.     public void documentGeneration() {
9.         // 文档生成路径
10.         String fileOutputPath = "D:\\database";
12.         // 数据源
13.         HikariConfig hikariConfig = new HikariConfig();
14.         // 指定数据库驱动
15.         hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
16.         // 设置数据库连接地址
17.         hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/database");
18.         // 设置数据库用户
19.         hikariConfig.setUsername("root");
20.         // 设置数据库密码
21.         hikariConfig.setPassword("root");
22.         // 设置可以获取 tables remarks 信息
23.         hikariConfig.addDataSourceProperty("useInformationSchema", "true");
24.         hikariConfig.setMinimumIdle(2);
25.         hikariConfig.setMaximumPoolSize(5);
27.         DataSource dataSource = new HikariDataSource(hikariConfig);
28.         // 生成配置
29.         EngineConfig engineConfig = EngineConfig.builder()
30.                 // 生成文件路径
31.                 .fileOutputDir(fileOutputPath)
32.                 // 打开目录
33.                 .openOutputDir(true)
34.                 // 文件类型 HTML、WORD、MD 三种类型
35.                 .fileType(EngineFileType.HTML)
36.                 // 生成模板实现
37.                 .produceType(EngineTemplateType.freemarker)
38.                 // 自定义文件名称
39.                 .fileName("Document")
40.                 .build();
42.         // 忽略表
43.         ArrayList<String> ignoreTableName = new ArrayList<>();
44.         ignoreTableName.add("test_user");
45.         ignoreTableName.add("test_group");
47.         //忽略表前缀
48.         ArrayList<String> ignorePrefix = new ArrayList<>();
49.         ignorePrefix.add("test_");
51.         //忽略表后缀
52.         ArrayList<String> ignoreSuffix = new ArrayList<>();
53.         ignoreSuffix.add("_test");
55.         ProcessConfig processConfig = ProcessConfig.builder()
56.                 // 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
57.                 // 根据名称指定表生成
58.                 .designatedTableName(new ArrayList<>())
59.                 // 根据表前缀生成
60.                 .designatedTablePrefix(new ArrayList<>())
61.                 // 根据表后缀生成
62.                 .designatedTableSuffix(new ArrayList<>())
63.                 // 忽略表名
64.                 .ignoreTableName(ignoreTableName)
65.                 // 忽略表前缀
66.                 .ignoreTablePrefix(ignorePrefix)
67.                 // 忽略表后缀
68.                 .ignoreTableSuffix(ignoreSuffix)
69.                 .build();
70.         //配置
71.         Configuration config = Configuration.builder()
72.                 // 版本
73.                 .version("1.0.0")
74.                 // 描述
75.                 .description("数据库设计文档生成")
76.                 // 数据源
77.                 .dataSource(dataSource)
78.                 // 生成配置
79.                 .engineConfig(engineConfig)
80.                 // 生成配置
81.                 .produceConfig(processConfig)
82.                 .build();
84.         //执行生成
85.         new DocumentationExecute(config).execute();
86.     }
87. }

复制代码

3、实行代码输出文档

Maven 插件

1、引入依靠

1. <build>
2.     <plugins>
3.         <plugin>
4.             <groupId>cn.smallbun.screw</groupId>
5.             <artifactId>screw-maven-plugin</artifactId>
6.             <version>1.0.5</version>
7.             <dependencies>
8.                
9.                 <dependency>
10.                     <groupId>com.zaxxer</groupId>
11.                     <artifactId>HikariCP</artifactId>
12.                     <version>3.4.5</version>
13.                 </dependency>
14.                
15.                 <dependency>
16.                     <groupId>mysql</groupId>
17.                     <artifactId>mysql-connector-java</artifactId>
18.                     <version>8.0.20</version>
19.                 </dependency>
20.             </dependencies>
21.             <configuration>
22.                
23.                 <username>root</username>
24.                
25.                 <password>password</password>
26.                
27.                 <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
28.                
29.                 <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxx</jdbcUrl>
30.                
31.                 <fileType>HTML</fileType>
32.                
33.                 <openOutputDir>false</openOutputDir>
34.                
35.                 <produceType>freemarker</produceType>
36.                
37.                 <fileName>数据库文档</fileName>
38.                
39.                 <description>数据库文档生成</description>
40.                
41.                 <version>${project.version}</version>
42.                
43.                 <title>数据库文档</title>
44.             </configuration>
45.             <executions>
46.                 <execution>
47.                     <phase>compile</phase>
48.                     <goals>
49.                         <goal>run</goal>
50.                     </goals>
51.                 </execution>
52.             </executions>
53.         </plugin>
54.     </plugins>
55. </build>

复制代码

2、实行插件

3、使用 Maven 插件实行的方式会将文档输出到项目根目录的 doc 目录下

文档截图

HTML 范例文档

Word 范例文档

MarkDown 范例文档

自从用了 screw  后，编写数据库文档信息就很方便了，一键生成，剩下的时间就可以用来摸鱼了~
大家如果下次有必要编写数据库文档，可以考虑使用 screw ，建议先把本文收藏起来，下次就不会找不到了~
最后，贴上项目地址：

1. https://github.com/pingfangushi/screw

复制代码

最后

推荐的开源项目已经收录到 GitHub 项目，欢迎 Star：

1. https://github.com/chenyl8848/great-open-source-project

复制代码

大概访问网站，举行在线欣赏：

1. https://chencoding.top:8090/#/

复制代码

大家的点赞、收藏和批评都是对作者的支持，如文章对你有帮助还请点赞转发支持下，谢谢！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。