SpringBoot整合screw實現(xiàn)自動生成數據庫設計文檔

更新時間：2022年11月24日 09:31:40 作者：洛陽泰山

使用navicat工作的話，導出的格式是excel不符合格式，還得自己整理。所以本文將用screw工具包，整合到springboot的項目中便可以自動生成數據庫設計文檔，非常方便，下面就分享一下教程

前言

最近因為工作的需要，讓我寫數據庫設計文檔，可是我最煩文檔類的工作了，之前寫過一篇文章（在下文補充內容中），使用的navicat工作，不過導出的格式是excel不符合格式，還得自己整理，現(xiàn)在用screw 工具包，整合到springboot的項目中便可以自動生成數據庫設計文檔，非常方便，下面就分享一下教程

提示：以下是本篇文章正文內容，下面案例可供參考

一、screw 是什么

screw是一個一鍵式生成數據庫文檔的開源工具包，目前screw可以生成word、md和html格式類的文檔，支持freemarker和velocity兩種模板引擎。數據源支持HikariDataSource，DruidDataSource可能會發(fā)生類型轉換報錯。

二、使用步驟

1.引入庫

pom文件中引入jar依賴

<!--  數據庫設計文檔生成工具-->
<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version>
</dependency>

2.代碼示例

代碼如下（下面用的是postgres數據庫）：

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.List;
 
public class DatabaseDesignDocUtil {
 
    public static void main(String[] args) {
        documentGeneration();
    }
 
    /**
     * 文檔生成
     */
    public static void documentGeneration() {
        //數據源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("org.postgresql.Driver");
        hikariConfig.setJdbcUrl("jdbc:postgresql://39.164.52.80:5432/work_face");
        hikariConfig.setUsername("postgres");
        hikariConfig.setPassword("POSTGRES");
        //設置可以獲取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路徑
                .fileOutputDir("C:\\Users\\tarzan\\Desktop\\doc")
                //打開目錄
                .openOutputDir(true)
                //文件類型
                .fileType(EngineFileType.WORD)
                //生成模板實現(xiàn)
                .produceType(EngineTemplateType.freemarker)
                //自定義文件名稱
                .fileName("智能工作面數據庫設計文檔").build();
 
        //忽略表
        List<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");
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成邏輯、當存在指定表、指定表前綴、指定表后綴時，將生成指定表，其余表不生成、并跳過忽略表配置
                //根據名稱指定表生成
                .designatedTableName(new ArrayList<>())
                //根據表前綴生成
                .designatedTablePrefix(new ArrayList<>())
                //根據表后綴生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前綴
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后綴
                .ignoreTableSuffix(ignoreSuffix).build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("數據庫設計文檔生成")
                //數據源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
        //執(zhí)行生成
        new DocumentationExecute(config).execute();
    }
 
}

需要改成mysql等別的數據庫的，請在代碼中改下驅動配置和連接配置。

三、使用方法

idea等編輯器里，運行main的主方法即可。

控制臺輸出示例

生成文檔展示

補充

mysql數據庫設計文檔-導出字段設計

打開navicat，新建查詢窗口

查詢sql

SELECT
	TABLE_NAME 表名,
	COLUMN_NAME 字段名稱,
	COLUMN_TYPE 字段類型,
IF
	( IS_NULLABLE = 'YES', '是', '否' ) 是否可為空,
IF
	( COLUMN_KEY = 'PRI', '是', '否' ) 是否主鍵,
	COLUMN_COMMENT 字段注釋 
FROM
	INFORMATION_SCHEMA.COLUMNS 
WHERE
	TABLE_SCHEMA = '數據庫名稱' 
	-- 數據表名，可以不填寫，查詢全部表結構
	AND TABLE_NAME = '表名'

查詢結果