![cover](https://img-blog.csdnimg.cn/img_convert/ccd17dd1253c45048dfb37f99de7c280.png)
SpringBoot开发——整合screw 轻松生成数据库设计文档
SpringBoot整合screw 轻松生成数据库设计文档
·
整合screw生成数据库设计文档的步骤如下:
1、导入maven 依赖
<dependencies>
<!--SpringBoot相关依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--screw 数据库文档生成-->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency>
<!--mysql 驱动-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>8.0.33</version>
</dependency>
<!--连接池-->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.4.5</version>
</dependency>
</dependencies>
2、编写测试代码:
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.HikariDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@SpringBootTest
public class ScrewTest {
@Test
void generate() {
// 生成文件配置
EngineConfig engineConfig = EngineConfig.builder()
// 生成文件路径,自己mac本地的地址,这里需要自己更换下路径
.fileOutputDir("G:\\数据库字典")
// 打开目录
.openOutputDir(false)
// 文件类型 HTML/WORD/MD 三种格式
.fileType(EngineFileType.WORD)
// 生成模板实现
.produceType(EngineTemplateType.freemarker).build();
//数据库名称
String[] dbNames = {"admin"};
for (String dbName : dbNames) {
HikariDataSource hikariDataSource = new HikariDataSource();
//设置数据库连接
hikariDataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/"+dbName+"?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8&allowMultiQueries=true&allowPublicKeyRetrieval=true");
hikariDataSource.setUsername("root");
hikariDataSource.setPassword("root");
// 生成文档配置(包含以下自定义版本号、描述等配置连接)
Configuration config = Configuration.builder()
.version("1.0.1")
.description("数据库设计文档")
.dataSource(hikariDataSource)
.engineConfig(engineConfig)
.produceConfig(getProcessConfig())
.build();
// 执行生成
new DocumentationExecute(config).execute();
}
}
/**
* 配置想要生成的表+ 配置想要忽略的表
* @return 生成表配置
*/
public static ProcessConfig getProcessConfig(){
// 忽略表名
List<String> ignoreTableName = Arrays.asList("testa_testa","testb_testb");
// 忽略表前缀
List<String> ignorePrefix = Arrays.asList("testa","testb");
// 忽略表后缀
List<String> ignoreSuffix = Arrays.asList("_testa","_testb");
return ProcessConfig.builder()
//根据名称指定表生成 我需要生成所有表 这里暂时不设置
.designatedTableName(new ArrayList<>())
//根据表前缀生成 我需要生成所有表 这里暂时不设置
.designatedTablePrefix(new ArrayList<>())
//根据表后缀生成 我需要生成所有表 这里暂时不设置
.designatedTableSuffix(new ArrayList<>())
//忽略表名
.ignoreTableName(ignoreTableName)
//忽略表前缀
.ignoreTablePrefix(ignorePrefix)
//忽略表后缀
.ignoreTableSuffix(ignoreSuffix).build();
}
}
3、运行结果:
示例代码生成的WORD文档效果如下:
如果想要生成HTML文档,效果如下:
更多推荐
所有评论(0)