gateway comment

itning · May 7, 2019 · b01f3b9 · b01f3b9
1 parent 18d94f2
commit b01f3b9
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/shw-gateway/src/main/java/top/itning/server/shwgateway/filter/AuthorizationHeaderFilter.java b/shw-gateway/src/main/java/top/itning/server/shwgateway/filter/AuthorizationHeaderFilter.java
@@ -25,6 +25,10 @@
 import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.PRE_TYPE;
 
 /**
+ * {@link HttpHeaders#AUTHORIZATION}请求头检查过滤器
+ * 该过滤器检查请求是否包含{@link HttpHeaders#AUTHORIZATION}请求头，并将
+ * 其转换为用户信息，如果转换失败将返回错误视图
+ *
  * @author itning
  * @date 2019/4/29 22:48
  */

diff --git a/shw-gateway/src/main/java/top/itning/server/shwgateway/filter/CorsFilter.java b/shw-gateway/src/main/java/top/itning/server/shwgateway/filter/CorsFilter.java
@@ -14,6 +14,10 @@
 import static org.springframework.http.HttpHeaders.*;
 
 /**
+ * 跨域请求过滤器
+ * 该过滤器过滤{@link HttpMethod#OPTIONS}方法
+ * 返回准许跨域的响应
+ *
  * @author itning
  * @date 2019/5/2 19:57
  */

diff --git a/shw-gateway/src/main/java/top/itning/server/shwgateway/filter/ErrorFilter.java b/shw-gateway/src/main/java/top/itning/server/shwgateway/filter/ErrorFilter.java
@@ -14,6 +14,8 @@
 import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.SEND_ERROR_FILTER_ORDER;
 
 /**
+ * 错误信息过滤
+ *
  * @author itning
  * @date 2019/4/30 2:53
  */

diff --git a/shw-gateway/src/main/java/top/itning/server/shwgateway/handler/ErrorHandler.java b/shw-gateway/src/main/java/top/itning/server/shwgateway/handler/ErrorHandler.java
@@ -13,6 +13,8 @@
 import java.util.Map;
 
 /**
+ * 错误处理器
+ *
  * @author itning
  * @date 2019/5/2 18:49
  */