SpringBoot中集成screw(螺丝钉)实现数据库表结构文档生成方法

 更新时间:2024年07月26日 09:03:34   作者:霸道流氓气质  
这篇文章主要介绍了SpringBoot中集成screw(螺丝钉)实现数据库表结构文档生成,下面以连接mysql数据库并生成html格式的数据库结构文档为例,插件的使用方式除可以使用代码外,还可以使用Maven插件的方式,需要的朋友可以参考下

场景

经常会有编写数据库表结构文档的时间付出,那能否通过简单配置实现自动生成。

screw

screw (螺丝钉) 英:[skruː] ~ 简洁好用的数据库表结构文档生成工具。

https://gitee.com/leshalv/screw

特点

简洁、轻量、设计良好

多数据库支持

多种格式文档

灵活扩展

支持自定义模板

数据库支持

MySQL

MariaDB

TIDB

Oracle

SqlServer

PostgreSQL

Cache DB(2016)

H2 (开发中)

DB2 (开发中)

HSQL (开发中)

SQLite(开发中)

瀚高(开发中)

达梦 (开发中)

虚谷 (开发中)

人大金仓(开发中)

文档生成支持

html

word

markdown

实现

下面以连接mysql数据库并生成html格式的数据库结构文档为例

插件的使用方式除可以使用代码外,还可以使用Maven插件的方式。

这里考虑将其集成到单独的springboot项目中,并使用单元测试的方式需要时配置和运行。

新建springboot项目,并引入screw的依赖

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

maven仓库地址

https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core

然后生成文档还需依赖

        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

这里还需要连接mysql数据库以及单元测试等的依赖

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--MySQL驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>       

新建单元测试类

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.ArrayList;
import java.util.Arrays;
import java.util.List;
@SpringBootTest
class ScrewTest {
    @Autowired
    ApplicationContext applicationContext;
    @Test
    void createDataBaseWorld() {
        DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
        // 生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径,自己mac本地的地址,这里需要自己更换下路径
                .fileOutputDir("D:\\test\\badao\\")
                // 打开目录
                .openOutputDir(false)
                // 文件类型
                .fileType(EngineFileType.HTML)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();
        // 生成文档配置(包含以下自定义版本号、描述等配置连接)
        Configuration config = Configuration.builder()
                .version("1.0.3")
                .description("badao")
                .dataSource(dataSourceMysql)
                .engineConfig(engineConfig)
                .produceConfig(getProcessConfig())
                .build();
        // 执行生成
        new DocumentationExecute(config).execute();
    }
    /**
     * 配置想要生成的表+ 配置想要忽略的表
     * @return 生成表配置
     */
    public static ProcessConfig getProcessConfig(){
        // 忽略表名
        List<String> ignoreTableName = Arrays.asList("test_users","test1");
        // 忽略表前缀,如忽略a开头的数据库表
        List<String> ignorePrefix = Arrays.asList("qrtz","sys","gen");
        // 忽略表后缀
        List<String> ignoreSuffix = Arrays.asList("_log");
        return ProcessConfig.builder()
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
    }
}

这里要注意引入依赖的路径。

然后这里需要在配置文件这里是yml中配置数据源

# 数据源
spring:
  application:
    name: badao-tcp-demo
  datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
    dbcp2:
      min-idle: 5                                # 数据库连接池的最小维持连接数
      initial-size: 5                            # 初始化连接数
      max-total: 5                               # 最大连接数
      max-wait-millis: 150                       # 等待连接获取的最大超时时间

然后再上面单元测试中还可配置要忽略的表,指定前后缀等。

运行该单元测试,到配置的指定目录下查看

到此这篇关于SpringBoot中集成screw(螺丝钉)实现数据库表结构文档生成的文章就介绍到这了,更多相关SpringBoot中集成screw(螺丝钉)实现数据库表结构文档生成内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • JAVA基础 语句标签的合法使用,以及{}语句块到底有什么用?

    JAVA基础 语句标签的合法使用,以及{}语句块到底有什么用?

    以前的一个思维误区,for(){},if(){}之类的用法中,逻辑if()和语句块{}应该是相互独立的两种语法
    2012-08-08
  • Mybatis如何解决sql中like通配符模糊匹配问题

    Mybatis如何解决sql中like通配符模糊匹配问题

    这篇文章主要介绍了Mybatis如何解决sql中like通配符模糊匹配问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • Spring中实现定时调度的几种方法

    Spring中实现定时调度的几种方法

    本篇文章主要介绍了Spring中实现定时调度示例,可以在无人值守的时候系统可以在某一时刻执行某些特定的功能,有兴趣的可以了解一下。
    2017-02-02
  • SpringBoot+mybatis实现多数据源支持操作

    SpringBoot+mybatis实现多数据源支持操作

    这篇文章主要介绍了SpringBoot+mybatis实现多数据源支持操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • Spring中的FactoryBean实现原理详解

    Spring中的FactoryBean实现原理详解

    这篇文章主要介绍了Spring中的FactoryBean实现原理详解,spring中有两种类型的Bean,一种是普通的JavaBean,另一种就是工厂Bean(FactoryBean),这两种Bean都受Spring的IoC容器管理,但它们之间却有一些区别,需要的朋友可以参考下
    2024-02-02
  • Mybatis如何实现InsertOrUpdate功能

    Mybatis如何实现InsertOrUpdate功能

    这篇文章主要介绍了Mybatis如何实现InsertOrUpdate功能,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-05-05
  • KotlinScript构建SpringBootStarter保姆级教程

    KotlinScript构建SpringBootStarter保姆级教程

    这篇文章主要为大家介绍了KotlinScript构建SpringBootStarter的保姆级教程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • Servlet编程第一步之从零构建Hello World应用详细步骤+图解

    Servlet编程第一步之从零构建Hello World应用详细步骤+图解

    本文详细介绍了Servlet和maven的基本概念及其在JavaWeb开发中的应用,首先解释了Servlet是一个在服务器上处理请求的Java程序,然后介绍了maven作为管理和构建Java项目的工具,需要的朋友可以参考下
    2024-10-10
  • Spring的RequestBodyAdvice拦截浅析

    Spring的RequestBodyAdvice拦截浅析

    本文主要介绍了Spring的RequestBodyAdvice拦截浅析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-02-02
  • 详解设计模式在Spring中的应用(9种)

    详解设计模式在Spring中的应用(9种)

    这篇文章主要介绍了详解设计模式在Spring中的应用(9种),详细的介绍了这9种模式在项目中的应用,具有一定的参考价值,感兴趣的可以了解一下
    2019-04-04

最新评论