设计文档自动化之screw数据库导出word

以下我们使用screw实现自动化数据库文档生成

1.打开pom.xml 加入以下配置

   <build>
       <plugins>
            <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://127.0.0.1:3306</jdbcUrl>
                    <username>root</username>
                    <password>123456</password>
                    <!-- screw 配置 -->
                    <!-- 文件类型 : HTML、WORD、MD-->
                    <fileType>WORD</fileType>
                    <!--标题-->
                    <title>数据库表设计</title>
                    <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                    <fileName>${doc.name}</fileName>
                    <!--描述-->
                    <description>数据库表结构说明文档</description>
                    <!--版本-->
                    <version>${maven.build.timestamp}</version>
                    <!--打开文件输出目录-->
                    <openOutputDir>false</openOutputDir>
                    <!--生成模板-->
                    <produceType>freemarker</produceType>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
       </plugins>
   </build>

2.刷新maven，等待加载完成
3.打开maven-》plugins->screw->screw:run执行插件脚本

4. 等待项目根目录生成/doc文件夹，文档将生成于此