添加HttpUtil的Javadoc

AwakenCN · Sep 6, 2019 · dd3111c · dd3111c
1 parent c074a31
commit dd3111c
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 5 deletions.
diff --git a/bash.exe.stackdump b/bash.exe.stackdump
@@ -0,0 +1,9 @@
+Stack trace:
+Frame        Function    Args
+000FFFFA198  0018005D44E (0018023C1CD, 0018021DC26, 000FFFFA198, 000FFFF9090)
+000FFFFA198  00180046609 (00000000000, 00000000000, 00000000000, 001005F0D3C)
+000FFFFA198  00180046642 (0018023C289, 000FFFFA048, 000FFFFA198, 00000000000)
+000FFFFA198  001800AA5FF (00000000000, 00000000000, 00000000000, 00000000000)
+000FFFFA198  001800AA84D (000FFFFA1B0, 00000000000, 00000000000, 00000000000)
+000FFFFA230  001800ABB1C (000FFFFA1B0, 00000000000, 00000000000, 00000000000)
+End of stack trace
diff --git a/doc/javadoc/common/bean/vo/SendServerVO.md b/doc/javadoc/common/bean/vo/SendServerVO.md
@@ -0,0 +1,15 @@
+## SendServerVO
+
+包路径：com.github.unclecatmyself.common.bean.vo
+
+类说明：服务通讯View Object
+
+### 属性
+
+- String token   
+
+token标签
+
+- String value
+
+对应的值
diff --git a/doc/javadoc/common/util/HttpUtil.md b/doc/javadoc/common/util/HttpUtil.md
@@ -0,0 +1,19 @@
+## HttpUtil
+
+包路径：com.github.unclecatmyself.common.utils
+
+类说明：HTTP接口基础工具处理
+
+### 方法
+
+- checkType(FullHttpRequest msg)
+
+> 返回 String
+
+说明：校验API接口获取通讯数据的类型，类似Rest API 的后缀判断
+
+- getToken(FullHttpRequest msg) 
+
+> 返回 [SendServerVO](../bean/vo/SendServerVO.md)
+
+说明：从uri中获取对应的Token值，构造对应的[SendServerVO](../bean/vo/SendServerVO.md)
diff --git a/doc/javadoc/javadoc.md b/doc/javadoc/javadoc.md
@@ -16,6 +16,7 @@
 
 ### utils
 
+- [HttpUtil](common/util/HttpUtil.md)
 - [SslUtil](common/util/SslUtil.md)
 - [SnowflakeIdWorker](common/util/SnowflakeIdWorker.md)
 - [TokenGenerator](common/util/TokenGenerator.md)

diff --git a/src/main/java/com/github/unclecatmyself/common/utils/HttpUtil.java b/src/main/java/com/github/unclecatmyself/common/utils/HttpUtil.java
@@ -1,6 +1,5 @@
 package com.github.unclecatmyself.common.utils;
 
-import com.alibaba.fastjson.JSONObject;
 import com.github.unclecatmyself.common.bean.vo.SendServerVO;
 import com.github.unclecatmyself.common.constant.Constans;
 import com.github.unclecatmyself.common.constant.HttpConstant;
@@ -9,10 +8,6 @@
 import io.netty.util.CharsetUtil;
 
 import java.io.*;
-import java.net.HttpURLConnection;
-import java.net.MalformedURLException;
-import java.net.URL;
-import java.util.Map;
 
 /**
  * HTTP接口处理方法