SpringBoot集成screw实现数据库表结构文档生成

目录

• 一、简介
• 二、效果图展示
• 三、使用方式
• 四、方法补充

一、简介

日常的开发工作中，经常会和数据库打交道，在某些场景可能会需要数据库表结构的文档，  screw（螺丝钉）是一款简洁好用的数据库表结构文档生成工具。支持多数据库、自定义模板、多种格式文档输出，具备简洁、轻量、设计良好、灵活扩展的特点。目前支持mysql、oracle、SqlServer、mariadb、PostgreSQL等数据库，生成文档目前支持html、word、markdown文档格式。

二、效果图展示

三、使用方式

引入依赖jar：

<!--screw数据库表结构文档生成工具-->
 <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.3</version>
    </dependency>

核心代码： 

package com.wonders.common.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 lombok.extern.slf4j.Slf4j;
 
import Javax.sql.DataSource;
import java.util.ArrayList;
 
/**
 * @Description: TODO：screw数据库表结构文档生成工具
 * @Author: yyalin
 * 参考网站：https://blog.csdn.net/weixin_49613823/article/details/128600130
 * @CreateDate: 2022/4/27 14:51
 * @Version: V1.0
 */
@Slf4j
public class ScrewUtils {
    public static void runScrew() {
        //MYSQL数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
//        //hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3308/test?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC&autoReconnect=true");
//        //TIDB连接
        //hikariConfig.setJdbcUrl("jdbc:mysql://10.1.50.190:4000/CDR?useUnicode=true&characterEncoding=utf8&useSSL=false&zeroDateTimeBehavior=convertToNull");
        hikariConfig.setJdbcUrl("jdbc:mysql://10.1.51.215:3306/KTHDC_MDM?useUnicode=true&characterEncoding=utf8&useSSL=false&zeroDateTimeBehavior=convertToNull");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("123456");
        //ORACLE数据源
//        HikariConfig hikariConfig = new HikariConfig();
//        hikariConfig.setDriverClassName("oracle.jdbc.driver.OracleDriver");
//        hikariConfig.setJdbcUrl("jdbc:oracle:thin:@10.1.51.175:1521/jcpt");
//        hikariConfig.setUsername("CDR");
//        hikariConfig.setPassword("CDR");php
 
 
        //设置可以获取tables remarks信息 表中文注释
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
 
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("D:\\\\docFile")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.WORD)   //word或html MD
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .build();
 
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("V1.0")
                //描述
                .description("数据库设计文档")
                //数据源
       php         .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(getProcessConfig())
                .build();
        //执行生成
        new DocumentationExecute(config).execute();
    }
    /**
     * 功能描述:配置生成对应表的筛选条件
     * @MethodName: getProcessConfig
     * @MethodParam: []
     * @Return: cn.smallbun.screw.core.process.ProcessConfig
     * @Author: yyalin
     * @CreateDate: 2022/4/27 15:15
     */
    public static ProcessConfig getProcessConfig() {
        //忽略表
        ArrayList<String> ignoreTableName = new ArrayList<>();
//        ignoreTableName.add("message");
        //忽略表前缀
        ArrayList<String> ignorePrefix = new ArrayList<>();
//        ignorePrefix.add("act_");
//        ignorePrefix.add("flw_");
        //忽略表后缀
        ArrayList<String> ignoreSuffix = new ArrayList<>();
//        ignoreSuffix.add("_dictionary");
 
        ArrayList<String> designatedTableList = new ArrayList<js;>();
//        designatedTableList.add("PDCA_DISINFECTION_SUPPLY");
//        designatedTableList.add("PDCA_SURGICAL_INSTRUMENTS");
//        designatedTableList.add("PUB_DIAG_CATA_MAP");
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
//                .designatedTableName(new ArrayList<>())
                .designatedTableName(designatedTableList)
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
        return processConfig;
    }
 
    //临时使用
    public static void main(String[] args) {
        runScrew();
    }
 
 
 
}

注意：可以通过设置忽略表名称、忽略表前缀、忽略表后缀等方式过滤不需要带出的相关表，从而达到指定导出的效果。

同样，可以与springboot更好地集成，只需将上述的参数配置在yml中即可，通过@Value("${spring.datasource.driver-class-name}")的方式获取即可。

四、方法补充

除了上文的内容，下面小编为大家整理了screw工具的其他应用，希望对大家有所帮助

1.引入库

pom文件中引入jar依赖

<!--  数据库设计文档生成工具-->
<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version>
</dependency>

2.通过命令行工具使用

下载cn.smallbun.screw的JAR文件，并将其添加到项目中。

在命令行中执行以下命令：

java -jar screw.jar -url jdbc:mysql://localhost:3306/database -driver com.mysql.jdbc.Driver -username root -password 123456 -type html -outDri doc

上述命令使用MySQL数据库作为示例，根据实际情况修改数据库连接相关参数。通过-type指定输出文档的格式，通过-outDri指定输出路径。

3.通过Java代码使用

代码如下（下面用的是postgres数据库）：

 
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.List;
 
public class DatabaseDesignDocUtil {
 
    public staticBwZUvvDX void main(String[] args) {
        documentGeneration();
    }
 
    /**
     * 文档生成
     */
    public static void documentGeneration() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("org.postgresql.Driver");
        hikariConfig.setJdbcUrl("jdbc:postgresql://39.164.52.80:5432/work_face");
        hikariConfig.setUsername("postgres");
        hikariConfig.setPassword("POSTGRES");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("C:\\Users\\tarzan\\Desktop\\doc")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.WORD)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("智能工作面数据库设计文档").build();
 
        //忽略表
        List<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");
        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 DjsocumentationExecute(config).execute();
    }
 
}

在上述示例中，我们创建了一个Configuration对象，配置了数据库连接信息和文档输出选项。然后，通过DocumentationExecute执行文档生成操作。需要改成mysql等别的数据库的，请在代码中改下驱动配置和连接配置。

到此这篇关于SpringBoot集成screw实现数据库表结构文档生成的文章就介绍到这了,更多相关SpringBoot screw数据库文档生成内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！