Screw自动生成数据库文档-编程知识

Screw自动生成数据库文档

Screw简介

官方地址

Screw可以根据数据库中的表自动生成HTML、Word、Markdown格式的文档。

Springboot 3.1集成

生成Springboot项目

Spring Initializr

Maven依赖

<dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.5</version>
</dependency><!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
<dependency><groupId>org.freemarker</groupId><artifactId>freemarker</artifactId><version>2.3.32</version>
</dependency>

代码

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 javax.sql.DataSource;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;@SpringBootTest
public class DbDocTest {@AutowiredDataSource dataSource;@Testvoid generateDoc() {EngineConfig engineConfig = EngineConfig.builder()// 生成文件路径，自己mac本地的地址，这里需要自己更换下路径.fileOutputDir("./output")// 打开目录.openOutputDir(false)// 文件类型.fileType(EngineFileType.WORD)// 生成模板实现.produceType(EngineTemplateType.freemarker).build();// 生成文档配置（包含以下自定义版本号、描述等配置连接）Configuration config = Configuration.builder().version("1.0.0").description("生成文档信息描述").dataSource(dataSource).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();// 执行生成new DocumentationExecute(config).execute();}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();}
}