超给力,一键生成数据库文档-数据库表结构逆向工程
一、解决什么问题
数据库文档是我们在企业项目开发中需要交付的文档,通常需要开发人员去手工编写。编写完成后,数据库发生变更又需要手动的进行修改,从而浪费了大量的人力。并且这种文档并没有什么技术含量,被安排做这个工作的程序员往往自己心里会有抵触情绪,悲观的预期自己在团队的位置,造成离职也是可能的。如下面的这种文档的内容:
笔者最近在github上面发现一个数据库文档生成工具:screw(螺丝钉)。该工具能够通过简单地配置,快速的根据数据库表结构进行逆向工程,将数据库表结构及字段逆向生成为文档。
二、特点
- 简洁、轻量、设计良好
- 多数据库支持:MySQL、MariaDB、TIDB、Oracle、 SqlServer、PostgreSQL、Cache DB
- 多种格式文档: html、word、 markdwon
- 灵活扩展:支持用户自定义模板和展示样式修改(freemarker模板)
三、依赖库探究
mvn中央仓库查看最新版本,将如下的maven坐标引入到Spring Boot项目中去:
<dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.3</version>
</dependency>
从maven仓库的编译依赖中可以看到,screw-core其实现依赖了如下的内容。重点关注freemarker,因为该项目是使用freemarker作为模板生成文档。
除此之外,screw使用了HikariCP作为数据库连接池,所以:
- 你的Spring Boot项目需要引入HikariCP数据库连接池。
- 根据你的数据库类型及版本,引入正确的JDBC驱动
四、开始造作吧
以上的工作都做好之后,我们就可以来配置文档生成参数了。实现文档生成有两种方式,一种是写代码,一种是使用maven 插件。
- 我个人还是比较喜欢使用代码的当时,写一个单元测试用例就可以了,相对独立,使用方式也灵活。
- 如果放在pom.xml的插件配置里面,让本就很冗长的pom.xml变的更加的冗长,不喜欢。
所以maven插件的这种方式我就不给大家演示了,直接把下面的代码Ctrl + C/V到你的src/test/java目录下。简单的修改配置,运行就可以了
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 org.junit.jupiter.api.Test;import javax.sql.DataSource;
import java.util.ArrayList;public class ScrewTest {@Testvoid testScrew() {//数据源HikariConfig hikariConfig = new HikariConfig();hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");hikariConfig.setUsername("db-username");hikariConfig.setPassword("db-password");//设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);//生成配置EngineConfig engineConfig = EngineConfig.builder()//生成文件路径.fileOutputDir("d://")//打开目录.openOutputDir(true)//生成文件类型:HTML.fileType(EngineFileType.HTML)//生成模板实现.produceType(EngineTemplateType.freemarker).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();}
}
在测试用例里面运行上面的代码,就会自动生成数据库文档到fileOutputDir配置目录下。
五、效果
超给力,一键生成数据库文档-数据库表结构逆向工程相关推荐
- 一键生成 API 文档的妙招
一般接口文档编写完成后,就要开始编写调用接口的代码,很多开发团队都采用传统的通过接口文档的方式来编写接口.但在接口数量越来越多的当下,手写接口十分麻烦. 今天我们通过 Eolink 演示一种一键生成 ...
- 一键生成PDF文档的书签和目录(书签,目录页带页码 都行)
转自:https://blog.csdn.net/u010391342/article/details/86681359 一键生成PDF文档的书签目录 原创codeing_doc 发布于2019-01 ...
- 开发者必备工具,一键生成接口文档、调用示例
前言 开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档. 那要怎么快速的出接口文档.调用示例.mock呢?如果太麻烦,很多人就不愿意去写了. 今天给大家介绍一个 ...
- admin.php生成地址,FastAdmin命令行一键生成API文档
一键生成API文档 FastAdmin中的一键生成API文档可以在命令行或后台一键生成我们API接口的接口测试文档,可以直接在线模拟接口请求,查看参数示例和返回示例. 准备工作 请确保你的API模块下 ...
- 【mysql系列】一键生成mysql文档
前言:我们有时候在编写文档的时候会涉及到数据库表结构,如何建完表之后将表的文档一键生成呢? 一.pom引入screw <!-- screw核心 --><dependency>& ...
- 利用EA根据sql脚本生成数据库文档
强烈推荐一个大神的人工智能的教程:http://www.captainbed.net/zhanghan [前言] 最近接到一个任务,通过数据库的sql脚本生成相应的数据库文档,表的数量比较多,手动写是 ...
- 干掉 Postman?测试接口直接生成API文档,这个文档工具真香!
欢迎关注方志朋的博客,回复"666"获面试宝典 实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...
- 数据库系统开发生命周期各个阶段需要获取的数据以及生成的文档
数据库系统开发生命周期各个阶段需要获取的数据以及生成的文档 数据库规划 系统定义 需求收集与分析 数据库设计 应用程序设计 DBMS选型 建立原型系统 实现 数据转换与加载 测试 运行维护 摘抄自&l ...
- 干掉Postman?测试接口直接生成API文档,这工具强烈推荐!
最近被身边几个做开发的朋友安利了一款国产的 API 开发调试神器,真的有被惊艳到!!!简直不要太好用! 没想到,中国也有了比 Postman 还好用的软件! 这个 API 开发调试神器就是 ApiPo ...
- 干掉 Postman?测试接口直接生成 API 文档,这工具真香!
作者:小 G 来源:GitHubDaily " 阅读本文大概需要 5 分钟. " 前阵子,偶然发现一款国产 API 接口开发调试神器,上手尝鲜之后,真的有被惊艳到,功能齐全,对中文 ...
最新文章
- 扩增子图片解读7三元图:美的不要不要的,再多用也不过分
- 清华大佬告诉史上最全的Java进阶书籍推荐面南背北
- android 时间管理app,时间管理app
- BZOJ 3786: 星系探索 欧拉游览树
- Win10(UEFI启动)安装Ubuntu18.04双系统
- HDU——2444 The Accomodation of Students
- securecrt是什么工具_比较一下几款常用的SSH工具
- Homebrew是什么?怎么关闭自动更新?
- xshell linux查看cpu,Linux系统CPU子系统,命令和监控
- SQL Cookbook(读书笔记)No.2
- Julia: arrow,一种革命性的数据格式
- matlab中函数迭代法,Matlab 数值计算----斯特芬森加速迭代法
- 生物信息学简史,A brief history of bioinformatics- Briefings in Bioinformatics综述解读
- EMV Level1(7816)学习(Smart Cart智能卡)-2
- 盘点近些年成功的游戏联名营销
- 东莞厚街工业机器人展会_展会效果大起底2020东莞厚街机械展暨2020东莞国际工业自动化及机器人展览会...
- 为什么日本人不吃鲤鱼
- Workspaces can only be enabled in private projects
- CAD文件如何转成PDF格式?告诉你如何转换
- 怎样伪原创视频 如何查看视频的md5