数据库设计文档生成工具类

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，如果数据库表结构更新了还得手动更新维护到文档中，很是繁琐。GitHub 上发现了一个好工具 screw（螺丝钉），在此分享下

1、引入依赖

<!-- screw核心 -->
<dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.5</version>
</dependency>
<!-- HikariCP数据库连接池 -->
<dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>3.4.5</version>
</dependency>
<!-- mysql连接驱动 -->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.20</version><scope>runtime</scope>
</dependency>

核心 cn.smallbun.screw

2、生成工具类

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;/*** 数据库设计文档生成类*/
public class BuildDatabaseDoc {/*** 文档生成*/public static void main(String[] args) {// 数据源HikariConfig hikariConfig = new HikariConfig();// 数据库连接信息hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/walking?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC");hikariConfig.setUsername("root");hikariConfig.setPassword("123456");// 设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);// 生成配置EngineConfig engineConfig = EngineConfig.builder()// 生成文件路径.fileOutputDir("E:/")// 打开目录.openOutputDir(true)// 文件类型.fileType(EngineFileType.HTML)// 生成模板实现.produceType(EngineTemplateType.freemarker)// 自定义文件名称.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");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 DocumentationExecute(config).execute();}
}

3、效果图预览

如您在阅读中发现不足，欢迎留言！！！

数据库设计文档生成工具类相关推荐

超好用的数据库设计文档生成工具
原创声明:本文为作者(幻好)原创,可用做学习参考转载,但需注明出处.禁止未经允许用于商业等途径,否则后果自负! 前言概述随着开发场景的复杂度越来越高,存储数据的数据库表也越来越多并不断的更新.在开发 ...
【MySQL】数据库设计文档生成
MySQL数据库设计文档生成文章目录 MySQL数据库设计文档生成前言 0.全局浏览 1.引入依赖 2.启动类 3.配置文件 4.实现类 5.成品展示前言记录MySQL数据库设计文档生成,旨在 ...
SCADE Display（OpenGL）软件设计文档生成工具的设计考虑
SCADE Display(OpenGL)软件设计文档生成工具的设计考虑 2018年6月 1 引言本文档描述在SCADE Display软件设计文档生成工具(以下简称为SDYSDDGEN)的设计过程 ...
mysql chm 文档_最简单，最实用的数据库CHM文档生成工具——DBCHM
推荐文章 1.SQLite: SELECT 'AA' || 'BB' || 'CC'; 2.MySQL: SELECT CONCAT('AA', 'BB', ' 推荐文章 QT += sql QSql ...
postgre 生成数据库html文档_还在手动整理数据库文档？试试这个（螺丝钉）数据库文档生成工具...
简介在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家企业,关于数据库表结构文档状态:要么没有.要么有.但都是手写.后期运维开发,需要手动进行维护到文档中,很是繁琐.如果 ...
好用！一键生成数据库文档，这个开源的文档生成工具值得了解
Gitee项目地址,可以直接去开源项目查看(推荐) https://gitee.com/leshalv/screw 简介在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家 ...
screw (螺丝钉) ~ 简洁好用的数据库表结构文档生成工具
https://gitee.com/leshalv/screw 特点简洁.轻量.设计良好多数据库支持多种格式文档灵活扩展支持自定义模板数据库支持 MySQL MariaDB TIDB Or ...
mysql自动生成数据库设计文档
mysql生成数据库设计文档引入jar包  <dependency><groupId>cn.smallbun.screw</ ...
SpringBoot 生成数据库设计文档工具
1.在项目的pom.xml里加上以上代码,配置想要生成的数据库的信息 <build><plugins><plugin><groupId>org.spri ...

数据库设计文档生成工具类

数据库设计文档生成工具类相关推荐

最新文章

热门文章