Springboot2.X + screw數據庫快速開發文檔（74）

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>

2、測試類

下面填寫自己的mysql賬號密碼

spring.datasource.url=
spring.datasource.username=
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true

3、生成文檔測試類

/Users/mac/Desktop 這個是自己電腦的路徑，我的是mac，windows需要更換路徑

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 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;

@SpringBootTest
class ScrewApplicationTests {

   @Autowired
   ApplicationContext applicationContext;

   @Test
   void contextLoads() {
      DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);

      // 生成文件配置
      EngineConfig engineConfig = EngineConfig.builder()
            // 生成文件路徑，自己mac本地的地址，這裏需要自己更換下路徑
            .fileOutputDir("/Users/mac/Desktop")
            // 打開目錄
            .openOutputDir(false)
            // 文件類型
            .fileType(EngineFileType.HTML)
            // 生成模板實現
            .produceType(EngineTemplateType.freemarker).build();

      // 生成文檔配置（包含以下自定義版本號、描述等配置連接）
      Configuration config = Configuration.builder()
            .version("1.0.3")
            .description("生成文檔信息描述")
            .dataSource(dataSourceMysql)
            .engineConfig(engineConfig)
            .produceConfig(getProcessConfig())
            .build();

      // 執行生成
      new DocumentationExecute(config).execute();
   }


   /**
    * 配置想要生成的表+ 配置想要忽略的表
    * @return 生成表配置
    */
   public static ProcessConfig getProcessConfig(){
      // 忽略表名
      List<String> ignoreTableName = Arrays.asList("aa","test_group");
      // 忽略表前綴，如忽略a開頭的數據庫表
      List<String> ignorePrefix = Arrays.asList("a","t");
      // 忽略表後綴
      List<String> ignoreSuffix = Arrays.asList("_test","czb_");

      return ProcessConfig.builder()
            //根據名稱指定表生成
            .designatedTableName(new ArrayList<>())
            //根據表前綴生成
            .designatedTablePrefix(new ArrayList<>())
            //根據表後綴生成
            .designatedTableSuffix(new ArrayList<>())
            //忽略表名
            .ignoreTableName(ignoreTableName)
            //忽略表前綴
            .ignoreTablePrefix(ignorePrefix)
            //忽略表後綴
            .ignoreTableSuffix(ignoreSuffix).build();
   }
}

4、啓動

點擊test啓動，運行結果，如下

很方便的結合公司的業務需求來使用。

5、鏈接

文檔工具screw：https://gitee.com/leshalv/screw