在 pom 中直接复制如下内容,idea 打开 maven 视图中的 plugins 视图,可以看到 screw 下有一个screw:run,双击运行,会在当前工程根目录生成 doc 目录,文档会自动写入该目录,对 pom 中指定变量修改即可。
<properties>
<jdbc.url>jdbc:mysql://192.168.0.1:3306/customer_dev</jdbc.url>
<username>root</username>
<password>root</password>
<doc.title>数据库</doc.title>
<doc.name>数据库文档</doc.name>
</properties>
<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.url}</jdbcUrl>
<username>${username}</username>
<password>${password}</password>
<!-- screw 配置 -->
<!-- 文件类型 : HTML、WORD、MD-->
<fileType>MD</fileType>
<!--标题-->
<title>${doc.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>