SpringBoot + screw 一键生成数据库文档，告别CV大法，解放生产力

阿超努力学习

已于 2022-04-12 10:19:18 修改

阅读量2.2k

点赞数 1

分类专栏：个人成长学习笔记文章标签： mysql spring boot

于 2022-04-12 10:15:42 首次发布

本文链接：https://blog.csdn.net/qq_46567504/article/details/124117116

版权

个人成长学习笔记专栏收录该内容

23 篇文章 0 订阅

订阅专栏

1.screw简介（ screw (螺丝钉) 英:[skruː] ）

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

以往我们手写过数据库表结构文档，一通无脑的CV 大法之后，几十页至上百页的Word 文档就出炉了。screw是一款可以帮我们偷懒高效的自动生成数据库表结构文档，解放生产力神器。

screw也适合新入职的新同事熟悉系统数据库表结构、字段设计，理解业务。

即简而言之screw是一个简洁好用的数据库表结构文档生成器。

Github地址：https://github.com/pingfangushi/screw

2.生成的文档格式

生成的文档有 html、word、markdown三种格式，示例如下图所示：

a、html
在这里插入图片描述
b、word

c、markdwon

在这里插入图片描述
3.支持的数据库

最新版本1.0.5已支持H2、达梦数据库。

4.生成文档的方式

（1）使用 Java 代码（以下代码演示了MySQL、Oracle、SqlServer三种数据源）

相关依赖maven仓库最新版本：https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core/1.0.5

第一步：引入screw相关maven依赖

<!-- 引入数据库表结构文档生成器Screw依赖-->
         <dependency>
             <groupId>cn.smallbun.screw</groupId>
             <artifactId>screw-core</artifactId>
             <version>1.0.5</version>
         </dependency>
         <!-- Hikari数据库连接池 也可采用阿里巴巴的Druid、C3p0等数据库连接池 -->
         <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.ojdbc</groupId>
             <artifactId>ojdbc8</artifactId>
             <version>19.3.0.0</version>
         </dependency>
         <dependency>
             <groupId>cn.easyproject</groupId>
             <artifactId>orai18n</artifactId>
             <version>12.1.0.2.0</version>
         </dependency>

第二步：编写代码

