介绍
平时很多时候,在交付时,需要交付数据库设计文档。评审时候也需要查看数据库设计文档。平时开发时,经常会修改数据库表,然后还要修改数据库设计文档,一旦忘了,就会变得很麻烦,挨个排查,耽误时间。所以这次介绍一款插件,直接生成数据库设计文档,并且支持MD,word,html等格式,而且还是开源,可以自己改造,里面是模板化的freemarker。
这就是第一期的《小鑫发现》之SCREW数据库文档生成
构建
这里使用MAVEN插件的方式进行生成。
新建一个Springboot的项目,为啥是Springboot的呢,没啥,就会这个,方便。
MAVEN 依赖
<properties>
<java.version>1.8</java.version>
<screw.version>1.0.5</screw.version>
<HikariCP.version>3.4.5</HikariCP.version>
<mysql-connector-java.version>8.0.22</mysql-connector-java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>${screw.version}</version>
</dependency>
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>${HikariCP.version}</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql-connector-java.version}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
<scope>provid