基于 screw maven 插件一键生成数据库文档

一、screw 是什么

screw 是一个简洁好用的数据库表结构文档的生成工具，支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库。

仓库地址是：https://github.com/pingfangushi/screw

screw 生成的文档有 HTML、Word、Markdown 三种格式，如下：

1. HTML：
   
2. Word：
   
3. Markdown：
   

二、screw 快速入门

本文的内容是基于 screw 的 maven 插件（screw-maven-plugin）来生成数据库文档，流程如下：

1. 在您的project中的pom文件中引入 screw 插件。
2. 在pom文件中进行一些必要的配置。
3. 运行 screw 插件
4. 文档生成

针对上边的操作步骤，通过下图进一步进行说明：

pom 文件中关于 screw 的相关配置信息，如下：

    <build>
        <plugins>
            <!-- screws 生成数据库文档  -->
            <plugin>
                <groupId>cn.smallbun.screw</groupId>
                <artifactId>screw-maven-plugin</artifactId>
                <version>1.0.5</version>
                <dependencies>
                    <!-- 数据库连接 -->
                    <dependency>
                        <groupId>com.zaxxer</groupId>
                        <artifactId>HikariCP</artifactId>
                        <version>3.4.5</version>
                    </dependency>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.22</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!-- 数据库相关配置 -->
                    <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                    <jdbcUrl>jdbc:mysql://rm-4zzwo723wt77015skzo.mysql.rds.aliyuncs.com/annoroad_staff_database</jdbcUrl>
                    <username>root</username>
                    <password>123456</password>
                    <!-- screw 配置 -->
                    <fileType>HTML</fileType>
                    <title>数据库文档</title> <!--标题-->
                    <fileName>测试文档名称</fileName> <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                    <description>数据库文档生成</description> <!--描述-->
                    <version>${project.version}</version> <!--版本-->
                    <openOutputDir>false</openOutputDir> <!--打开文件输出目录-->
                    <produceType>freemarker</produceType> <!--生成模板-->
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>