java如何實現(xiàn)自動生成數(shù)據(jù)庫設(shè)計文檔

更新時間：2021年11月22日 11:16:45 作者：java李楊勇

以前我們還需要手寫數(shù)據(jù)庫設(shè)計文檔、現(xiàn)在可以通過引入screw核心包來實現(xiàn)Java?數(shù)據(jù)庫文檔一鍵生成。本文將具體介紹一下如何通過java自動生成數(shù)據(jù)庫設(shè)計文檔，需要的朋友可以參考下

前言

以前我們還需要手寫數(shù)據(jù)庫設(shè)計文檔、現(xiàn)在可以通過引入screw核心包來實現(xiàn)Java 數(shù)據(jù)庫文檔一鍵生成。話不多說、直接上代碼演示。

支持的數(shù)據(jù)庫列表：

MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
這些主流的數(shù)據(jù)庫都支持的。

實現(xiàn)步驟

引入 pom.xml核心配置screw包

       <dependency>
			<groupId>cn.smallbun.screw</groupId>
			<artifactId>screw-core</artifactId>
			<version>1.0.5</version>
		</dependency>

main方法類全部代碼

package com.railway.modules.sys.controller;
 
/**
 * Created by LiYangYong on 2021/11/11
 */
 
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.Collections;
 
/**
 * Created by LiYangYong on 2021/11/11.
 */
public class TestScrewMain {
    private static final String DB_URL = "jdbc:mysql://localhost:3307";
    private static final String DB_NAME = "renren_fast?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai";
    private static final String DB_USERNAME = "root";
    private static final String DB_PASSWORD = "crit@2019";
 
    private static final String FILE_OUTPUT_DIR = "C:\\Users\\Administrator\\Desktop\\java\\";
    // 可以設(shè)置 Word 或者 Markdown 格式
    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
    private static final String DOC_FILE_NAME = "數(shù)據(jù)庫表設(shè)計文檔";
    private static final String DOC_VERSION = "V1.0.0";
    private static final String DOC_DESCRIPTION = "數(shù)據(jù)庫表設(shè)計描述";
 
    public static void main(String[] args) {
        // 創(chuàng)建 screw 的配置
        Configuration config = Configuration.builder()
                // 版本
                .version(DOC_VERSION)
                // 描述
                .description(DOC_DESCRIPTION)
                // 數(shù)據(jù)源
                .dataSource(buildDataSource())
                // 引擎配置
                .engineConfig(buildEngineConfig())
                // 處理配置
                .produceConfig(buildProcessConfig())
                .build();
 
        // 執(zhí)行 screw，生成數(shù)據(jù)庫文檔
        new DocumentationExecute(config).execute();
    }
 
    /**
     * 創(chuàng)建數(shù)據(jù)源
     */
    private static DataSource buildDataSource() {
        // 創(chuàng)建 HikariConfig 配置類
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");
        hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME);
        hikariConfig.setUsername(DB_USERNAME);
        hikariConfig.setPassword(DB_PASSWORD);
        // 設(shè)置可以獲取 tables remarks 信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        // 創(chuàng)建數(shù)據(jù)源
        return new HikariDataSource(hikariConfig);
    }
 
    /**
     * 創(chuàng)建 screw 的引擎配置
     */
    private static EngineConfig buildEngineConfig() {
        return EngineConfig.builder()
                // 生成文件路徑
                .fileOutputDir(FILE_OUTPUT_DIR)
                // 打開目錄
                .openOutputDir(false)
                // 文件類型
                .fileType(FILE_OUTPUT_TYPE)
                // 文件類型
                .produceType(EngineTemplateType.freemarker)
                // 自定義文件名稱
                .fileName(DOC_FILE_NAME)
                .build();
    }
 
    /**
     * 創(chuàng)建 screw 的處理配置，一般可忽略
     * 指定生成邏輯、當存在指定表、指定表前綴、指定表后綴時，將生成指定表，其余表不生成、并跳過忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
                // 根據(jù)名稱指定表生成
                .designatedTableName(Collections.<String>emptyList())
                // 根據(jù)表前綴生成
                .designatedTablePrefix(Collections.<String>emptyList())
                // 根據(jù)表后綴生成
                .designatedTableSuffix(Collections.<String>emptyList())
                // 忽略表名
                .ignoreTableName(Arrays.asList("test", "mytable","role","t_role","t_user"))
                // 忽略表前綴
                //.ignoreTablePrefix(Collections.singletonList("t_"))
                // 忽略表后綴
                //.ignoreTableSuffix(Collections.singletonList("_test"))
                .build();
    }
 
 
}

生成的數(shù)據(jù)庫設(shè)計文檔演示

?