Java实现生成数据库表结构文档（生成工具screw的使用）

我就是我 2024-03-30 15:58 41阅读 0赞

## 一、screw介绍 ##

日常的开发工作中，经常会和数据库打交道，在某些场景可能会需要数据库表结构的文档，今天分享个简洁好用的数据库表结构文档生成工具screw。

### 1.简介 ###

screw是一个简洁好用的**数据库表结构文档的生成工具** 。

screw目前支持MySQL、Oracle、SqlServer、MariaDB、PostgreSQL等数据库，生成文档目前支持html、word、markdown文档格式。

github: [GitHub - pingfangushi/screw: 简洁好用的数据库表结构文档生成器][GitHub - pingfangushi_screw_] gitee: screw: [简洁好用的数据库表结构文档工具，支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。][MySQL_MariaDB_SqlServer_Oracle_PostgreSQL_TIDB_CacheDB]

### 2.特点 ###

**screw的特点：**

### 3.文档格式 ###

生成文档目前支持html、word、markdown文档格式。

## 二、生成方式 ##

下面以MySQL数据库为例来简单介绍下。

新建测试库test及表t\_user、t\_product。

CREATE TABLE `t_user` (
      `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户id',
      `name` varchar(255) DEFAULT NULL COMMENT '名称',
      `age` int(10) DEFAULT NULL COMMENT '年龄',
      `remarks` varchar(255) DEFAULT NULL COMMENT '备注',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      `create_user` varchar(255) DEFAULT NULL COMMENT '创建人',
      `update_time` datetime DEFAULT NULL COMMENT '更新时间',
      `update_user` varchar(255) DEFAULT NULL COMMENT '更新人',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户信息表';
    
    CREATE TABLE `t_product` (
      `product_id` int(11) NOT NULL,
      `title` varchar(255) DEFAULT NULL COMMENT '标题',
      `sub_title` varchar(255) DEFAULT NULL COMMENT '副标题',
      `sale_price` decimal(10,2) DEFAULT NULL COMMENT '商品售价',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      `create_by` int(11) DEFAULT NULL COMMENT '创建者',
      `update_time` datetime DEFAULT NULL COMMENT '修改时间',
      `update_by` int(11) DEFAULT NULL COMMENT '修改者',
      PRIMARY KEY (`product_id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='商品表';

### 2.1 方式1：使用 Java 代码 ###

#### 2.1.1 引入依赖 ####

引入screw的maven依赖：

<dependency>
         <groupId>cn.smallbun.screw</groupId>
         <artifactId>screw-core</artifactId>
         <version>1.0.5</version>
     </dependency>

除此之外，还需引入数据库相关的依赖：

<dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>3.4.5</version>
    </dependency>
    
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.30</version>
    </dependency>

#### 2.1.2 编写代码 ####

package com.example.screwdemo.utils;
    
    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;
    
    /**
     * @author qzz
     */
    public class DocumentGenerator {
        
       
    
        //以下static final修饰的参数 如果是基于SpringBoot项目，可以在配置文件中配置，通过@Value注解获取
        /**
         * MySQL驱动 6.0以前的使用com.mysql.jdbc.Driver，6.0以后的使用com.mysql.cj.jdbc.Driver  我这边使用的是mysql-5.7.25版本的
         */
        private static final String Driver_Class_Name = "com.mysql.jdbc.Driver";
        /**
         * 数据库URL   characterEncoding=UTF-8: 防止生成后文档乱码
         */
        private static final String DB_URL = "jdbc:mysql://localhost:3306/test?&allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSl=false";
        /**
         * MySQL数据库账号密码
         */
        private static final String DB_USERNAME = "root";
        private static final String DB_PASSWORD = "root";
        /**
         *  生成数据库文档文件路径 可根据本机电脑自行配置
         */
        private static final String FILE_OUTPUT_DIR = "F:\\dbDoc\\";
    
        /**
         * screw配置的文件名称，即数据库文档名称
         */
        private static final String DOC_FILE_NAME = "数据库设计文档生成";
        /**
         * screw配置的文件类型 HTML->HTML文件  WORD->WORD文件  MD->Markdown文件
         */
        private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
        /**
         * 版本
         */
        private static final String DOC_VERSION = "1.0.0";
        /**
         * 描述
         */
        private static final String DOC_DESCRIPTION = "数据库设计文档生成";
    
        public static void main(String[] args) {
        
       
            generatorDocument();
        }
        public static void generatorDocument() {
        
       
            //数据源  创建HikariConfig配置类
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setDriverClassName(Driver_Class_Name);
            hikariConfig.setJdbcUrl(DB_URL);
            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");
    
            // 需要生成数据库文档的表  如果designatedTablePrefix设置值不为空，则 designatedTableName 中的表名要去掉前缀，不然会重复生成，并且表名和字段注释有误
            ArrayList<String> designatedTableName = new ArrayList<>();
    //        designatedTableName.add("user");
    //        designatedTableName.add("product");
            // 需要生成数据库文档的表前缀
            ArrayList<String> designatedTablePrefix = new ArrayList<>();
            designatedTablePrefix.add("t_");
    
    
            ProcessConfig processConfig = ProcessConfig.builder()
                    //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                    //根据名称指定表生成
    //                .designatedTableName(new ArrayList<>())
                    .designatedTableName(designatedTableName)
                    //根据表前缀生成
    //                .designatedTablePrefix(new ArrayList<>())
                    .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();
        }
    }

注意点：

示例： 如数据库中存在表t\_user 和 t\_product等多张表，要求只导出t\_user 和 t\_product的数据库文档，screw的处理配置中的指定表与指定表的前缀的处理方式有如下两种： 方式一：指定表

// 需要生成数据库文档的表
    ArrayList<String> designatedTableName = new ArrayList<>();
    designatedTableName.add("t_user");
    designatedTableName.add("t_product");

方式二：指定表与指定表的前缀

// 需要生成数据库文档的表
    ArrayList<String> designatedTableName = new ArrayList<>();
    designatedTableName.add("user");
    designatedTableName.add("product");
    // 需要生成数据库文档的表前缀
    ArrayList<String> designatedTablePrefix = new ArrayList<>();
    designatedTablePrefix.add("t_");

#### 2.1.3 测试 ####

![img][]

### 2.2 方式2：使用 Spring Boot 整合screw ###

#### 2.2.1 引入依赖 ####

引入screw的maven依赖：

除此之外，还需引入数据库相关的依赖：

#### 2.2.2 配置数据源信息 ####

**application.yml:**

# 服务端口
    server:
      port: 8083
    
    # 数据源配置
    spring:
      datasource:
        name: test
        url: jdbc:mysql://localhost:3306/test?&allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSl=false
        username: root
        password: root
        driver-class-name: com.mysql.jdbc.Driver
        xa:
          properties:
            #设置useInformationSchema 可以获取tables表注释信息 即解决数据库表和列字段有说明、生成文档没有说明
           useInformationSchema: true
      
    # 生成数据库文档文件路径
    FILE_OUTPUT_DIR: F:\dbDoc\
    # 版本
    DOC_VERSION: 1.0.0
    # screw配置的文件名称，即数据库文档名称
    DOC_FILE_NAME: xx数据库设计文档
    # 描述
    DOC_DESCRIPTION: 数据库设计文档生成

#### 2.2.3 编写代码 ####

**generatorService.java：**

package com.example.screwdemo.service;
    
    /**
     *  生成 数据库表结构文档
     * @author qzz
     */
    public interface GeneratorService {
        
       
    
        /**
         * 生成 数据库表结构文档
         */
        void generatorDocument();
    }

**generatorServiceImpl.java：**

package com.example.screwdemo.service.impl;
    
    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.example.screwdemo.service.GeneratorService;
    import com.zaxxer.hikari.HikariConfig;
    import com.zaxxer.hikari.HikariDataSource;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.ApplicationContext;
    import org.springframework.stereotype.Service;
    import javax.sql.DataSource;
    import java.util.ArrayList;
    
    /**
     * 生成 数据库表结构文档
     * @author qzz
     */
    @Service
    public class GeneRatorServiceImpl implements GeneratorService {
        
       
    
        @Autowired
        private ApplicationContext applicationContext;//注入应用上下文
    
        /**
         * MySQL驱动
         */
        @Value("${spring.datasource.driver-class-name}")
        private String Driver_Class_Name;
        /**
         * 数据库URL   characterEncoding=UTF-8: 防止生成后文档乱码
         */
        @Value("${spring.datasource.url}")
        private String DB_URL;
        /**
         * MySQL数据库账号密码
         */
        @Value("${spring.datasource.username}")
        private String DB_USERNAME = "root";
        @Value("${spring.datasource.password}")
        private String DB_PASSWORD = "root";
    
        /**
         *  生成数据库文档文件路径 可根据本机电脑自行配置
         */
        @Value("${FILE_OUTPUT_DIR}")
        private String FILE_OUTPUT_DIR;
    
        /**
         * 版本
         */
        @Value("${DOC_VERSION}")
        private String DOC_VERSION;
    
        /**
         * screw配置的文件类型 HTML->HTML文件  WORD->WORD文件  MD->Markdown文件
         */
        private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
        /**
         * screw配置的文件名称，即数据库文档名称
         */
        @Value("${DOC_FILE_NAME}")
        private String DOC_FILE_NAME;
        /**
         * 描述
         */
        @Value("${DOC_DESCRIPTION}")
        private String DOC_DESCRIPTION;
    
        /**
         * 生成 数据库表结构文档
         */
        @Override
        public void generatorDocument() {
        
       
            //获取数据源 此方法报No qualifying bean of type 'javax.sql.DataSource' available
    //        DataSource dataSource = applicationContext.getBean(DataSource.class);
    
            //获取数据源  创建HikariConfig配置类
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setDriverClassName(Driver_Class_Name);
            hikariConfig.setJdbcUrl(DB_URL);
            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的配置:生成文档配置（包含以下自定义版本号、描述等配置连接）
            Configuration config = Configuration.builder()
                    //版本
                    .version(DOC_VERSION)
                    //描述
                    .description(DOC_DESCRIPTION)
                    //数据源
                    .dataSource(dataSource)
                    //生成配置
                    .engineConfig(engineConfig)
                    //生成配置
                    .produceConfig(getProcessConfig())
                    .build();
            //执行screw，生成数据库文档
            new DocumentationExecute(config).execute();
        }
    
        /**
         * 配置想要生成的表、想要忽略的表
         * @return
         */
        private ProcessConfig getProcessConfig() {
        
       
            //创建screw的处理配置，可忽略
            //忽略表
            ArrayList<String> ignoreTableName = new ArrayList<>();
            ignoreTableName.add("test_user");
            ignoreTableName.add("test_group");
            //忽略表前缀，如忽略test_开头的数据库表
            ArrayList<String> ignorePrefix = new ArrayList<>();
            ignorePrefix.add("test_");
            //忽略表后缀
            ArrayList<String> ignoreSuffix = new ArrayList<>();
            ignoreSuffix.add("_test");
    
            // 需要生成数据库文档的表  如果designatedTablePrefix设置值不为空，则 designatedTableName 中的表名要去掉前缀，不然会重复生成，并且表名和字段注释有误
            ArrayList<String> designatedTableName = new ArrayList<>();
    //        designatedTableName.add("user");
    //        designatedTableName.add("product");
            // 需要生成数据库文档的表前缀
            ArrayList<String> designatedTablePrefix = new ArrayList<>();
            designatedTablePrefix.add("t_");
    
            //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
            ProcessConfig processConfig = ProcessConfig.builder()
                    //根据名称指定表生成
    //                .designatedTableName(new ArrayList<>())
                    .designatedTableName(designatedTableName)
                    //根据表前缀生成
    //                .designatedTablePrefix(new ArrayList<>())
                    .designatedTablePrefix(designatedTablePrefix)
                    //根据表后缀生成
                    .designatedTableSuffix(new ArrayList<>())
                    //忽略表名
                    .ignoreTableName(ignoreTableName)
                    //忽略表前缀
                    .ignoreTablePrefix(ignorePrefix)
                    //忽略表后缀
                    .ignoreTableSuffix(ignoreSuffix).build();
            return processConfig;
        }
    
    
    }

编写controller测试方法：

package com.example.screwdemo.controller;
    
    import com.example.screwdemo.service.GeneratorService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * 数据库表结构文档生成工具
     * @author qzz
     */
    @RestController
    @RequestMapping("/generator")
    public class GeneratorController {
        
       
    
        @Autowired
        private GeneratorService generatorService;
    
        /**
         * 生成数据库表结构文档
         */
        @RequestMapping("/generatorDocument")
        public void generatorDocument(){
        
       
            generatorService.generatorDocument();
        }
    }

#### 2.2.4 启动测试 ####

postman 获取浏览器输入 链接 [http://localhost:8083/generator/generatorDocument][http_localhost_8083_generator_generatorDocument]，执行效果： ![img][img 1] ![img][img 2]

## 三、完整代码 ##

可点击 [此处][Link 1]下载

--------------------

title: Java实现生成数据库表结构文档（生成工具screw的使用）  
date: 22-08-03 17:11:48 修改  
转载于：https://blog.csdn.net/qq\_26383975/article/details/126052573  
tags:  
\-SpringBoot  
\-java  
\-数据库  
\-数据库  
\-postgresql  
\-mysql

--------------------

[GitHub - pingfangushi_screw_]: https://github.com/pingfangushi/screw
[MySQL_MariaDB_SqlServer_Oracle_PostgreSQL_TIDB_CacheDB]: https://gitee.com/leshalv/screw
[img]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/97dd2dbf34c04faeb2b8b7907f269c5d.png
[http_localhost_8083_generator_generatorDocument]: http://localhost:8083/generator/generatorDocument
[img 1]: https://img-blog.csdnimg.cn/0562a29765c84f4f9cabfab800b731a9.png
[img 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/7f22e02944d64612a5a591df00146400.png
[Link 1]: https://github.com/katie1221/springboot-screw