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數據庫快速開發文檔的示例分析有進一步的了解嗎？如果還想了解更多知識或者相關內容，請關注億速云行業資訊頻道，感謝大家的支持。