# 介绍
平时很多时候，在交付时，需要交付数据库设计文档。评审时候也需要查看数据库设计文档。平时开发时，经常会修改数据库表，然后还要修改数据库设计文档，一旦忘了，就会变得很麻烦，挨个排查，耽误时间。所以这次介绍一款插件，直接生成数据库设计文档，并且支持MD，word，html等格式，而且还是开源，可以自己改造，里面是模板化的freemarker。
这就是第一期的《小鑫发现》之SCREW数据库文档生成
# 构建
这里使用MAVEN插件的方式进行生成。
新建一个Springboot的项目，为啥是Springboot的呢，没啥，就会这个，方便。
## MAVEN 依赖
```
1.8
1.0.5
3.4.5
8.0.22
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-test
test
cn.smallbun.screw
screw-core
${screw.version}
com.zaxxer
HikariCP
${HikariCP.version}
mysql
mysql-connector-java
${mysql-connector-java.version}
org.projectlombok
lombok
1.18.16
provided
```
screw-core是插件的核心，HikariCP号称是最快的数据库连接池。
## MAVEN 插件
org.springframework.boot
spring-boot-maven-plugin
cn.smallbun.screw
screw-maven-plugin
${screw.version}
com.zaxxer
HikariCP
${HikariCP.version}
mysql
mysql-connector-java
${mysql-connector-java.version}
root
password
com.mysql.cj.jdbc.Driver
jdbc:mysql://127.0.0.1:3306/table_space?characterEncoding=UTF-8
MD
false
freemarker
测试文档名称
数据库文档生成
${project.version}
数据库文档
compile
run
把对应位置的信息改成自己的，`characterEncoding=UTF-8`这个是防止乱码，别忘了。
依赖和插件构建就完成了，没想到这么简单，我也没想到。
# 执行
这里直接在IDEA里，双击这个run。看看效果
执行日志
然后当前项目上就会有doc文件夹，查看里面的文档
这里使用的html，这里暂时就用官方的图片，更能看出来很多细节（主要是懒得在建立一个数据表了）
至此所有的文档就生成了，是不是方便，下一步就行改造，因为他还有很多配置项，通过代码更方便查看。
> 主要是我这修改maven总提示我构建，烦
# 改造
在test文件下，有个测试类，在里面进行改造。
方便配置化，使用一个配置类，和配置文件。
配置文件
```
gen:
db:
driverClassName: com.mysql.cj.jdbc.Driver
ip: jdbc:mysql://127.0.0.1:3306/test1?characterEncoding=UTF-8
username: root
password: mima
engineConfig:
fileOutputDir: /Users/iOLO/dev/Java/dbword/doc
fileName: 数据库设计文档
version: 1.0.0
description: 数据库描述```
配置类
```
package com.iolo.dbword.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
* @author iOLO
* @date 2020/12/23
**/
@Component
@ConfigurationProperties(prefix = "gen")
@Data
public class GenConfig {
private DB db;
private EngineConfig engineConfig;
@Data
public static class DB {
private String ip;
private String driverClassName;
private String username;
private String password;
}
@Data
public static class EngineConfig {
private String fileOutputDir;
private String fileName;
private String version;
private String description;
}
}```
测试类
```
package com.iolo.dbword;
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.iolo.dbword.config.GenConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import javax.sql.DataSource;
@SpringBootTest
class DbwordApplicationTests {
@Autowired
GenConfig genConfig;
@Test
void contextLoads() {
}
@Test
void documentGeneration() {
//数据源
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName(genConfig.getDb().getDriverClassName());
hikariConfig.setJdbcUrl(genConfig.getDb().getIp());
hikariConfig.setUsername(genConfig.getDb().getUsername());
hikariConfig.setPassword(genConfig.getDb().getPassword());
//设置可以获取备注信息信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
DataSource dataSource = new HikariDataSource(hikariConfig);
//生成配置
EngineConfig engineConfig = EngineConfig.builder()
//生成文件路径
.fileOutputDir(genConfig.getEngineConfig().getFileOutputDir())
//打开目录
.openOutputDir(true)
//文件类型 HTML WORD MD
.fileType(EngineFileType.HTML)
//生成模板实现
.produceType(EngineTemplateType.freemarker)
//自定义文件名称
.fileName(genConfig.getEngineConfig().getFileName()).build();
ProcessConfig processConfig = ProcessConfig.builder().build();
//配置
Configuration config = Configuration.builder()
//版本
.version(genConfig.getEngineConfig().getVersion())
//描述
.description(genConfig.getEngineConfig().getDescription())
//数据源
.dataSource(dataSource)
//生成配置
.engineConfig(engineConfig)
//生成配置
.produceConfig(processConfig)
.build();
//执行生成
new DocumentationExecute(config).execute();
}
}```
然后执行测试方法，依然也可以文档，并且发现会有更多的配置参数，如下
```
//忽略表
ArrayList ignoreTableName = new ArrayList<>();
ignoreTableName.add("test_user");
ignoreTableName.add("test_group");
//忽略表前缀
ArrayList ignorePrefix = new ArrayList<>();
ignorePrefix.add("test_");
//忽略表后缀
ArrayList ignoreSuffix = new ArrayList<>();
ignoreSuffix.add("_test");
ProcessConfig processConfig = ProcessConfig.builder()
//指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳忽略表配置
//根据名称指定表生成
.designatedTableName(new ArrayList<>())
//根据表前缀生成
.designatedTablePrefix(new ArrayList<>())
//根据表后缀生成
.designatedTableSuffix(new ArrayList<>())
//忽略表名
.ignoreTableName(ignoreTableName)
//忽略表前缀
.ignoreTablePrefix(ignorePrefix)
//忽略表后缀
.ignoreTableSuffix(ignoreSuffix)
.build(); ```
# 参考连接
https://gitee.com/leshalv/screw
Tags：freemarker循环list