一、概述

在企業級開發中、我們經常會有編寫數據庫表結構文檔的時間付出，從業以來，待過幾家企業，關于數據庫表結構文檔狀態：要么沒有、要么有、但都是手寫、后期運維開發，需要手動進行維護到文檔中，很是繁瑣、如果忘記一次維護、就會給以后工作造成很多困擾、無形中制造了很多坑留給自己和后面接手的人。之前有一段時間開發了一個項目，是那種開發完后后期補充文檔的。寫數據庫文檔的時候特別惡心，需要對著數據庫中的表和表字段。當表特別多的時候，眼睛都會看花。不知道大家是否有過這種經歷，我當時是采取笨方法一個表一個字段寫的，惡心壞了。最近在github上發現了一個數據庫文檔插件，挺不錯的，介紹給大家，住大家脫離數據庫文檔編寫的苦海。

二、插件介紹

screw自動生成數據庫文檔

支持多種格式文檔：html、word和markdown

支持多種類型的數據庫：MySQL、MariaDB、TIDB、Oracle、SqlServer、PostgreSQL和Cache DB

三、插件運用

在數據庫中新建表格(沒有具體含義，純粹是為了演示)

SET?FOREIGN_KEY_CHECKS=0;

--?----------------------------
--?Table?structure?for?account_type
--?----------------------------
DROP?TABLE?IF?EXISTS?`account_type`;
CREATE?TABLE?`account_type`?(
??`id`?tinyint?unsigned?NOT?NULL?COMMENT?'主賬號?0,?附屬賬號?1',
??`type`?varchar(50)?DEFAULT?'主賬號',
??`created_at`?timestamp?NULL?DEFAULT?CURRENT_TIMESTAMP,
??`updated_at`?timestamp?NULL?DEFAULT?CURRENT_TIMESTAMP?ON?UPDATE?CURRENT_TIMESTAMP,
??PRIMARY?KEY?(`id`)
)?ENGINE=InnoDB?DEFAULT?CHARSET=utf8mb4?COLLATE=utf8mb4_0900_ai_ci?COMMENT='賬戶類型字典表';

--?----------------------------
--?Table?structure?for?iap_order
--?----------------------------
DROP?TABLE?IF?EXISTS?`iap_order`;
CREATE?TABLE?`iap_order`?(
??`transaction_id`?varchar(200)?NOT?NULL?COMMENT?'交易方式',
??`principal_id`?bigint?unsigned?DEFAULT?NULL?COMMENT?'userId可能為null',
??`product_id`?bigint?unsigned?DEFAULT?NULL?COMMENT?'product?id',
??`apple_id`?bigint?unsigned?DEFAULT?NULL?COMMENT?'apple?id',
??`receipt_data`?longtext?COMMENT?'完整的receipt',
??`platform`?varchar(20)?DEFAULT?NULL?COMMENT?'平臺',
??`status`?tinyint?unsigned?DEFAULT?'0'?COMMENT?'訂單狀態?',
??`created_at`?timestamp?NULL?DEFAULT?CURRENT_TIMESTAMP?COMMENT?'創建時間',
??`updated_at`?timestamp?NULL?DEFAULT?CURRENT_TIMESTAMP?ON?UPDATE?CURRENT_TIMESTAMP?COMMENT?'更新時間',
??PRIMARY?KEY?(`transaction_id`)
)?ENGINE=InnoDB?DEFAULT?CHARSET=utf8mb4?COLLATE=utf8mb4_0900_ai_ci?COMMENT='IAP訂單';

--?----------------------------
--?Table?structure?for?points_rule
--?----------------------------
DROP?TABLE?IF?EXISTS?`points_rule`;
CREATE?TABLE?`points_rule`?(
??`id`?int?NOT?NULL?AUTO_INCREMENT?COMMENT?'規則id',
??`member_level`?int?DEFAULT?NULL?COMMENT?'用戶規則適用等級',
??`daily_video_view_points`?int?DEFAULT?NULL?COMMENT?'每日觀看視頻積分',
??`daily_article_view_points`?int?DEFAULT?NULL?COMMENT?'每日閱讀文章積分',
??`daily_video_share_points`?int?DEFAULT?NULL?COMMENT?'每日分享視頻積分',
??`daily_article_share_points`?int?DEFAULT?NULL?COMMENT?'每日分享文章積分',
??`daily_comment_post_points`?int?DEFAULT?NULL?COMMENT?'每日評論積分',
??`daily_login_points`?int?DEFAULT?NULL?COMMENT?'每日登陸積分',
??`created_at`?timestamp?NULL?DEFAULT?CURRENT_TIMESTAMP?COMMENT?'創建時間',
??`updated_at`?timestamp?NULL?DEFAULT?CURRENT_TIMESTAMP?ON?UPDATE?CURRENT_TIMESTAMP?COMMENT?'更新時間',
??PRIMARY?KEY?(`id`)
)?ENGINE=InnoDB?DEFAULT?CHARSET=utf8mb4?COLLATE=utf8mb4_0900_ai_ci?COMMENT='積分規則';

在項目中引入插件(可以直接復制過去，開箱即用)

<plugin>
????????????????<groupId>cn.smallbun.screwgroupId>
????????????????<artifactId>screw-maven-pluginartifactId>
????????????????<version>1.0.4version>
????????????????<dependencies>
????????????????????
????????????????????<dependency>
????????????????????????<groupId>com.zaxxergroupId>
????????????????????????<artifactId>HikariCPartifactId>
????????????????????????<version>3.4.5version>
????????????????????dependency>
????????????????????
????????????????????<dependency>
????????????????????????<groupId>mysqlgroupId>
????????????????????????<artifactId>mysql-connector-javaartifactId>
????????????????????????<version>8.0.20version>
????????????????????dependency>
????????????????dependencies>
????????????????<configuration>
????????????????????
????????????????????<username>rootusername>
????????????????????
????????????????????<password>123456password>
????????????????????
????????????????????<driverClassName>com.mysql.cj.jdbc.DriverdriverClassName>
????????????????????
????????????????????<jdbcUrl>jdbc:mysql://192.168.1.7:3306/db?useUnicode=true&zeroDateTimeBehavior=convertToNull&autoReconnect=truejdbcUrl>
????????????????????
????????????????????<fileType>HTMLfileType>
????????????????????
????????????????????<openOutputDir>falseopenOutputDir>
????????????????????
????????????????????<produceType>freemarkerproduceType>
????????????????????
????????????????????<fileName>db數據庫表說明文檔fileName>
????????????????????
????????????????????<description>表和字段說明description>
????????????????????
????????????????????<version>1.0.0.0version>
????????????????????
????????????????????<title>數據庫文檔title>
????????????????configuration>
????????????????<executions>
????????????????????<execution>
????????????????????????<phase>compilephase>
????????????????????????<goals>
????????????????????????????<goal>rungoal>
????????????????????????goals>
????????????????????execution>
????????????????executions>
????????????plugin>

調用screw插件

結果演示

文檔生成地址：根目錄下doc文件下

html數據庫文檔演示：怎么樣，是不是眼前一亮，簡直和我們日常寫的數據庫文檔一樣，你是不是也手癢癢了，來試一下吧！可以節省很多數據庫文檔編寫和維護時間。

四、總結

這個插件使用起來特別方便，開箱即用。但是在創建表格的時候，需要對每個字段和表做好描述。不然輸出的數據庫文檔可能就不能滿足我們的使用了。

總結

以上是生活随笔為你收集整理的wsdl文档中的soap:address的生成规则_BAT大牛都在使用的数据库文档生成插件,不来看一下？...的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。