背景

在我们日常开发过程中，常常遇到项目需要出一个数据库文档，面对数据表众多的场景一个一个写显然不现实，于是 screw工具很好的满足了我们的需求，从此告别人工整理文档; screw工具它可以将整个数据库的表输出为数据库表结构文档，因此后续无论是在做分析或是熟悉表结构都能提升很大效率。

工具介绍

screw是一个简洁好用的数据库表结构文档生成工具，它支持多种数据库并支持自定义模板输出文档，文档也是有多种文件类型选择。

screw目前支持 MySQL、Oracle、SqlServer、MariaDB、PostgreSQL 等数据库，生成文档目前支持html、word、markdown 文档格式。

比如使用了哪个数据库，每张表的字段，类型说明等，然后整理成一个设计文档，这个文档多种多样，最常见的就是word，有了数据库文档对以后的数据库维护，或者进行二次开发都很方便;

工具如何使用

screw提供两种实现方式，分别是代码实现和maven plugin实现。

下面主要介绍用代码实现的方式生成数据库文档：

使用步骤如下：

引入依赖

在pom.xml文件中引入如下依赖：

pom.xml

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

编写代码

新建测试类，编写如下代码生成文档，其次配置数据库相关连接信息；根据需要可以有选择性的配置相关属性：比如：生成文档的格式（下面配置的为HTML格式）、配置忽略哪些表等。

DbDoc.java

public class DbDoc {
    public static void main(String[] args) {
        createDbDoc("E:\\doc");
    }
    /**
     * 数据库文档生成
     *
     * @param fileOutputDir 生成文件保存路径
     */
    public static void createDbDoc(String fileOutputDir) {
        // 数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/xxkfz_ruoyi_plus_vue_5.x?characterEncoding=UTF8&useServerPrepStmts=true&cachePrepStmts=true&cacheCallableStmts=true&autoReconnect=true&useSSL=false&serverTimezone=Asia/Shanghai");
        hikariConfig.setUsername("xxkfz");
        hikariConfig.setPassword("xxkfz");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir(fileOutputDir)
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker).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()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig).build();
        //执行生成
        new DocumentationExecute(config).execute();
    }
}

测试

配置完成后，运行main函数即可生成数据库文档。

文档目录

示例