生成数据库设计文档

依赖

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

代码

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.Collections;

public class databaseToPDF {

    static String DB_URL ;
    static String DB_NAME ;
    static String DB_USERNAME ;
    static String DB_PASSWORD;
    static String FILE_OUTPUT_DIR = "E:/";
    static EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD; // 可以设置 Word 或者 Markdown 格式
    static String DOC_FILE_NAME = "数据库文档";
    static String DOC_VERSION = "1.0.0";
    static String DOC_DESCRIPTION = "文档描述";
    static String DRIVER_CLASS_NAME;
    static String SPLIT_SIGN;

    static {
//        setMysql();
        setSqlserver();
    }
    static void setMysql() {
        DB_URL = "jdbc:mysql://10.250.198.51:3306";
        DB_NAME = "initial_ces_cloud_saas_app";
        DB_USERNAME = "root";
        DB_PASSWORD = "pwd_ces_cloud_data";
        DRIVER_CLASS_NAME = "com.mysql.cj.jdbc.Driver";
        SPLIT_SIGN = "/";
    }

    static void setSqlserver() {
        DB_URL = "jdbc:sqlserver://10.250.220.67:1433";
        DB_NAME = "initial_ces_cloud_saas_app";
        DB_USERNAME = "sa";
        DB_PASSWORD = "cesGroup123";
        DRIVER_CLASS_NAME = "com.microsoft.sqlserver.jdbc.SQLServerDriver";
        SPLIT_SIGN = ";DatabaseName=";
    }


    public static void main(String[] args) {
        // 创建 screw 的配置
        Configuration config = Configuration.builder()
                .version(DOC_VERSION)  // 版本
                .description(DOC_DESCRIPTION) // 描述
                .dataSource(buildDataSource()) // 数据源
                .engineConfig(buildEngineConfig()) // 引擎配置
                .produceConfig(buildProcessConfig()) // 处理配置
                .build();

        // 执行 screw，生成数据库文档
        new DocumentationExecute(config).execute();
    }

    /**
     * 创建数据源
     */
    private static DataSource buildDataSource() {
        // 创建 HikariConfig 配置类
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName(DRIVER_CLASS_NAME);
        hikariConfig.setJdbcUrl(DB_URL + SPLIT_SIGN + DB_NAME);
        hikariConfig.setUsername(DB_USERNAME);
        hikariConfig.setPassword(DB_PASSWORD);
        hikariConfig.addDataSourceProperty("useInformationSchema", "true"); // 设置可以获取 tables remarks 信息
        // 创建数据源
        return new HikariDataSource(hikariConfig);
    }

    /**
     * 创建 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();
    }

    /**
     * 创建 screw 的处理配置，一般可忽略
     * 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
                .designatedTableName(Collections.<String>emptyList())  // 根据名称指定表生成
                .designatedTablePrefix(Collections.<String>emptyList()) //根据表前缀生成
                .designatedTableSuffix(Collections.<String>emptyList()) // 根据表后缀生成
//                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
//                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前缀
//                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后缀
                .build();
    }
}