前言：我们有时候在编写文档的时候会涉及到数据库表结构，如何建完表之后将表的文档一键生成呢？
一、pom引入screw
<!-- screw核心 -->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency><plugin>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-maven-plugin</artifactId>
<version>1.0.5</version>
<dependencies>
<!-- HikariCP -->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.4.5</version>
</dependency>
<!--mysql driver-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
</dependencies>
<configuration>
<!--username-->
<username>root</username>
<!--password-->
<password>123456</password>
<!--driver-->
<driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
<!--jdbc url-->
<jdbcUrl>jdbc:mysql://127.0.0.1:3306/test</jdbcUrl>
<!--生成文件类型-->
<fileType>HTML</fileType>
<!--打开文件输出目录-->
<openOutputDir>false</openOutputDir>
<!--生成模板-->
<produceType>freemarker</produceType>
<!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
<!--<docName>测试文档名称</docName>-->
<!--描述-->
<description>数据库文档生成</description>
<!--版本-->
<version>${project.version}</version>
<!--标题-->
<title>fire数据库文档</title>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>二、java代码
这边是以springboot项目为列子：如果说引入不了HikariConfig? 这个包，打开项目结构，如图所示：
?
?选择自己数据库版本下载添加到库即可。
?
public static void main(String[] args) {
//数据源：HikariCP 线程池, SpringBoot 2.0开始内置了HikariCP，2.0之前的版本需要引入依赖
HikariConfig hikariConfig = new HikariConfig();
// com.mysql.jdbc.Driver MySQL5驱动；com.mysql.cj.jdbc.Driver MySQL6之后的驱动
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306?useUnicode=true&characterEncoding=UTF-8&useSSL=false");
hikariConfig.setUsername("root");
hikariConfig.setPassword("123456");
//设置可以获取tables remarks信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
DataSource dataSource = new HikariDataSource(hikariConfig);
// 1、生成文件配置
EngineConfig engineConfig = EngineConfig.builder()
//生成文件路径(改成自己的生成路径)
.fileOutputDir("D:\\docs")
//生成后是否立即打开目录
.openOutputDir(true)
//文件类型 有HTML、WORD、MD三种枚举选择
.fileType(EngineFileType.WORD)
//生成模板实现
.produceType(EngineTemplateType.freemarker).build();
// 忽略表名（可选）
List<String> ignoreTableName = Arrays.asList("aa", "test_group");
// 忽略表前缀（可选）
List<String> ignorePrefix = Collections.singletonList("czb_");
// 忽略表后缀（可选）
List<String> ignoreSuffix = Arrays.asList("_test", "_test1");
// 2、配置想要忽略的表（可选）
ProcessConfig processConfig = ProcessConfig.builder()
.ignoreTableName(ignoreTableName)
.ignoreTablePrefix(ignorePrefix)
.ignoreTableSuffix(ignoreSuffix)
.build();
// 3、生成文档配置（包含以下自定义版本号、标题、描述（数据库名 + 描述 = 文件名）等配置连接）
Configuration config = Configuration.builder()
.version("1.0.0")
.title("数据库文档")
.description("数据库设计文档生成")
.dataSource(dataSource)
.engineConfig(engineConfig)
.produceConfig(processConfig).build();
// 4、执行生成
new DocumentationExecute(config).execute();
}需要注意的是：数据库驱动有版本变化。
com.mysql.jdbc.Driver?是 mysql-connector-java 5及5之前的，?
com.mysql.cj.jdbc.Driver?是 mysql-connector-java 6及6之后的的，
?以上就是简单的文档生成模板。
