一款好用的資料庫文檔生成工具-Screw

screw是一個簡潔好用的資料庫表結構文檔的生成工具 ，支援 MySQL、Oracle、PostgreSQL等主流的關系資料庫。

以往我們手寫過資料庫表結構文檔，一通無腦的CV 大法之後，幾十頁至上百頁的Word 文檔就出爐了。screw是一款可以幫我們偷懶高效的自動生成資料庫表結構文檔，解放生産力神器。

screw也适合新入職的新同僚熟悉系統資料庫表結構、字段設計，了解業務。

即簡而言之screw是一個簡潔好用的資料庫表結構文檔生成器。

位址：https://gitee.com/leshalv/screw

2.生成的文檔格式

生成的文檔有 html、word、markdown三種格式 ，示例如下圖所示：

a、html

b、word

c、markdwon

3.支援的資料庫

最新版本1.0.5已支援H2、達夢資料庫。

4.生成文檔的方式

（1）使用 Java 代碼（以下代碼示範了MySQL、Oracle、SqlServer三種資料源）

相關依賴maven倉庫最新版本：https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core/1.0.5

第一步：引入screw相關maven依賴

<!-- 引入資料庫表結構文檔生成器Screw依賴-->
         <dependency>
             <groupId>cn.smallbun.screw</groupId>
             <artifactId>screw-core</artifactId>
             <version>1.0.5</version>
         </dependency>
         <!-- Hikari資料庫連接配接池 也可采用阿裡巴巴的Druid、C3p0等資料庫連接配接池 -->
         <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>
         <!--oracle driver-->
         <dependency>
             <groupId>com.oracle.ojdbc</groupId>
             <artifactId>ojdbc8</artifactId>
             <version>19.3.0.0</version>
         </dependency>
         <dependency>
             <groupId>cn.easyproject</groupId>
             <artifactId>orai18n</artifactId>
             <version>12.1.0.2.0</version>
         </dependency>           

第二步：編寫代碼

