idea使用Screw工具一键生成数据库文档详解

一、参考内容

项目源码地址：https://gitee.com/leshalv/screw

参考博客：一键生成数据库文档：Screw工具详解

二、如何使用

1、添加依赖

备注：除了添加 Screw 依赖，还要添加相关数据库驱动依赖，例如：mysql

		<!--Screw工具依赖驱动，我调试的是mysql，这边需要加相关依赖驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>
        
        <!--一键生成数据库文档：Screw工具-->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>

2、新增 DatabaseDesignDocUtil 类

package com.tutu.platform.common.utils;

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;

/**
 * 生成数据库文档工具类
 * @author zhengwd
 */
public class DatabaseDesignDocUtil {

    public static void main(String[] args) {
        // 执行方法
        documentGeneration();
    }

    /**
     * 文档生成
     */
    public static void documentGeneration() {
        // 数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        // 数据库连接地址
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/数据库名");
        // 数据库用户名
        hikariConfig.setUsername("root");
        // 数据库密码
        hikariConfig.setPassword("root");
        // 设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        // 生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("C:\\Users\\zhengwd\\Desktop\\test\\")
                // 打开目录
                .openOutputDir(true)
                // 文件类型
                .fileType(EngineFileType.WORD)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker)
                // 自定义文件名称
                .fileName("xxxxx数据库设计文档").build();

        // 忽略表
        List<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("me_message");
        ignoreTableName.add("sys_dict_data");
        ignoreTableName.add("sys_dict_type");

        // 忽略表前缀
        ArrayList<String> ignorePrefix = new ArrayList<>();
        ignorePrefix.add("ac_");
        ignorePrefix.add("block_");
        ignorePrefix.add("gen_");
        ignorePrefix.add("hk_");
        ignorePrefix.add("information_");
        ignorePrefix.add("place_");
        ignorePrefix.add("platform_");
        ignorePrefix.add("points_");
        ignorePrefix.add("property_");
//        ignorePrefix.add("sys_");

        // 忽略表后缀
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        ignoreSuffix.add("_copy1");

        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();
        // 执行生成
        new DocumentationExecute(config).execute();
    }
}

3、创建相关目录

4、执行main方法生成文件