在实际项目开发中，文档已经成为一种必不可少的留存方式，但同时让程序猿去写文档又是一键很不情愿的事情；

screw（螺丝钉），解放了咱们双手，能让我们把宝贵的时间放在重点的实际开发中，通过pom文件配置，或者程序代码，一键生成数据库文档；

1. 支持的数据库：MySQL、MariaDB、TIDB、Oracle、SqlServer、PostgreSQL、Cache DB。
2. pom文件实现方式：

2.1

<!-- screw核心 -->

<dependency>

<groupId>cn.smallbun.screw</groupId>

<artifactId>screw-core</artifactId>

<version>1.0.3</version>

</dependency>

<build>

<plugins>

<plugin>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-maven-plugin</artifactId>

</plugin>

<plugin>

<groupId>cn.smallbun.screw</groupId>

<artifactId>screw-maven-plugin</artifactId>

<version>1.0.3</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://41.92.6.5:3306/fire</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>

</plugins>

</build>

2.2 配置完成后，可maven project->screw 双击执行ok，如下图所示：

3. 代码运行方式：

@SpringBootTest

public class ScrewApplicationTest {

public static void main(String[] args) {

// 数据源

HikariConfig hikariConfig = new HikariConfig();

hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");

hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/");

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:\\")

// 打开目录

.openOutputDir(false)

// 文件类型

.fileType(EngineFileType.WORD)

// 生成模板实现

.produceType(EngineTemplateType.freemarker).build();

// 忽略表名

List<String> ignoreTableName = Arrays.asList("test");

// 忽略表前缀

List<String> ignorePrefix = Arrays.asList("test_", "test");

// 忽略表后缀

List<String> ignoreSuffix = Arrays.asList("_test", "test");

// 2、配置想要忽略的表

ProcessConfig processConfig = ProcessConfig.builder().ignoreTableName(ignoreTableName)

.ignoreTablePrefix(ignorePrefix).ignoreTableSuffix(ignoreSuffix).build();

// 3、生成文档配置（包含以下自定义版本号、描述等配置连接）

Configuration config = Configuration.builder().version("1.0.0").description("销售提成平台数据库文档").dataSource(dataSource)

.engineConfig(engineConfig).produceConfig(processConfig).build();

// 4、执行生成

new DocumentationExecute(config).execute();

}

}

4、文档格式

screw 有 HTML、DOC、MD 三种格式的文档。