wsdl文档中的soap:address的生成规则_BAT大牛都在使用的数据库文档生成插件,不来看一下？...

一、概述

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出&＃xff0c;从业以来&＃xff0c;待过几家企业&＃xff0c;关于数据库表结构文档状态&＃xff1a;要么没有、要么有、但都是手写、后期运维开发&＃xff0c;需要手动进行维护到文档中&＃xff0c;很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后面接手的人。之前有一段时间开发了一个项目&＃xff0c;是那种开发完后后期补充文档的。写数据库文档的时候特别恶心&＃xff0c;需要对着数据库中的表和表字段。当表特别多的时候&＃xff0c;眼睛都会看花。不知道大家是否有过这种经历&＃xff0c;我当时是采取笨方法一个表一个字段写的&＃xff0c;恶心坏了。最近在github上发现了一个数据库文档插件&＃xff0c;挺不错的&＃xff0c;介绍给大家&＃xff0c;住大家脱离数据库文档编写的苦海。

二、插件介绍

1. screw自动生成数据库文档
2. 支持多种格式文档&＃xff1a;html、word和markdown
3. 支持多种类型的数据库&＃xff1a;MySQL、MariaDB、TIDB、Oracle、SqlServer、PostgreSQL和Cache DB

三、插件运用

1. 在数据库中新建表格(没有具体含义&＃xff0c;纯粹是为了演示)

SET FOREIGN_KEY_CHECKS&＃61;0;

-- ----------------------------
-- Table structure for account_type
-- ----------------------------
DROP TABLE IF EXISTS &＃96;account_type&＃96;;
CREATE TABLE &＃96;account_type&＃96; (
  &＃96;id&＃96; tinyint unsigned NOT NULL COMMENT &＃39;主账号 0, 附属账号 1&＃39;,
  &＃96;type&＃96; varchar(50) DEFAULT &＃39;主账号&＃39;,
  &＃96;created_at&＃96; timestamp NULL DEFAULT CURRENT_TIMESTAMP,
  &＃96;updated_at&＃96; timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (&＃96;id&＃96;)
) ENGINE&＃61;InnoDB DEFAULT CHARSET&＃61;utf8mb4 COLLATE&＃61;utf8mb4_0900_ai_ci COMMENT&＃61;&＃39;账户类型字典表&＃39;;

-- ----------------------------
-- Table structure for iap_order
-- ----------------------------
DROP TABLE IF EXISTS &＃96;iap_order&＃96;;
CREATE TABLE &＃96;iap_order&＃96; (
  &＃96;transaction_id&＃96; varchar(200) NOT NULL COMMENT &＃39;交易方式&＃39;,
  &＃96;principal_id&＃96; bigint unsigned DEFAULT NULL COMMENT &＃39;userId可能为null&＃39;,
  &＃96;product_id&＃96; bigint unsigned DEFAULT NULL COMMENT &＃39;product id&＃39;,
  &＃96;apple_id&＃96; bigint unsigned DEFAULT NULL COMMENT &＃39;apple id&＃39;,
  &＃96;receipt_data&＃96; longtext COMMENT &＃39;完整的receipt&＃39;,
  &＃96;platform&＃96; varchar(20) DEFAULT NULL COMMENT &＃39;平台&＃39;,
  &＃96;status&＃96; tinyint unsigned DEFAULT &＃39;0&＃39; COMMENT &＃39;订单状态 &＃39;,
  &＃96;created_at&＃96; timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT &＃39;创建时间&＃39;,
  &＃96;updated_at&＃96; timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT &＃39;更新时间&＃39;,
  PRIMARY KEY (&＃96;transaction_id&＃96;)
) ENGINE&＃61;InnoDB DEFAULT CHARSET&＃61;utf8mb4 COLLATE&＃61;utf8mb4_0900_ai_ci COMMENT&＃61;&＃39;IAP订单&＃39;;

-- ----------------------------
-- Table structure for points_rule
-- ----------------------------
DROP TABLE IF EXISTS &＃96;points_rule&＃96;;
CREATE TABLE &＃96;points_rule&＃96; (
  &＃96;id&＃96; int NOT NULL AUTO_INCREMENT COMMENT &＃39;规则id&＃39;,
  &＃96;member_level&＃96; int DEFAULT NULL COMMENT &＃39;用户规则适用等级&＃39;,
  &＃96;daily_video_view_points&＃96; int DEFAULT NULL COMMENT &＃39;每日观看视频积分&＃39;,
  &＃96;daily_article_view_points&＃96; int DEFAULT NULL COMMENT &＃39;每日阅读文章积分&＃39;,
  &＃96;daily_video_share_points&＃96; int DEFAULT NULL COMMENT &＃39;每日分享视频积分&＃39;,
  &＃96;daily_article_share_points&＃96; int DEFAULT NULL COMMENT &＃39;每日分享文章积分&＃39;,
  &＃96;daily_comment_post_points&＃96; int DEFAULT NULL COMMENT &＃39;每日评论积分&＃39;,
  &＃96;daily_login_points&＃96; int DEFAULT NULL COMMENT &＃39;每日登陆积分&＃39;,
  &＃96;created_at&＃96; timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT &＃39;创建时间&＃39;,
  &＃96;updated_at&＃96; timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT &＃39;更新时间&＃39;,
  PRIMARY KEY (&＃96;id&＃96;)
) ENGINE&＃61;InnoDB DEFAULT CHARSET&＃61;utf8mb4 COLLATE&＃61;utf8mb4_0900_ai_ci COMMENT&＃61;&＃39;积分规则&＃39;;


2. 在项目中引入插件(可以直接复制过去&＃xff0c;开箱即用)


                cn.smallbun.screwgroupId>
                screw-maven-pluginartifactId>
                1.0.4version>
                
                    
                    
                        com.zaxxergroupId>
                        HikariCPartifactId>
                        3.4.5version>
                    dependency>
                    
                    
                        mysqlgroupId>
                        mysql-connector-javaartifactId>
                        8.0.20version>
                    dependency>
                dependencies>
                
                    
                    rootusername>
                    
                    123456password>
                    
                    com.mysql.cj.jdbc.DriverdriverClassName>
                    
                    jdbc:mysql://192.168.1.7:3306/db?useUnicode&＃61;true&zeroDateTimeBehavior&＃61;convertToNull&autoReconnect&＃61;truejdbcUrl>
                    
                    HTMLfileType>
                    
                    falseopenOutputDir>
                    
                    freemarkerproduceType>
                    
                    db数据库表说明文档fileName>
                    
                    表和字段说明description>
                    
                    1.0.0.0version>
                    
                    数据库文档title>
                configuration>
                
                    
                        compilephase>
                        
                            rungoal>
                        goals>
                    execution>
                executions>
            plugin>


3. 调用screw插件

4. 结果演示

文档生成地址&＃xff1a;根目录下doc文件下

html数据库文档演示&＃xff1a;怎么样&＃xff0c;是不是眼前一亮&＃xff0c;简直和我们日常写的数据库文档一样&＃xff0c;你是不是也手痒痒了&＃xff0c;来试一下吧&＃xff01;可以节省很多数据库文档编写和维护时间。

四、总结

这个插件使用起来特别方便&＃xff0c;开箱即用。但是在创建表格的时候&＃xff0c;需要对每个字段和表做好描述。不然输出的数据库文档可能就不能满足我们的使用了。