【JAVA】通过代码生成mysql数据库设计文档

最近接近年关同事离职了，接手了他手上的项目，当时时间紧张，之前的同事就没有写数据库设计文档，结果到现在项目要交付了才知道当时没有写设计文档，老板要求必须在项目交付前把数据库设计文档完善出来。

好嘛，这真的是让我开了眼了，几百张表不知道要写到啥时候去，也不知道这同事当时是怎么想的，真是处处留坑。

抓耳挠腮了好一阵，本来想直接用navicat导出，试了一下之后达不到效果，只能继续找方法，终于找了一个简单的方法

吐槽完毕言归正传，直接上代码

一、导入maven

1、先导入咱们需要的maven，主要使用的就是数据库文档生成工具screw来进行实现。

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

2、如果只是一个架构里面什么都没有的话，还需要加入连接池管理的maven，但是一般情况下应该都是直接在项目中添加，所以项目中有的话就不需要在pom里面加入这个连接池管理了。

        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>5.0.1</version>
        </dependency>

二、代码实现

随便在一个目录下新建个类，util也行，serviceImpl也行，看个人业务逻辑吧。

    static void documentGeneration(String fileOutputDir) {
        //数据源 XXXX填写自己项目的url，账号，密码
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://XXX.XXX.XXX.XXX:3306/XXXX");
        hikariConfig.setUsername("XXXX");
        hikariConfig.setPassword("XXXX");

        //设置可以获取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.WORD)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("数据库文档").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()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .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();
    }

OK，到此代码方面就搞定了，写个main方法调用一下吧

 public static void main(String[] args) {

        //生成word文档后保存的地址，我偷个懒就直接放D盘下了
        String fileOutputDir = "D:/";

        documentGeneration(fileOutputDir);
    }

至此，文档已经生成成功了，然后打开文档看一下，嗯，还是比较满意的，所有表的结构都在里面，用作数据库设计文档的话也是够用了，接下来自己调整调整word文档的样式就大功告成

 

总结：其实方法也很简单，主要使用的是 数据库文档生成工具screw来搞定，连接池说白了只是告诉工具，我要导出的是哪个数据库，只要确保连接池写的url，数据库账号密码正确，就没有什么坑了。

还有就是同事真坑，感觉自己和大冤种一样，就很气