package com.example.screw;
 
 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.ArrayList;
 import java.util.Arrays;
 
 public class DocGeneration {
 
     // 以下static final修飾的參數 如果是基于SpringBoot項目，可以在配置檔案中配置，通過@Value注解擷取
     // MySQL驅動 6.0以前的使用com.mysql.jdbc.Driver，6.0以後的使用com.mysql.cj.jdbc.Driver  我這邊使用的是8.0.20版本的
     private static final String Driver_Class_Name = "com.mysql.cj.jdbc.Driver";
     // 資料庫種類 MySQL  Oracle  SQLServer
     private static final String DB_TYPE = "MySQL";
 //    private static final String Driver_Class_Name = "oracle.jdbc.driver.OracleDriver";// Oracle驅動
 //    private static final String Driver_Class_Name = "com.microsoft.sqlserver.jdbc.SQLServerDriver";// SQLServer驅動
 
     // 資料庫URL
     /** 不同資料庫格式示例
      * MySQL  jdbc:mysql://127.0.0.1:3306/mydb?useUnicode=true&characterEncoding=utf-8  jdbc:mysql://IP:端口/資料庫名稱
      * Oracle jdbc:oracle:thin:@127.0.0.1:1521:orcl       jdbc.url=jdbc:oracle:thin:@IP:端口:執行個體名（sid）
      * SqlServer jdbc:sqlserver://127.0.0.1:1433;instanceName=sqlserver2005;DatabaseName=easysite_2005
      * jdbc:sqlserver://IP:端口;instanceName=sqlserver2005（版本）;DatabaseName=easysite_2005（資料庫名稱）
      */
     private static final String DB_URL = "jdbc:mysql://127.0.0.1:3306";// MySQL
 //    private static final String DB_URL = "jdbc:oracle:thin:@127.0.0.1:1521";// Oracle
 //    private static final String DB_URL = "jdbc:sqlserver://127.0.0.1:1433";// SQLServer
     private static final String IGNORE_MISTAKEN_CODE  = "?characterEncoding=UTF-8";//  防止生成後文檔亂碼
 
     //  MySQL資料庫名、Oracle執行個體名、SQLServer版本名和資料庫名
     private static final String DB_NAME = "seckill";// MySQL
 //    private static final String DB_NAME = "orcl";// Oracle
 //    private static final String DB_NAME = ";instanceName=sqlserver2005;DatabaseName=easysite_2005";// SQLServer
     private static final String DB_USERNAME = "root";
     private static final String DB_PASSWORD = "root";
     
     // 生成資料庫文檔檔案路徑 可根據本機電腦自行配置
     private static final String FILE_OUTPUT_DIR = "/Users/mac/screw_test";
 
     private static final String DOC_FILE_NAME = "某某系統資料庫文檔";// 自定義檔案名稱 即資料庫文檔名稱
     private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD; // 檔案類型 HTML->HTML檔案  WORD->WORD檔案  MD->Markdown檔案
     private static final String DOC_VERSION = "1.0.0";
     private static final String DOC_DESCRIPTION = "資料庫設計文檔生成";
 
     public static void main(String[] args) {
         documentGeneration();
     }
 
     /**
      * 資料庫文檔生成
      */
     public static void documentGeneration() {
 
         // 資料源  建立HikariConfig配置類
         HikariConfig hikariConfig = new HikariConfig();
         hikariConfig.setDriverClassName(Driver_Class_Name);
         if("MySQL".equals(DB_TYPE)){
             hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME+IGNORE_MISTAKEN_CODE);
         }else if("Oracle".equals(DB_TYPE)){
             hikariConfig.setJdbcUrl(DB_URL + ":" + DB_NAME);
         }else if("SQLServer".equals(DB_TYPE)){
             hikariConfig.setJdbcUrl(DB_URL + DB_NAME);
         }
         hikariConfig.setUsername(DB_USERNAME);
         hikariConfig.setPassword(DB_PASSWORD);
         // 設定useInformationSchema 可以擷取tables表注釋資訊 即解決資料庫表和列字段有說明、生成文檔沒有說明
         hikariConfig.addDataSourceProperty("useInformationSchema", "true");
         hikariConfig.setMinimumIdle(2);
         hikariConfig.setMaximumPoolSize(5);
         DataSource dataSource = new HikariDataSource(hikariConfig);
         //  建立screw的引擎配置
         EngineConfig engineConfig = EngineConfig.builder()
                 // 生成檔案路徑
                 .fileOutputDir(FILE_OUTPUT_DIR)
                 // 打開目錄
                 .openOutputDir(true)
                 // 檔案類型 HTML->HTML檔案  WORD->WORD檔案  MD->Markdown檔案
                 .fileType(FILE_OUTPUT_TYPE)
                 // 生成模闆實作
                 .produceType(EngineTemplateType.freemarker)
                 // 自定義檔案名稱，即資料庫文檔名稱
                 .fileName(DOC_FILE_NAME).build();
         // 建立screw的處理配置，一般可忽略
         // 忽略表
         ArrayList<String> ignoreTableName = new ArrayList<>();
         ignoreTableName.add("test_user");
         ignoreTableName.add("test_group");
         // 忽略表字首
         ArrayList<String> ignorePrefix = new ArrayList<>();
         ignorePrefix.add("test_");
         // 忽略表字尾
         ArrayList<String> ignoreSuffix = new ArrayList<>();
         ignoreSuffix.add("_test");
         // 需要生成資料庫文檔的表
         ArrayList<String> designatedTableName = new ArrayList<>();
         designatedTableName.add("t_user");
         designatedTableName.add("t_role");
         // 需要生成資料庫文檔的表字首
         ArrayList<String> designatedTablePrefix = new ArrayList<>();
         designatedTablePrefix.add("t_");
         ProcessConfig processConfig = ProcessConfig.builder()
                 // 指定生成邏輯、當存在指定表、指定表字首、指定表字尾時，将生成指定表，其餘表不生成、并跳過忽略表配置
                 // 根據名稱指定表生成
 //                .designatedTableName(Arrays.asList("t_user","t_role"))
                 .designatedTableName(designatedTableName)
                 // 根據表字首生成
                 .designatedTablePrefix(designatedTablePrefix)
                 // 根據表字尾生成
                 .designatedTableSuffix(new ArrayList<>())
                 // 忽略表名
                 .ignoreTableName(ignoreTableName)
                 // 忽略表字首
                 .ignoreTablePrefix(ignorePrefix)
                 // 忽略表字尾
                 .ignoreTableSuffix(ignoreSuffix).build();
         //  建立screw的配置
         Configuration config = Configuration.builder()
                 // 版本
                 .version(DOC_VERSION)
                 // 描述
                 .description(DOC_DESCRIPTION)
                 // 資料源
                 .dataSource(dataSource)
                 // 生成配置
                 .engineConfig(engineConfig)
                 // 生成配置
                 .produceConfig(processConfig)
                 .build();
         // 執行screw，生成資料庫文檔
         new DocumentationExecute(config).execute();
     }
 }