Springboot 想看数据库表结构定义？ 那我用代码给你生成个文档吧

前言

If I have seen further it is by standing on ye shoulder of Giants.

先看看效果，看起来蛮不错的： 

 

正文 

①pom.xml 引入依赖

        <!--screw-->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>
        <!-- HikariCP -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>
        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        
②DbDocCreateBuildUtil.java 工具类一个

代码简单介绍下，其实注释也有的 ：

public class DbDocCreateBuildUtil {


    public static void main(String[] args) {
        // 1.获取数据源
        DataSource dataSource = getDataSource();
       // 2.获取数据库文档生成配置（文件路径、文件类型）
        EngineConfig engineConfig = getEngineConfig();
       // 3.获取数据库表的处理配置，可忽略
        ProcessConfig processConfig = getProcessConfigIgnore();
       // 4.Screw 完整配置
        Configuration config = getScrewConfig(dataSource, engineConfig, processConfig);
       // 5.执行生成数据库文档
        new DocumentationExecute(config).execute();
    }

    /**
     * 获取数据库源
     * 对数据库以及数据库连接池进行相关配置。务必将数据库相关的配置修改成你自己的。
     */
    private static DataSource getDataSource() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://xxxxxxxxxxxx?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8&zeroDateTimeBehavior=convertToNull");
        hikariConfig.setUsername("xxxxxxx");
        hikariConfig.setPassword("xxxxxxx");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        return new HikariDataSource(hikariConfig);
    }

    /**
     * 获取文件生成配置
     * 这一步会指定数据库文档生成的位置、文件类型以及文件名称。
     * 如果不配置生成文件路径的话，默认也会存放在项目的 doc 目录下。
     * <p>
     * 另外，我们这里指定生成的文件格式为 HTML。除了 HTML 之外，screw 还支持 Word 、Markdown 这两种文件格式。
     * <p>
     * 不太建议生成 Word 格式,比较推荐 Markdown 格式。
     */
    private static EngineConfig getEngineConfig() {
        //生成配置
        return EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("D:\\mydbdoc")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("我的db结构文档").build();
    }

    /**
     * 单独设置需要在文档里的表
     * @return
     */
    private static ProcessConfig getProcessConfigAssign() {
        //可以设置多个
        List<String>  tbs=new ArrayList<>();
        tbs.add("student");

        return ProcessConfig.builder().designatedTableName(tbs).build();
    }

    /**
     * 设置忽略哪些表不参与生成db文档
     * @return
     */
    private static ProcessConfig getProcessConfigIgnore() {
        ArrayList<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("do_test");
        ignoreTableName.add("student");
        ignoreTableName.add("t_null_font");
        ArrayList<String> ignorePrefix = new ArrayList<>();
        // ignorePrefix.add("test_");
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        //  ignoreSuffix.add("_test");
        return ProcessConfig.builder()
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix)
                .build();
    }

    private static Configuration getScrewConfig(DataSource dataSource, EngineConfig engineConfig, ProcessConfig processConfig) {
        return Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
    }

}

好了，就这样就行。

简单看看代码怎么用：

 简析图一

简析图二

简析图三

运行一下main方法就可以生成：
 

    public static void main(String[] args) {
        // 1.获取数据源
        DataSource dataSource = getDataSource();
       // 2.获取数据库文档生成配置（文件路径、文件类型）
        EngineConfig engineConfig = getEngineConfig();
       // 3.获取数据库表的处理配置，可忽略
        ProcessConfig processConfig = getProcessConfigIgnore();
       // 4.Screw 完整配置
        Configuration config = getScrewConfig(dataSource, engineConfig, processConfig);
       // 5.执行生成数据库文档
        new DocumentationExecute(config).execute();
    }

好了，该篇就到这。