数据库表结构文档生成工具-screw (螺丝钉)

screw 数据库表结构文档生成快速入门

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

2、详细介绍参考官网：https://gitee.com/leshalv/screw

3、使用非常简单，直接从官网复制源码即可使用。需要注意的是：screw 1.0.5 版本时，cn.smallbun.screw.core.query.AbstractDatabaseQuery.getSchema 中会强转 DataSource 为 HikariDataSource，所以只支持 HikariDataSource 数据源。(Spring boot 默认 HikariCP 作为数据源.)

4、添加 screw 依赖：

        <!--数据库文档生成工具--><!-- https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core --><dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.5</version></dependency>

https://gitee.com/wangmx1993/jpa-transactional/blob/master/pom.xml

5、编写测试类或者访问接口生成数据库表文档，如果是需要对远程服务器上的数据库生成文档，则还需要在下面的基础上，将生成的文档文件做一个下载功能。

/** screw (螺丝钉) 英:[skruː] ~ 简洁好用的数据库表结构文档生成工具* @author wangMaoXiong* @version 1.0* @date 2022/5/22 10:35*/
@RestController
public class DocGeneration {@Resourceprivate DataSource dataSource;@Resourceprivate JdbcTemplate jdbcTemplate;/*** http://localhost:8080/doc/generation* 数据库表结构文档生成工具*/@GetMapping("doc/generation")public String documentGeneration() {// 获取桌面目录作为文档存放目录, 指定生成的文件名称File homeDirectory = FileSystemView.getFileSystemView().getHomeDirectory();String fileName = "数据库设计文档";// 生成的文件类型：HTML-> .html，WORD-> .doc、MD-> .mdEngineFileType fileType = EngineFileType.HTML;// 数据源也可以从 Spring 容器中获取，或者通过 jdbcTemplate 获取.// screw 1.0.5 版本时, cn.smallbun.screw.core.query.AbstractDatabaseQuery.getSchema 中会强转为 HikariDataSource// 所以只支持 HikariDataSource 数据源(Spring boot 默认 HikariCP 作为数据源.)HikariConfig hikariConfig = new HikariConfig();hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/test?characterEncoding=UTF-8&serverTimezone=UTC");hikariConfig.setUsername("root");hikariConfig.setPassword("root");// 设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);// 文件生成配置EngineConfig engineConfig = EngineConfig.builder()// 生成文件存放的目录.fileOutputDir(homeDirectory.getAbsolutePath())// 生成完成是否打开输出目录.openOutputDir(true)// 生成文件类型：HTML-> .html，WORD-> .doc、MD-> .md.fileType(fileType)// 生成模板实现.produceType(EngineTemplateType.freemarker)// 自定义文件名称.fileName(fileName).build();// 忽略指定名称的表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");ignoreSuffix.add("_backup");// 数据处理配置ProcessConfig processConfig = ProcessConfig.builder()// 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置// 根据名称指定表生成.designatedTableName(new ArrayList<>())// 根据表前缀生成.designatedTablePrefix(new ArrayList<>())// 根据表后缀生成.designatedTableSuffix(new ArrayList<>())// 忽略指定名称的表.ignoreTableName(ignoreTableName)// 忽略指定名称前缀的表.ignoreTablePrefix(ignorePrefix)// 忽略指定名称后缀的表.ignoreTableSuffix(ignoreSuffix).build();// Screw 配置入口Configuration config = Configuration.builder()// 版本.version("1.0.0")// 描述.description("数据库设计文档生成")// 数据源(可以自己单独配置，也可以直接从应用中获取).dataSource(dataSource)// 文档生成配置.engineConfig(engineConfig)// 数据处理配置.produceConfig(processConfig).build();// 执行生成文档new DocumentationExecute(config).execute();// 文档文件全路径, 如 E:\桌面\数据库设计文档.htmlString fullPath = homeDirectory + File.separator + fileName + fileType.getFileSuffix();return fullPath;}
}

https://gitee.com/wangmx1993/jpa-transactional/blob/master/src/main/java/com/wmx/controller/DocGeneration.java

数据库表结构文档生成工具-screw (螺丝钉)相关推荐

简洁好用的数据库表结构文档生成工具！
在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家企业,关于数据库表结构文档状态:要么没有.要么有.但都是手写.后期运维开发,需要手动进行维护到文档中,很是繁琐.如果忘记一 ...
screw (螺丝钉) ~ 简洁好用的数据库表结构文档生成工具
https://gitee.com/leshalv/screw 特点简洁.轻量.设计良好多数据库支持多种格式文档灵活扩展支持自定义模板数据库支持 MySQL MariaDB TIDB Or ...
screw (螺丝钉) 数据库表结构文档生成工具(转发)
转发自:https://blog.csdn.net/minkeyto/article/details/107358209
Java实现生成数据库表结构文档（生成工具screw的使用）
目录一.screw介绍 1.简介 2.特点 3.文档格式二.生成方式 2.1 方式1:使用 Java 代码 2.1.1 引入依赖 2.1.2 编写代码 2.1.3 测试 2.2 方式2:使用 Sp ...
【工具篇】利用DBExportDoc V1.0 For MySQL自动生成数据库表结构文档(转
对于DBA或开发来说,如何规范化你的数据库表结构文档是灰常之重要的一件事情.但是当你的库,你的表排山倒海滴多的时候,你就会很头疼了. 推荐一款工具DBExportDoc V1.0 For MySQL( ...
开源数据库表结构文档生成器
大家好,我是TJ 一个励志推荐10000款开源项目与工具的程序员 TJ君前几天和一个在银行科技部上班的同学聚会,同学跟TJ君吐槽,一些小银行的科技表面看上去专业,实际各种马虎不负责. 打个比方,有一次 ...
导出mysql数据库表结构文档
导出文档示例: 说明,文档是基poi工具来生成的(主要是依赖与数据库名正确的话可以直接运行) 一.需要的依赖 <dependency><groupId>org.apache.p ...
超好用的数据库设计文档生成工具
原创声明:本文为作者(幻好)原创,可用做学习参考转载,但需注明出处.禁止未经允许用于商业等途径,否则后果自负! 前言概述随着开发场景的复杂度越来越高,存储数据的数据库表也越来越多并不断的更新.在开发 ...
postgre 生成数据库html文档_还在手动整理数据库文档？试试这个（螺丝钉）数据库文档生成工具...
简介在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家企业,关于数据库表结构文档状态:要么没有.要么有.但都是手写.后期运维开发,需要手动进行维护到文档中,很是繁琐.如果 ...
好用！一键生成数据库文档，这个开源的文档生成工具值得了解
Gitee项目地址,可以直接去开源项目查看(推荐) https://gitee.com/leshalv/screw 简介在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家 ...

数据库表结构文档生成工具-screw (螺丝钉)

screw 数据库表结构文档生成快速入门

数据库表结构文档生成工具-screw (螺丝钉)相关推荐

最新文章

热门文章