springboot~Screw生成数据库文档

数据库说明文档，在我们开发项目时是非常必要的，有时项目交付时，客户也是需要让我们提供的，而如果人工编写，比如耗时，通过screw组件来生成文档，非常方便。

源代码和使用:https://github.com/pig-mesh/screw

添加依赖

1.      <dependency>
2.             <groupId>cn.smallbun.screw</groupId>
3.             <artifactId>screw-core</artifactId>
4.             <version>1.0.3</version>
5.      </dependency>

复制代码

编写生成数据库代码

1. @Test
2. public void documentGeneration() {
3.                 // 数据源
4.                 HikariConfig hikariConfig = new HikariConfig();
5.                 hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
6.                 hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/pig");
7.                 hikariConfig.setUsername("root");
8.                 hikariConfig.setPassword("123456");
9.                 // 设置可以获取tables remarks信息
10.                 hikariConfig.addDataSourceProperty("useInformationSchema", "true");
11.                 hikariConfig.setMinimumIdle(2);
12.                 hikariConfig.setMaximumPoolSize(5);
13.                 DataSource dataSource = new HikariDataSource(hikariConfig);
14.                 // 生成配置
15.                 EngineConfig engineConfig = EngineConfig.builder()
16.                                 // 生成文件路径
17.                                 .fileOutputDir("d:\\数据库说明文档screw")
18.                                 // 打开目录
19.                                 .openOutputDir(true)
20.                                 // 文件类型
21.                                 .fileType(EngineFileType.HTML)
22.                                 // 生成模板实现
23.                                 .produceType(EngineTemplateType.freemarker).build();
25.                 // 忽略表
26.                 ArrayList<String> ignoreTableName = new ArrayList<>();
27.                 ignoreTableName.add("test_user");
28.                 ignoreTableName.add("test_group");
29.                 // 忽略表前缀
30.                 ArrayList<String> ignorePrefix = new ArrayList<>();
31.                 ignorePrefix.add("test_");
32.                 // 忽略表后缀
33.                 ArrayList<String> ignoreSuffix = new ArrayList<>();
34.                 ignoreSuffix.add("_test");
35.                 ProcessConfig processConfig = ProcessConfig.builder()
36.                                 // 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
37.                                 // 根据名称指定表生成
38.                                 .designatedTableName(new ArrayList<>())
39.                                 // 根据表前缀生成
40.                                 .designatedTablePrefix(new ArrayList<>())
41.                                 // 根据表后缀生成
42.                                 .designatedTableSuffix(new ArrayList<>())
43.                                 // 忽略表名
44.                                 .ignoreTableName(ignoreTableName)
45.                                 // 忽略表前缀
46.                                 .ignoreTablePrefix(ignorePrefix)
47.                                 // 忽略表后缀
48.                                 .ignoreTableSuffix(ignoreSuffix).build();
49.                 // 配置
50.                 Configuration config = Configuration.builder()
51.                                 // 版本
52.                                 .version("1.0.0")
53.                                 // 描述
54.                                 .description("数据库设计文档生成")
55.                                 // 数据源
56.                                 .dataSource(dataSource)
57.                                 // 生成配置
58.                                 .engineConfig(engineConfig)
59.                                 // 生成配置
60.                                 .produceConfig(processConfig).build();
61.                 // 执行生成
62.                 new DocumentationExecute(config).execute();
63.         }

复制代码

文档效果



免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！