一键自动生成数据库文档，告别CV大法

前言

在日常开发中，当项目上线之后，甲方必定会让你提供一堆的验收文档，其中就包括了数据库字典，记得我之前是几十张表，一顿CV大法，一边写一遍骂，这种事情怎么交给我这个开发来做呢，各种吐槽，几个小时过后几十页的 Word文档就出炉了，页面那是花里胡哨，然而并没有什么用，甲方看都不看一眼。

最近小编也在找这样的插件，就是不想写文档了，浪费时间和心情啊，果然我找到一款比较好用，操作简单不复杂。

screw 是一个简洁好用的数据库表结构文档的生成工具 ，支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库。

这是github地址：github.com/pingfangush…

在这里插入图片描述

一、引入pom.xml依赖

  
  
      cn.smallbun.screw
      screw-core
      1.0.5
  

二、创建Java类

package com.skyi.ietm.modules.user.common;

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.Arrays;
import java.util.Collections;

/**
 * @ClassName TestScrewMain
 * @Description TODO 使用 screw 生成文档
 * @Author NingShi
 * @Date 2021/5/10 16:51
 * @Version 1.0
 */
public class TestScrewMain {
    private static final String DB_URL = "jdbc:mysql://localhost:3306";
    private static final String DB_NAME = "testdt?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai";
    private static final String DB_USERNAME = "root";
    private static final String DB_PASSWORD = "root";

    private static final String FILE_OUTPUT_DIR = "D:\\";
    // 可以设置 Word 或者 Markdown 格式
    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
    private static final String DOC_FILE_NAME = "数据库字典文档";
    private static final String DOC_VERSION = "V1.0.0";
    private static final String DOC_DESCRIPTION = "文档描述";

    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("com.mysql.jdbc.Driver");
        hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME);
        hikariConfig.setUsername(DB_USERNAME);
        hikariConfig.setPassword(DB_PASSWORD);
        // 设置可以获取 tables remarks 信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        // 创建数据源
        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.emptyList())
                // 根据表前缀生成
                .designatedTablePrefix(Collections.emptyList())
                // 根据表后缀生成
                .designatedTableSuffix(Collections.emptyList())
                // 忽略表名
                .ignoreTableName(Arrays.asList("test", "mytable","role","t_role","t_user"))
                // 忽略表前缀
                //.ignoreTablePrefix(Collections.singletonList("t_"))
                // 忽略表后缀
                //.ignoreTableSuffix(Collections.singletonList("_test"))
                .build();
    }
}

在这里插入图片描述

在这里插入图片描述

三、使用 Maven 插件的方式

 cn.smallbun.screw
 screw-maven-plugin
 1.0.5
 
     
     
         com.zaxxer
         HikariCP
         3.4.5
     
     
         mysql
         mysql-connector-java
         8.0.17
     
 
 
     
     com.mysql.cj.jdbc.Driver
     jdbc:mysql://192.168.31.158:3306/testdt?serverTimezone=Asia/Shanghai
     root
     123456
     
     WORD
      
     测试文档名称 
     数据库文档生成 
     ${project.version} 
     false 
     freemarker 
 
 
     
         compile
         
             run
         
     
 

执行 screw-maven-plugin 插件，会在 doc 目录下生成文档。如下图所示：

在这里插入图片描述

总结

screw 是一个简洁好用的数据库表结构文档的生成工具 ，支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库。使用起来还是很方便的，不用再去手动编写数据字典了，非常适用，从此告别CV手写数据库文档，真的是痛苦啊！他这个插件还可以生成Java实体类，不过除了Lombok其他的不支持，比如Swagger注释，基础实体字段表映射等。