Screw数据库⽂档⽣成神器
引⼊依赖
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.3</version>
</dependency>
请⾃⾏配置好数据源
⽬前screw⽀持的数据库
MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB
H2 （开发中）
DB2 （开发中）
HSQL （开发中）
SQLite（开发中）
瀚⾼（开发中）
达梦（开发中）
虚⾕（开发中）
⼈⼤⾦仓（开发中）
在SpringBoot中编写测试类
package com.landimc.sbs;
import javax.sql.DataSource;
import cn.Configuration;
import cn.ngine.EngineConfig;
import cn.ngine.EngineFileType;
import cn.ngine.EngineTemplateType;
import cn.xecute.DocumentationExecute;
import cn.process.ProcessConfig;mysql需要安装documentation
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.st.context.SpringBootTest;
import t.ApplicationContext;
import javax.sql.DataSource;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@SpringBootTest
class SbsApplicationTests {
@Autowired
ApplicationContext applicationContext;
@Test
void contextLoads() {
DataSource dataSourceMysql = Bean(DataSource.class);
// ⽣成⽂件配置
EngineConfig engineConfig = EngineConfig.builder()
// ⽣成⽂件路径
.fileOutputDir("E:\\doc\\zqt")
// 打开⽬录
.openOutputDir(false)
// ⽂件类型(⽬前⽀持html、doc、MD格式，个⼈体验后还是html格式⽣成后看起来⽐较舒服，建议使⽤)
.
fileType(EngineFileType.HTML)
// ⽣成模板实现
.produceType(EngineTemplateType.freemarker).build();
// ⽣成⽂档配置（包含以下⾃定义版本号、描述等配置连接）
Configuration config = Configuration.builder().version("1.0.0").description("⽂档描述").dataSource(dataSourceMysql).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();
// 执⾏⽣成
new DocumentationExecute(config).execute();
}
/**
* 配置想要⽣成的表+ 配置想要忽略的表
*
* @return⽣成表配置
*/
public static ProcessConfig getProcessConfig() {
// 忽略表名，需要忽略的表将表名放到list中即可
//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<>()).build();
}
}

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。