screw一键生成数据库文档

本文主要讲GitHub里的screw（螺丝钉）生成数据库文档。

简介

在企业级开发中，我们经常会有编写数据库表结构文档的时间付出，一直以来，各公司关于数据库表结构文档的状态：要么没有、要么有，但都是手写，后期运维开发，需要手动进行维护到文档中，很是繁琐，如果忘记一次维护，就会给以后的工作造成很多困扰，无形中制造了很多坑留给自己和后人，于是就出现了screw。

特点

简洁、轻量、设计良好多数据库支持多种格式文档灵活扩展支持自定义模板

数据库支持

MySQLMariaDBTIDBOracleSqlServerPostgreSQLCache DB（2016）H2 （开发中）DB2 （开发中）HSQL （开发中）SQLite（开发中）瀚高（开发中）达梦 （开发中）虚谷 （开发中）人大金仓（开发中）

文档生成支持

htmlwordmarkdwon

文档截图

使用

screw有两种使用方式，一种是配置方式，一种是代码方式。

1、新建SpringBoot Web项目

首先，我们新建一个SpringBoot Web项目，同时加入oracle和mysql的依赖：

2、配置依赖

引入screw核心包，HikariCP数据库连接池，HikariCP号称性能最出色的数据库连接池。

<!-- screw --> <dependency> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-core</artifactId> <version>1.0.3</version> </dependency> <!-- HikariCP --> <dependency> <groupId>com.zaxxer</groupId> <artifactId>HikariCP</artifactId> <version>3.4.5</version> </dependency> <!--oracle--> <dependency> <groupId>com.oracle.database.jdbc</groupId> <artifactId>ojdbc8</artifactId> <scope>runtime</scope> </dependency> <!--mysql--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency>

3、配置数据源

配置数据源，设置 useInformationSchema 可以获取tables注释信息。

#oracle #spring.datasource.url=jdbc:oracle:thin:@ip:1521:ora11 #spring.datasource.username=root #spring.datasource.password=123456 #spring.datasource.driver-class-name=oracle.jdbc.OracleDriver #spring.datasource.xa.properties.useInformationSchema=true #mysql spring.datasource.url=jdbc:mysql://ip:3306/gp-mybatis?characterEncoding=UTF-8 spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver spring.datasource.xa.properties.useInformationSchema=true

4、使用方式

4.1 配置方式

pom文件中加入screw插件：

<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> <!--oracle driver--> <dependency> <groupId>com.oracle.database.jdbc</groupId> <artifactId>ojdbc8</artifactId> <version>19.3.0.0</version> <scope>runtime</scope> </dependency> </dependencies> <configuration> <!--username--> <username>root</username> <!--password--> <password>123456</password> <!--driver--> <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName> <!--<driverClassName>oracle.jdbc.OracleDriver</driverClassName>--> <!--jdbc url--> <jdbcUrl>jdbc:mysql://ip:3306/gp-mybatis?characterEncoding=UTF-8</jdbcUrl> <!--<jdbcUrl>jdbc:oracle:thin:@ip:ora11</jdbcUrl>--> <!--生成文件类型HTML、WORD、MD 三种格式的文档--> <fileType>MD</fileType> <!--打开文件输出目录--> <openOutputDir>true</openOutputDir> <!--生成模板--> <produceType>freemarker</produceType> <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称--> <!--<fileName>测试文档名称</fileName>--> <!--描述--> <description>数据库文档生成</description> <!--版本--> <version>${project.version}</version> <!--标题--> <title>数据库文档</title> </configuration> <executions> <execution> <phase>compile</phase> <goals> <goal>run</goal> </goals> </execution> </executions> </plugin>

配置完成后，双击maven projects中的screw插件运行：

4.2 代码方式

直接运行以下代码即可。

