Springboot2.X + screw数据库快速开发文档的示例分析

今天就跟大家聊聊有关Springboot2.X + screw数据库快速开发文档的示例分析，可能很多人都不太了解，为了让大家更加了解，小编给大家总结了以下内容，希望大家根据这篇文章可以有所收获。

1、pom依赖

创建springboot项目，添加依赖

<!--        添加screw需要的依赖 开始-->        <dependency>            <groupId>org.freemarker</groupId>            <artifactId>freemarker</artifactId>            <version>2.3.30</version>        </dependency>        <dependency>            <groupId>cn.smallbun.screw</groupId>            <artifactId>screw-core</artifactId>            <version>1.0.3</version>        </dependency><!--        添加screw需要的依赖 结束-->

2、生成文档测试类

以下是老盟自己电脑的路径，手动切换你工作电脑的路径 

本次演示代码环境是在SpringBoot 环境下，这个不说了，一般idea一键创建SpringBoot  Maven工程Boot依赖自动带入

package com.atxiaodei.springcloud.util;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 org.junit.jupiter.api.Test;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import org.springframework.context.ApplicationContext;import javax.sql.DataSource;import java.util.ArrayList;import java.util.Arrays;import java.util.List;@SpringBootTestpublic class ScrewApplicationTests {@Autowired    ApplicationContext applicationContext;
    @Test    public void runTest(){//数据源        HikariConfig hikariConfig = new HikariConfig();        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        // z注意这里一定切换到自己的数据源        hikariConfig.setJdbcUrl("jdbc:mysql://XXXXXX:3306/hwswgp?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8");        hikariConfig.setUsername("XXXXXX");        hikariConfig.setPassword("XXXXXX");        //设置可以获取tables remarks信息        hikariConfig.addDataSourceProperty("useInformationSchema", "true");        hikariConfig.setMinimumIdle(2);        hikariConfig.setMaximumPoolSize(5);        DataSource dataSource = new HikariDataSource(hikariConfig);        //生成配置        EngineConfig engineConfig = EngineConfig.builder()//生成文件路径 注意这里也要切换到自己的数据源                .fileOutputDir("C://Users/issuser/Desktop")//打开目录                .openOutputDir(false)//文件类型  注意此处这里看你想要生成什么格式，共有三种格式，word，MD，html                .fileType(EngineFileType.WORD)//生成模板实现                .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()//指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置                //根据名称指定表生成                .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、启动

点击test启动，运行结果，支持导出html格式，word，MD格式 如下 

MD文件格式：

看完上述内容，你们对Springboot2.X + screw数据库快速开发文档的示例分析有进一步的了解吗？如果还想了解更多知识或者相关内容，请关注亿速云行业资讯频道，感谢大家的支持。