关键词:
介绍
今天看了 Guide老哥 公众号(需要的朋友可以关注一波: JavaGuide)中的一篇文章,发现了一款好用的数据库文档生成工具。
在项目中开发中,有没有遇到过编写数据库说明文档。一般情况下,数据库说明文档中有着大量的数据库表结构,如果手动进行维护,将会耗费大量时间,这样就不能愉快的进行摸鱼了。
所以呢,为了解决这个问题,Github 上的大佬开源了一款数据库表结构文档自动生成工具 —— screw
screw项目地址:https://github.com/pingfangushi/screw 。
screw 翻译过来的意思就是螺丝钉,作者希望这个工具能够像螺丝钉一样切实地帮助到我们的开发工作。
目前的话,screw 已经支持市面上大部分常见的数据库比如 MySQL、MariaDB、Oracle、SqlServer、PostgreSQL、TiDB。
快速开始
表结构脚本
为了验证 screw 自动生成数据库表结构文档的效果,我们首先创建一个简单的存放博客数据的数据库表。
CREATE TABLE `screw-demo-blog` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
`title` varchar(255) NOT NULL COMMENT '博客标题',
`content` longtext NOT NULL COMMENT '博客内容',
`description` varchar(255) DEFAULT NULL COMMENT '博客简介',
`cover` varchar(255) DEFAULT NULL COMMENT '博客封面图片地址',
`views` int(11) NOT NULL DEFAULT '0' COMMENT '博客阅读次数',
`user_id` bigint(20) DEFAULT '0' COMMENT '发表博客的用户ID',
`channel_id` bigint(20) NOT NULL COMMENT '博客分类ID',
`recommend` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否推荐',
`top` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否置顶',
`comment` bit(1) NOT NULL DEFAULT b'1' COMMENT '是否开启评论',
`created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=16 DEFAULT CHARSET=utf8mb4 COMMENT='博客';
基于 Java 代码
引入 screw 及相关依赖
创建一个普通的maven项目,导入以下依赖
<!--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>
</dependency>
你可以通过下面的地址在 mvnrepository 获取最新版本的 screw。
https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core
代码编写
生成数据库文档的代码的整个代码逻辑还是比较简单的,我们只需要经过下面 5 步即可:
1、获取数据库源
/**
* 获取数据库源
*/
private static DataSource getDataSource()
//数据源
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/test");
hikariConfig.setUsername("root");
hikariConfig.setPassword("root");
//设置可以获取tables remarks信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
return new HikariDataSource(hikariConfig);
2、获取文件生成配置
/**
* 获取文件生成配置
*/
private static EngineConfig getEngineConfig()
//生成配置
return EngineConfig.builder()
//生成文件路径
.fileOutputDir("/Users/guide/Documents/代码示例/screw-demo/doc")
//打开目录
.openOutputDir(true)
//文件类型
.fileType(EngineFileType.HTML)
//生成模板实现
.produceType(EngineTemplateType.freemarker)
//自定义文件名称
.fileName("数据库结构文档").build();
注意,如果不配置生成文件路径的话,默认也会存放在项目的 doc 目录下。
另外,我们这里指定生成的文件格式为 HTML。除了 HTML 之外,screw 还支持 Word 、Markdown 这两种文件格式。
3、获取数据库表的处理配置
可以在这里指定只生成哪些表结构(这个是可选项)
/**
* 获取数据库表的处理配置,可忽略
*/
private static ProcessConfig getProcessConfig()
return ProcessConfig.builder()
// 指定只生成 blog 表
.designatedTableName(new ArrayList<>(Collections.singletonList("screw-demo-blog")))
.build();
这里进行设置需要忽略生成的表结构(这个也是可选项)
private static ProcessConfig getProcessConfig()
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");
return ProcessConfig.builder()
//忽略表名
.ignoreTableName(ignoreTableName)
//忽略表前缀
.ignoreTablePrefix(ignorePrefix)
//忽略表后缀
.ignoreTableSuffix(ignoreSuffix)
.build();
如果以上设置都没有注定 ProcessConfig
进行配置的话,就会按照默认配置来!
4、生成 screw 完整配置
private static Configuration getScrewConfig(DataSource dataSource, EngineConfig engineConfig, ProcessConfig processConfig)
return Configuration.builder()
//版本
.version("1.0.0")
//描述
.description("数据库设计文档生成")
//数据源
.dataSource(dataSource)
//生成配置
.engineConfig(engineConfig)
//生成配置
.produceConfig(processConfig)
.build();
5、调用执行
private static Configuration getScrewConfig(DataSource dataSource, EngineConfig engineConfig, ProcessConfig processConfig)
return Configuration.builder()
//版本
.version("1.0.0")
//描述
.description("数据库设计文档生成")
//数据源
.dataSource(dataSource)
//生成配置
.engineConfig(engineConfig)
//生成配置
.produceConfig(processConfig)
.build();
生成结果效果展示(.html):
基于 Maven 插件
除了基于 Java 代码这种方式之外,你还可以通过 screw 提供的 Maven 插件来生成数据库文档。个人感觉maven插件的方式更加简单!
引入screw及相关依赖
这一步操作还是一样,保持不变
<!--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>
</dependency>
配置maven-plugins
这里还是在以上的依赖 pom.xml 文件中进行配置:
<build>
<plugins>
<plugin>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-maven-plugin</artifactId>
<version>1.0.5</version>
<dependencies>
<!-- HikariCP -->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.4.5</version>
</dependency>
<!--mysql driver-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
</dependencies>
<configuration>
<!--username-->
<username>root</username>
<!--password-->
<password>root</password>
<!--driver-->
<driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
<!--jdbc url-->
<jdbcUrl>jdbc:mysql://127.0.0.1:3306/test</jdbcUrl>
<!--生成文件类型-->
<fileType>MD</fileType>
<!--打开文件输出目录-->
<openOutputDir>true</openOutputDir>
<!--生成模板-->
<produceType>freemarker</produceType>
<!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
<fileName>数据库结构文档</fileName>
<!--描述-->
<description>数据库设计文档生成</description>
<!--版本-->
<version>$project.version</version>
<!--标题-->
<title>数据库文档</title>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
手动执行生成数据库文档
生成结果效果展示(.md):
成品地址
这里呢,我已经把以上的示例代码上传到我码云仓库中,需要的朋友直接clone下来就可以运行使用。
本博客示例代码获取地址:https://gitee.com/zhuziccEE/screw-code.git
如果感觉文章对你有帮助,就给点个赞吧!
实用!一键生成数据库文档,堪称数据库界的swagger(代码片段)
...结果就真的发现了宝藏,screw(螺丝钉),居然可以生成数据库文档, 查看详情
超大福利|这款免费java在线诊断利器,不用真的会后悔!
线上系统为何经常出错?数据库为何屡遭黑手?业务调用为何频频失败?连环异常堆栈案,究竟是哪次调用所为?数百台服务器意外雪崩背后又隐藏着什么?是软件的扭曲还是硬件的沦丧?走进科学带你了解Arthas,一款开源一年... 查看详情
screw工具基本使用:一键生成java实体类和数据库文档(代码片段)
...rew生成JavaPOJO对象Screw基本介绍Screw是一个非常简洁好用的数据库表结构文档生成工具,支持MySQL,Oracle,PostgreSQL等主流的关系数据库Screw数据库表结构文档生成工具支持生成以下三种格式的文档:HTMLWordMarkdownScrew文档生成方式Screw数据... 查看详情
开源|一款简洁好用的数据库表结构文档生成工具
以下内容选自「码农周刊VIP会员」圈子,每日更新,精彩不断。一款简洁好用的数据库表结构文档生成工具,旨在成为企业级开发过程中,一颗永不生锈的螺丝钉。 查看详情
实用!一键生成数据库文档的神器,支持mysql/sqlserver/oracle多种数据库
一款好用的数据库表结构文档生成工具(代码片段)
下面介绍一款:简洁好用的数据库表结构文档工具screw,支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB数据库。主要代码示例:/***文档生成*/voiddocumentGeneration()//数据源HikariConfighikariConfig=newHikariConfig 查看详情
还在手写数据库设计文档?java一键生成(代码片段)
...;文末获取源码联系🍅前言:以前我们还需要手写数据库设计文档、现在可以通过引入screw核心包来实现Java数据库文档一键生成。 查看详情
还在手写数据库设计文档?java一键生成(代码片段)
...;文末获取源码联系🍅前言:以前我们还需要手写数据库设计文档、现在可以通过引入screw核心包来实现Java数据库文档一键生成。 查看详情
screw工具基本使用:一键生成java实体类和数据库文档(代码片段)
...rew生成JavaPOJO对象Screw基本介绍Screw是一个非常简洁好用的数据库表结构文档生成工具,支持MySQL,Oracle,PostgreSQL等主流的关系数据库Screw数据库表结构文档生成工具支持生成以下三种格式的文档:HTMLWordMarkdownScrew文档生成方式Screw数据... 查看详情
screw工具基本使用:一键生成java实体类和数据库文档(代码片段)
...rew生成JavaPOJO对象Screw基本介绍Screw是一个非常简洁好用的数据库表结构文档生成工具,支持MySQL,Oracle,PostgreSQL等主流的关系数据库Screw数据库表结构文档生成工具支持生成以下三种格式的文档:HTMLWordMarkdownScrew文档生成方式Screw数据... 查看详情
开源:一款基于.net开发提升开发效率的强大多功能工具箱
...程序猿量身打造的日常开发工具箱,是集成于作者的数据库工具SmartSQL数据库文档查询、导出工具中的一个功能模块。汇聚了码农们日常开发工作时需要用到的各种小工具。💼工具介绍SQL格式化实现sql格式化处理,一... 查看详情
vscode插件利器:自动生成代码注释文档算法复杂度
...、编写和理解代码。目前,Figstack可以解释代码,生成文档,计算函数的时间复杂度。解释代码以自然语言解释代码自动编写文档不喜欢为你的代码编写文档?让figstackdocstring来帮您编写可读性很高的文档吧z计算... 查看详情
vscode插件利器:自动生成代码注释文档算法复杂度
...、编写和理解代码。目前,Figstack可以解释代码,生成文档,计算函数的时间复杂度。解释代码以自然语言解释代码自动编写文档不喜欢为你的代码编写文档?让figstackdocstring来帮您编写可读性很高的文档吧z计算... 查看详情
随机生成测试数据<faker模块的基本使用;(代码片段)
...只需要调用Faker提供的方法,即可快速完成数据的生成。github项目地址:https://github.com/joke2k/faker官方文档:https: 查看详情
apipost:一款值得使用的利器(代码片段)
...GET、PUT常见的HTTP请求,支持团队协作,并可直接生成并导出接口文档的API调试、管理工具。你可以把这款利器看成这样的组合:Apipost=Postman+Swagger+MockPostman和Swagger大家应该都很熟悉了吧,Mock这边小编和... 查看详情
程序员必备利器:8款“珍藏已久”的程序开发利器,瞬间提升效率
...时,你会发现不知不觉中自己开始浏览微博、知乎、GitHub等其他分散注意力的 查看详情
github近两万star,无需编码,可一键生成前后端代码
作者:GitHub猿链接:https://mp.weixin.qq.com/s/z5zptWFil7U5cvu1dcu0fA 正文 大家好,我是GitHub猿。上次是谁要前后端分离架构项目啊,猿哥帮你找到了。这是我目前见过的最好的开源一键生成前后端产品。功能完... 查看详情
github近两万star,无需编码,可一键生成前后端代码
作者:GitHub猿链接:https://mp.weixin.qq.com/s/z5zptWFil7U5cvu1dcu0fA 正文 大家好,我是GitHub猿。上次是谁要前后端分离架构项目啊,猿哥帮你找到了。这是我目前见过的最好的开源一键生成前后端产品。功能完... 查看详情