package com.cs; import cn.smallbun.screw.core.Configuration; import cn.smallbun.screw.core.engine.EngineConfig; import cn.smallbun.screw.core.engine.EngineFileType; import cn.smallbun.screw.core.engine.EngineTemplateType; import cn.smallbun.screw.core.execute.DocumentationExecute; import cn.smallbun.screw.core.process.ProcessConfig; import com.zaxxer.hikari.HikariConfig; import com.zaxxer.hikari.HikariDataSource; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.context.ApplicationContext; import javax.sql.DataSource; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @SpringBootTest class DatabasedemoApplicationTests { @Autowired ApplicationContext applicationContext; @Test void contextLoads() { documentGeneration(); } /** * 文档生成 */ void documentGeneration() { //获取数据源，二选一 // DataSource dataSource = getDataSource1(); DataSource dataSource = getDataSource2(); //生成配置 EngineConfig engineConfig = EngineConfig.builder() //生成文件路径 .fileOutputDir("E:\\idea\\databasedemo\\doc") //打开目录 .openOutputDir(true) // 文件类型(目前支持html、WORD、MD格式，个人体验后还是html格式生成后看起来比较舒服，建议使用) .fileType(EngineFileType.WORD) // .fileType(EngineFileType.HTML) // .fileType(EngineFileType.MD) //生成模板实现 .produceType(EngineTemplateType.freemarker).build(); //忽略表 List<String> ignoreTableName = Arrays.asList("test_user","test_group"); //忽略表前缀 List<String> ignorePrefix = Arrays.asList("tab_","tbl_"); //忽略表后缀 List<String> ignoreSuffix = Arrays.asList("_test","_user"); ProcessConfig processConfig = ProcessConfig.builder() //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置 //根据名称指定表生成 .designatedTableName(new ArrayList<>()) //根据表前缀生成 .designatedTablePrefix(new ArrayList<>()) //根据表后缀生成 .designatedTableSuffix(new ArrayList<>()) //忽略表名 .ignoreTableName(ignoreTableName) //忽略表前缀 .ignoreTablePrefix(ignorePrefix) //忽略表后缀 .ignoreTableSuffix(ignoreSuffix).build(); //配置 Configuration config = Configuration.builder() //版本 .version("1.0.0") //描述 .description("数据库设计文档") //数据源 .dataSource(dataSource) //生成配置 .engineConfig(engineConfig) //生成配置 .produceConfig(processConfig) .build(); //执行生成 new DocumentationExecute(config).execute(); } /** * 获取数据源方法1 * 获取application.properties配置 * @return */ private DataSource getDataSource1() { DataSource dataSource = applicationContext.getBean(DataSource.class); return dataSource; } /** * 获取数据源方法2 * @return */ private DataSource getDataSource2() { //数据源 HikariConfig hikariConfig = new HikariConfig(); hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); hikariConfig.setJdbcUrl("jdbc:mysql://ip:3306/gp-mybatis?characterEncoding=UTF-8"); hikariConfig.setUsername("root"); hikariConfig.setPassword("123456"); //设置可以获取tables remarks信息 hikariConfig.addDataSourceProperty("useInformationSchema", "true"); hikariConfig.setMinimumIdle(2); hikariConfig.setMaximumPoolSize(5); DataSource dataSource = new HikariDataSource(hikariConfig); return dataSource; } }

附：完整pom文件

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.3.3.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.cs</groupId> <artifactId>databasedemo</artifactId> <version>0.0.1-SNAPSHOT</version> <name>databasedemo</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- screw --> <dependency> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-core</artifactId> <!--这里选择最新版本--> <version>1.0.3</version> </dependency> <!-- HikariCP --> <dependency> <groupId>com.zaxxer</groupId> <artifactId>HikariCP</artifactId> <version>3.4.5</version> </dependency> <!--oracle--> <dependency> <groupId>com.oracle.database.jdbc</groupId> <artifactId>ojdbc8</artifactId> <scope>runtime</scope> </dependency> <!--mysql--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> <exclusions> <exclusion> <groupId>org.junit.vintage</groupId> <artifactId>junit-vintage-engine</artifactId> </exclusion> </exclusions> </dependency> </dependencies> <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> <!--oracle driver--> <dependency> <groupId>com.oracle.database.jdbc</groupId> <artifactId>ojdbc8</artifactId> <version>19.3.0.0</version> <scope>runtime</scope> </dependency> </dependencies> <configuration> <!--username--> <username>root</username> <!--password--> <password>123456</password> <!--driver--> <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName> <!--<driverClassName>oracle.jdbc.OracleDriver</driverClassName>--> <!--jdbc url--> <jdbcUrl>jdbc:mysql://ip:3306/gp-mybatis?characterEncoding=UTF-8</jdbcUrl> <!--<jdbcUrl>jdbc:oracle:thin:@ip:ora11</jdbcUrl>--> <!--生成文件类型HTML、WORD、MD 三种格式的文档--> <fileType>MD</fileType> <!--打开文件输出目录--> <openOutputDir>true</openOutputDir> <!--生成模板--> <produceType>freemarker</produceType> <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称--> <!--<fileName>测试文档名称</fileName>--> <!--描述--> <description>数据库文档生成</description> <!--版本--> <version>${project.version}</version> <!--标题--> <title>数据库文档</title> </configuration> <executions> <execution> <phase>compile</phase> <goals> <goal>run</goal> </goals> </execution> </executions> </plugin> </plugins> </build> </project>

完整代码地址：https://gitee.com/cs33/springbootxuexidaima/tree/master/databasedemo