作爲程序猿,寫文檔是必備的技能之一,可是大多數程序猿,都討厭寫文檔,尤其是數據庫設計說明書,因爲這實在是一件費勁的事情,大多時候,程序出了Bug,都是直接調整數據庫,增刪改字段,時間久了,數據庫文檔就沒人維護,就失去了參考意義。
所以,能不能每次需要數據表設計說明文檔時(領導要求或者其他需要),不再手寫或者手動維護,而是能夠自動導出呢?今天發現了一個比較厲害的項目,碼雲地址:https://gitee.com/39627020/Create-DB-Structure
本人親測項目可用,我們導入項目,先建立數據表(帶註釋),腳本如下:
DROP TABLE IF EXISTS `ybt_area`;
CREATE TABLE `ybt_area` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`areacode` varchar(64) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '編碼',
`areaname` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '名稱',
`sort` tinyint(4) DEFAULT NULL COMMENT '排序',
`areabankno` varchar(64) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '編號',
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=97 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci ROW_FORMAT=DYNAMIC;
DROP TABLE IF EXISTS `ybt_bank`;
CREATE TABLE `ybt_bank` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
`bankCode` varchar(60) DEFAULT NULL COMMENT '銀行機構代碼',
`bankName` varchar(255) DEFAULT NULL COMMENT '銀行機構名稱',
`belongClrBank` varchar(60) DEFAULT NULL COMMENT '所屬清算行號',
`link_number` varchar(60) DEFAULT NULL COMMENT '聯行行號',
`sort` int(11) DEFAULT NULL COMMENT '排序',
`operate_user_id` bigint(20) DEFAULT NULL COMMENT '操作人id',
`operate_time` datetime DEFAULT NULL COMMENT '操作時間',
`belongClrBankName` varchar(255) DEFAULT NULL COMMENT '清算行名稱',
`bank_number` varchar(64) DEFAULT NULL COMMENT '所屬銀行代碼',
`region_code` varchar(64) DEFAULT NULL COMMENT '所屬區劃代碼',
`large_number` varchar(64) DEFAULT NULL COMMENT '大額行號',
`pme_clr_bank` varchar(64) DEFAULT NULL COMMENT '清算行號',
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=131028 DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC COMMENT='銀行基礎信息';
DROP TABLE IF EXISTS `ybt_bankid`;
CREATE TABLE `ybt_bankid` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`bank_name` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '銀行名稱',
`sort` tinyint(4) DEFAULT NULL COMMENT '排序',
`bankid` varchar(64) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '銀行分類',
`sign` tinyint(4) DEFAULT NULL COMMENT '標記聯行號處理。1:只到省,2:到支行',
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=30 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci ROW_FORMAT=DYNAMIC;
我們建了3張表,下面來看看生成數據表說明文檔步驟:
1)修改application.properties配置文件,配置相關參數(數據庫名密碼等等)
2)啓動項目,訪問http://127.0.0.1:8080/create,頁面顯示true說明成功
3)打開項目的output文件夾,打開生成的excle表