作为程序猿,写文档是必备的技能之一,可是大多数程序猿,都讨厌写文档,尤其是数据库设计说明书,因为这实在是一件费劲的事情,大多时候,程序出了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表