package com.example.screw;
 
 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 javax.sql.DataSource;
 import java.util.ArrayList;
 import java.util.Arrays;
 
 public class DocGeneration {
 
     // 以下static final修饰的参数 如果是基于SpringBoot项目，可以在配置文件中配置，通过@Value注解获取
     // MySQL驱动 6.0以前的使用com.mysql.jdbc.Driver，6.0以后的使用com.mysql.cj.jdbc.Driver  我这边使用的是8.0.20版本的
     private static final String Driver_Class_Name = "com.mysql.cj.jdbc.Driver";
     // 数据库种类 MySQL  Oracle  SQLServer
     private static final String DB_TYPE = "MySQL";
 //    private static final String Driver_Class_Name = "oracle.jdbc.driver.OracleDriver";// Oracle驱动
 //    private static final String Driver_Class_Name = "com.microsoft.sqlserver.jdbc.SQLServerDriver";// SQLServer驱动
 
     // 数据库URL
     /** 不同数据库格式示例
      * MySQL  jdbc:mysql://127.0.0.1:3306/mydb?useUnicode=true&characterEncoding=utf-8  jdbc:mysql://IP:端口/数据库名称
      * Oracle jdbc:oracle:thin:@127.0.0.1:1521:orcl       jdbc.url=jdbc:oracle:thin:@IP:端口:实例名（sid）
      * SqlServer jdbc:sqlserver://127.0.0.1:1433;instanceName=sqlserver2005;DatabaseName=easysite_2005
      * jdbc:sqlserver://IP:端口;instanceName=sqlserver2005（版本）;DatabaseName=easysite_2005（数据库名称）
      */
     private static final String DB_URL = "jdbc:mysql://127.0.0.1:3306";// MySQL
 //    private static final String DB_URL = "jdbc:oracle:thin:@127.0.0.1:1521";// Oracle
 //    private static final String DB_URL = "jdbc:sqlserver://127.0.0.1:1433";// SQLServer
     private static final String IGNORE_MISTAKEN_CODE  = "?characterEncoding=UTF-8";//  防止生成后文档乱码
 
     //  MySQL数据库名、Oracle实例名、SQLServer版本名和数据库名
     private static final String DB_NAME = "seckill";// MySQL
 //    private static final String DB_NAME = "orcl";// Oracle
 //    private static final String DB_NAME = ";instanceName=sqlserver2005;DatabaseName=easysite_2005";// SQLServer
     private static final String DB_USERNAME = "root";
     private static final String DB_PASSWORD = "root";
     
     // 生成数据库文档文件路径 可根据本机电脑自行配置
     private static final String FILE_OUTPUT_DIR = "/Users/mac/screw_test";
 
     private static final String DOC_FILE_NAME = "某某系统数据库文档";// 自定义文件名称 即数据库文档名称
     private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD; // 文件类型 HTML->HTML文件  WORD->WORD文件  MD->Markdown文件
     private static final String DOC_VERSION = "1.0.0";
     private static final String DOC_DESCRIPTION = "数据库设计文档生成";
 
     public static void main(String[] args) {
         documentGeneration();
     }
 
     /**
      * 数据库文档生成
      */
     public static void documentGeneration() {
 
         // 数据源  创建HikariConfig配置类
         HikariConfig hikariConfig = new HikariConfig();
         hikariConfig.setDriverClassName(Driver_Class_Name);
         if("MySQL".equals(DB_TYPE)){
             hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME+IGNORE_MISTAKEN_CODE);
         }else if("Oracle".equals(DB_TYPE)){
             hikariConfig.setJdbcUrl(DB_URL + ":" + DB_NAME);
         }else if("SQLServer".equals(DB_TYPE)){
             hikariConfig.setJdbcUrl(DB_URL + DB_NAME);
         }
         hikariConfig.setUsername(DB_USERNAME);
         hikariConfig.setPassword(DB_PASSWORD);
         // 设置useInformationSchema 可以获取tables表注释信息 即解决数据库表和列字段有说明、生成文档没有说明
         hikariConfig.addDataSourceProperty("useInformationSchema", "true");
         hikariConfig.setMinimumIdle(2);
         hikariConfig.setMaximumPoolSize(5);
         DataSource dataSource = new HikariDataSource(hikariConfig);
         //  创建screw的引擎配置
         EngineConfig engineConfig = EngineConfig.builder()
                 // 生成文件路径
                 .fileOutputDir(FILE_OUTPUT_DIR)
                 // 打开目录
                 .openOutputDir(true)
                 // 文件类型 HTML->HTML文件  WORD->WORD文件  MD->Markdown文件
                 .fileType(FILE_OUTPUT_TYPE)
                 // 生成模板实现
                 .produceType(EngineTemplateType.freemarker)
                 // 自定义文件名称，即数据库文档名称
                 .fileName(DOC_FILE_NAME).build();
         // 创建screw的处理配置，一般可忽略
         // 忽略表
         ArrayList<String> ignoreTableName = new ArrayList<>();
         ignoreTableName.add("test_user");
         ignoreTableName.add("test_group");
         // 忽略表前缀
         ArrayList<String> ignorePrefix = new ArrayList<>();
         ignorePrefix.add("test_");
         // 忽略表后缀
         ArrayList<String> ignoreSuffix = new ArrayList<>();
         ignoreSuffix.add("_test");
         // 需要生成数据库文档的表
         ArrayList<String> designatedTableName = new ArrayList<>();
         designatedTableName.add("t_user");
         designatedTableName.add("t_role");
         // 需要生成数据库文档的表前缀
         ArrayList<String> designatedTablePrefix = new ArrayList<>();
         designatedTablePrefix.add("t_");
         ProcessConfig processConfig = ProcessConfig.builder()
                 // 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                 // 根据名称指定表生成
 //                .designatedTableName(Arrays.asList("t_user","t_role"))
                 .designatedTableName(designatedTableName)
                 // 根据表前缀生成
                 .designatedTablePrefix(designatedTablePrefix)
                 // 根据表后缀生成
                 .designatedTableSuffix(new ArrayList<>())
                 // 忽略表名
                 .ignoreTableName(ignoreTableName)
                 // 忽略表前缀
                 .ignoreTablePrefix(ignorePrefix)
                 // 忽略表后缀
                 .ignoreTableSuffix(ignoreSuffix).build();
         //  创建screw的配置
         Configuration config = Configuration.builder()
                 // 版本
                 .version(DOC_VERSION)
                 // 描述
                 .description(DOC_DESCRIPTION)
                 // 数据源
                 .dataSource(dataSource)
                 // 生成配置
                 .engineConfig(engineConfig)
                 // 生成配置
                 .produceConfig(processConfig)
                 .build();
         // 执行screw，生成数据库文档
         new DocumentationExecute(config).execute();
     }
 }

第三步：测试
在这里插入图片描述
（２）Spring Boot整合screw

