導(dǎo)出數(shù)據(jù)庫(kù)中標(biāo)的定義，即所謂的數(shù)據(jù)字典

一、新建maven工程中加入依賴
在maven工程的pom.xml中添加依賴

    <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.5</version>
    </dependency>
    <dependency>
      <groupId>com.zaxxer</groupId>
      <artifactId>HikariCP</artifactId>
      <version>3.3.1</version>
    </dependency>

二、在maven工程，將如下GenerateDocument .java文件加入工程中；

package org.example;

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;

/**
 * 生成文檔
 *
 * @author ybw
 * @version V1.0
 * @className GenerateDocument
 * @date 2023/2/9
 **/
public class GenerateDocument {

    public static void main(String[] args) {
        String fileOutputDir = "D:/";
        documentGeneration(fileOutputDir);
    }

    /**
     * 文檔生成
     *
     * @param fileOutputDir 生成文件路徑
     * @methodName: documentGeneration
     * @return: void
     * @author: ybw
     * @date: 2023/2/9
     **/
    static void documentGeneration(String fileOutputDir) {
        //數(shù)據(jù)源
        HikariConfig hikariConfig = new HikariConfig();
//        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://172.18.xxx.xxx:9030/db_name1111");
        hikariConfig.setUsername("xxxxx");
//        hikariConfig.setPassword("xxxxxx");
        //設(shè)置可以獲取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路徑
                .fileOutputDir(fileOutputDir)
                //打開(kāi)目錄
                .openOutputDir(true)
                //文件類(lèi)型
                .fileType(EngineFileType.WORD)
                //生成模板實(shí)現(xiàn)
                .produceType(EngineTemplateType.freemarker)
                //自定義文件名稱
                .fileName("測(cè)試庫(kù)").build();

        //忽略表
        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");
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成邏輯、當(dāng)存在指定表、指定表前綴、指定表后綴時(shí)，將生成指定表，其余表不生成、并跳過(guò)忽略表配置
                //根據(jù)名稱指定表生成
                .designatedTableName(new ArrayList<>())
                //根據(jù)表前綴生成
                .designatedTablePrefix(new ArrayList<>())
                //根據(jù)表后綴生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前綴
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后綴
                .ignoreTableSuffix(ignoreSuffix).build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("數(shù)據(jù)庫(kù)設(shè)計(jì)文檔生成")
                //數(shù)據(jù)源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
        //執(zhí)行生成
        new DocumentationExecute(config).execute();
    }
}

修改想要導(dǎo)出的mysql鏈接參數(shù)，直接執(zhí)行即可導(dǎo)入數(shù)據(jù)庫(kù)設(shè)計(jì)的word文檔文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-739920.html

到了這里，關(guān)于一鍵導(dǎo)出數(shù)據(jù)庫(kù)中表結(jié)構(gòu)定義(數(shù)據(jù)字典)的工具的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！