一鍵生成數(shù)據(jù)庫(kù)文檔，堪稱數(shù)據(jù)庫(kù)界的Swagger
大家好，我是 Guide，今天分享一個(gè)好用的數(shù)據(jù)庫(kù)文檔生成工具。
在項(xiàng)目中，我們經(jīng)常需要整理數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔。
一般情況下，我們都是手動(dòng)整理數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔，當(dāng)表結(jié)構(gòu)有變動(dòng)的時(shí)候，自己手動(dòng)進(jìn)行維護(hù)。
數(shù)據(jù)庫(kù)表少的時(shí)候還好，數(shù)據(jù)庫(kù)表多了之后，手動(dòng)整理和維護(hù)數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔簡(jiǎn)直不要太麻煩，而且，還非常容易出錯(cuò)！
有沒(méi)有什么好用的工具幫助我們自動(dòng)生成數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔呢？
當(dāng)然有！Github 上就有一位朋友開源了一款數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔自動(dòng)生成工具—— screw 。
項(xiàng)目地址：https://github.com/pingfangushi/screw 。
screw 翻譯過(guò)來(lái)的意思就是螺絲釘，作者希望這個(gè)工具能夠像螺絲釘一樣切實(shí)地幫助到我們的開發(fā)工作。
目前的話，screw 已經(jīng)支持市面上大部分常見的數(shù)據(jù)庫(kù)比如 MySQL、MariaDB、Oracle、SqlServer、PostgreSQL、TiDB。
另外，screw 使用起來(lái)也非常簡(jiǎn)單，根據(jù)官網(wǎng)提示，不用 10 分鐘就能成功在本地使用起來(lái)！
快速入門
為了驗(yàn)證 screw 自動(dòng)生成數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔的效果，我們首先創(chuàng)建一個(gè)簡(jiǎn)單的存放博客數(shù)據(jù)的數(shù)據(jù)庫(kù)表。
CREATE TABLE `blog` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
`title` varchar(255) NOT NULL COMMENT '博客標(biāo)題',
`content` longtext NOT NULL COMMENT '博客內(nèi)容',
`description` varchar(255) DEFAULT NULL COMMENT '博客簡(jiǎn)介',
`cover` varchar(255) DEFAULT NULL COMMENT '博客封面圖片地址',
`views` int(11) NOT NULL DEFAULT '0' COMMENT '博客閱讀次數(shù)',
`user_id` bigint(20) DEFAULT '0' COMMENT '發(fā)表博客的用戶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 '是否開啟評(píng)論',
`created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時(shí)間',
`updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '更新時(shí)間',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=16 DEFAULT CHARSET=utf8mb4 COMMENT='博客';
基于 Java 代碼
引入依賴
創(chuàng)建一個(gè)普通的 Maven 項(xiàng)目即可！然后引入 screw、HikariCP、MySQL 這 3 個(gè)依賴。
<!--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>
你可以通過(guò)下面的地址在 mvnrepository 獲取最新版本的 screw。
https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core
編寫代碼
生成數(shù)據(jù)庫(kù)文檔的代碼的整個(gè)代碼邏輯還是比較簡(jiǎn)單的，我們只需要經(jīng)過(guò)下面 5 步即可：
// 1.獲取數(shù)據(jù)源
DataSource dataSource = getDataSource();
// 2.獲取數(shù)據(jù)庫(kù)文檔生成配置（文件路徑、文件類型）
EngineConfig engineConfig = getEngineConfig();
// 3.獲取數(shù)據(jù)庫(kù)表的處理配置，可忽略
ProcessConfig processConfig = getProcessConfig();
// 4.Screw 完整配置
Configuration config = getScrewConfig(dataSource, engineConfig, processConfig);
// 5.執(zhí)行生成數(shù)據(jù)庫(kù)文檔
new DocumentationExecute(config).execute();
1、獲取數(shù)據(jù)庫(kù)源
對(duì)數(shù)據(jù)庫(kù)以及數(shù)據(jù)庫(kù)連接池進(jìn)行相關(guān)配置。務(wù)必將數(shù)據(jù)庫(kù)相關(guān)的配置修改成你自己的。
/**
* 獲取數(shù)據(jù)庫(kù)源
*/
private static DataSource getDataSource() {
//數(shù)據(jù)源
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/javaguide-blog");
hikariConfig.setUsername("root");
hikariConfig.setPassword("123456");
//設(shè)置可以獲取tables remarks信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
return new HikariDataSource(hikariConfig);
}
2、獲取文件生成配置
這一步會(huì)指定數(shù)據(jù)庫(kù)文檔生成的位置、文件類型以及文件名稱。
/**
* 獲取文件生成配置
*/
private static EngineConfig getEngineConfig() {
//生成配置
return EngineConfig.builder()
//生成文件路徑
.fileOutputDir("/Users/guide/Documents/代碼示例/screw-demo/doc")
//打開目錄
.openOutputDir(true)
//文件類型
.fileType(EngineFileType.HTML)
//生成模板實(shí)現(xiàn)
.produceType(EngineTemplateType.freemarker)
//自定義文件名稱
.fileName("數(shù)據(jù)庫(kù)結(jié)構(gòu)文檔").build();
}
如果不配置生成文件路徑的話，默認(rèn)也會(huì)存放在項(xiàng)目的 doc 目錄下。
另外，我們這里指定生成的文件格式為 HTML。除了 HTML 之外，screw 還支持 Word 、Markdown 這兩種文件格式。
不太建議生成 Word 格式,比較推薦 Markdown 格式。
3、獲取數(shù)據(jù)庫(kù)表的處理配置
這一步你可以指定忽略生成哪些表。
/**
* 獲取數(shù)據(jù)庫(kù)表的處理配置，可忽略
*/
private static ProcessConfig getProcessConfig() {
return ProcessConfig.builder()
// 指定只生成 blog 表
.designatedTableName(new ArrayList<>(Collections.singletonList("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 的話，就會(huì)按照默認(rèn)配置來(lái)！
4、生成 screw 完整配置
根據(jù)前面 3 步，生成 screw 完整配置。
private static Configuration getScrewConfig(DataSource dataSource, EngineConfig engineConfig, ProcessConfig processConfig) {
return Configuration.builder()
//版本
.version("1.0.0")
//描述
.description("數(shù)據(jù)庫(kù)設(shè)計(jì)文檔生成")
//數(shù)據(jù)源
.dataSource(dataSource)
//生成配置
.engineConfig(engineConfig)
//生成配置
.produceConfig(processConfig)
.build();
}
5、執(zhí)行生成數(shù)據(jù)庫(kù)文檔
下圖就是生成的 HTML 格式的數(shù)據(jù)庫(kù)設(shè)計(jì)文檔。
基于 Maven 插件
除了基于 Java 代碼這種方式之外，你還可以通過(guò) screw 提供的 Maven 插件來(lái)生成數(shù)據(jù)庫(kù)文檔。方法也非常簡(jiǎn)單！
1、配置 Maven 插件
務(wù)必將數(shù)據(jù)庫(kù)相關(guān)的配置修改成你自己的。
<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>123456</password>
<!--driver-->
<driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
<!--jdbc url-->
<jdbcUrl>jdbc:mysql://127.0.0.1:3306/javaguide-blog</jdbcUrl>
<!--生成文件類型-->
<fileType>MD</fileType>
<!--打開文件輸出目錄-->
<openOutputDir>true</openOutputDir>
<!--生成模板-->
<produceType>freemarker</produceType>
<!--文檔名稱 為空時(shí):將采用[數(shù)據(jù)庫(kù)名稱-描述-版本號(hào)]作為文檔名稱-->
<fileName>數(shù)據(jù)庫(kù)結(jié)構(gòu)文檔</fileName>
<!--描述-->
<description>數(shù)據(jù)庫(kù)設(shè)計(jì)文檔生成</description>
<!--版本-->
<version>${project.version}</version>
<!--標(biāo)題-->
<title>數(shù)據(jù)庫(kù)文檔</title>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
2、手動(dòng)執(zhí)行生成數(shù)據(jù)庫(kù)文檔
我們這里指定生成的是 Markdown 格式。
下圖就是生成的 Markdown 格式的數(shù)據(jù)庫(kù)設(shè)計(jì)文檔，效果還是非常不錯(cuò)的！
我是 Guide哥，一個(gè)工作2年有余，接觸編程已經(jīng)6年有余的程序員。大三開源 JavaGuide，目前已經(jīng) 100k+ Star。未來(lái)幾年，希望持續(xù)完善 JavaGuide，爭(zhēng)取能夠幫助更多學(xué)習(xí) Java 的小伙伴！共勉！凎！點(diǎn)擊即可了解我的個(gè)人經(jīng)歷。
歡迎點(diǎn)贊分享。咱們下期再會(huì)!