相关依赖maven仓库最新版本：https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core/1.0.5

第一步：引入screw相关maven依赖

<!-- 引入数据库表结构文档生成器Screw依赖-->
         <dependency>
             <groupId>cn.smallbun.screw</groupId>
             <artifactId>screw-core</artifactId>
             <version>1.0.5</version>
         </dependency>
         <dependency>
             <groupId>org.freemarker</groupId>
             <artifactId>freemarker</artifactId>
             <version>2.3.30</version>
         </dependency>
         <!--spring-boot-starter-jdbc-->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-jdbc</artifactId>
         </dependency>
         <!--mysql driver-->
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <version>8.0.20</version>
         </dependency>
         <!--oracle driver-->
         <dependency>
             <groupId>com.oracle.ojdbc</groupId>
             <artifactId>ojdbc8</artifactId>
             <version>19.3.0.0</version>
         </dependency>
         <dependency>
             <groupId>cn.easyproject</groupId>
             <artifactId>orai18n</artifactId>
             <version>12.1.0.2.0</version>
         </dependency>

第二步：SpringBoot配置文件配置数据源信息（我们配置文件为application.yml）

这里以MySQL为例：

spring:
   datasource:
     driver-class-name: com.mysql.cj.jdbc.Driver
     url: jdbc:mysql://127.0.0.1:3306/seckill?characterEncoding=UTF-8
     username: root
     password: root
     xa:
       properties:
         #设置useInformationSchema 可以获取tables表注释信息 即解决数据库表和列字段有说明、生成文档没有说明
         useInformationSchema: true

第三步：编写代码

使用单元测试，代码位于Spring Boot默认test文件夹下

具体编码如下：

 package com.example.screw;
 
 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 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.Arrays;
 import java.util.List;
 
 @SpringBootTest
 public class ScrewApplicationTests {
 
     @Autowired
     private ApplicationContext applicationContext;
 
     /**
      * 数据库文档生成
      */
     @Test
     void documentGeneration() {
         DataSource dataSource = applicationContext.getBean(DataSource.class);
         // 生成文件配置 创建screw的引擎配置
         EngineConfig engineConfig = EngineConfig.builder()
                 // 生成文件路径
                 .fileOutputDir("/Users/mac/screw_test")
                 // 打开目录
                 .openOutputDir(true)
                 // 文件类型 HTML->HTML文件  WORD->WORD文件  MD->Markdown文件
                 .fileType(EngineFileType.WORD)
                 // 生成模板实现
                 .produceType(EngineTemplateType.freemarker)
                 // 自定义文件名称，即生成的数据库文档名称
                 .fileName("XX系统数据库文档").build();
         // 生成文档配置（包含以下自定义版本号、描述等配置连接）
         Configuration config = Configuration.builder()
                 // 版本
                 .version("1.0.0")
                 // 描述
                 .description("数据库设计文档生成")
                 // 数据源
                 .dataSource(dataSource)
                 // 生成配置
                 .engineConfig(engineConfig)
                 // 生成配置
                 .produceConfig(getProcessConfig())
                 .build();
         // 执行screw，生成数据库文档
         new DocumentationExecute(config).execute();
     }
 
     /**
      * 配置想要生成的表+ 配置想要忽略的表
      */
     public static ProcessConfig getProcessConfig() {
         // 忽略表名
         List< String > ignoreTableName = Arrays.asList("t_user_info", "t_order");
         // 忽略表前缀，如忽略a开头的数据库表
         List< String > ignorePrefix = Arrays.asList("t_his");
         // 忽略表后缀
         List< String > ignoreSuffix = Arrays.asList("_test");
         // 需要生成数据库文档的表
         List< String > designatedTableName = Arrays.asList("t_user", "t_role");
         // 需要生成数据库文档的表前缀
         List< String > designatedTablePrefix = Arrays.asList("t_", "t_role");
         // 需要生成数据库文档的表后缀
         List< String > designatedTableSuffix = Arrays.asList("_exception");
         // 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
         return ProcessConfig.builder()
                 // 根据名称指定表生成
                 .designatedTableName(designatedTableName)
                 // 根据表前缀生成
                 .designatedTablePrefix(designatedTablePrefix)
                 // 根据表后缀生成
                 .designatedTableSuffix(designatedTableSuffix)
                 // 忽略表名
                 .ignoreTableName(ignoreTableName)
                 // 忽略表前缀
                 .ignoreTablePrefix(ignorePrefix)
                 // 忽略表后缀
                 .ignoreTableSuffix(ignoreSuffix).build();
     }
 }

第四步：测试

在这里插入图片描述