添加注释

sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/zuul/configuration/BaseZuulConfiguration.java

@@ -36,26 +36,31 @@ public class BaseZuulConfiguration {
     @Autowired
     protected RouteManager apiMetaManager;
 
-    @Bean
-    SopRouteLocator sopRouteLocator(ZuulRouteRepository zuulRouteRepository) {
-        return new SopRouteLocator(zuulRouteRepository);
-    }
-
-    @Bean
-    ZuulZookeeperRouteManager zuulZookeeperRouteManager(Environment environment, ZuulRouteRepository zuulRouteRepository) {
-        return new ZuulZookeeperRouteManager(environment, zuulRouteRepository);
-    }
-
+    /**
+     * 路由存储
+     * @return
+     */
     @Bean
     ZuulRouteRepository zuulRouteRepository() {
         return new ZuulRouteRepository();
     }
 
+    /**
+     * 路由获取
+     * @param zuulRouteRepository
+     * @return
+     */
     @Bean
-    PreValidateFilter preValidateFilter() {
-        return new PreValidateFilter();
+    SopRouteLocator sopRouteLocator(ZuulRouteRepository zuulRouteRepository) {
+        return new SopRouteLocator(zuulRouteRepository);
     }
 
+    /**
+     * 选取路由
+     * @param zuulRouteRepository
+     * @param proxyRequestHelper
+     * @return
+     */
     @Bean
     public PreDecorationFilter preDecorationFilter(ZuulRouteRepository zuulRouteRepository, ProxyRequestHelper proxyRequestHelper) {
         SopRouteLocator routeLocator = new SopRouteLocator(zuulRouteRepository);
@@ -65,16 +70,48 @@ public class BaseZuulConfiguration {
                 proxyRequestHelper);
     }
 
+    /**
+     * 路由管理
+     * @param environment
+     * @param zuulRouteRepository
+     * @return
+     */
+    @Bean
+    ZuulZookeeperRouteManager zuulZookeeperRouteManager(Environment environment, ZuulRouteRepository zuulRouteRepository) {
+        return new ZuulZookeeperRouteManager(environment, zuulRouteRepository);
+    }
+
+    /**
+     * 前置校验
+     * @return
+     */
+    @Bean
+    PreValidateFilter preValidateFilter() {
+        return new PreValidateFilter();
+    }
+
+    /**
+     * 错误处理扩展
+     * @return
+     */
     @Bean
     ErrorFilter errorFilter() {
         return new ErrorFilter();
     }
 
+    /**
+     * 结果返回
+     * @return
+     */
     @Bean
     PostResultFilter postResultFilter() {
         return new PostResultFilter();
     }
 
+    /**
+     * 统一错误处理
+     * @return
+     */
     @Bean
     ZuulErrorController baseZuulController() {
         return ApiContext.getApiConfig().getZuulErrorController();

sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/zuul/route/SopRouteLocator.java

@@ -1,6 +1,5 @@
 package com.gitee.sop.gatewaycommon.zuul.route;
 
-import com.gitee.sop.gatewaycommon.manager.RouteRepository;
 import com.gitee.sop.gatewaycommon.param.ApiParam;
 import com.gitee.sop.gatewaycommon.zuul.ZuulContext;
 import org.springframework.cloud.netflix.zuul.filters.Route;
@@ -12,6 +11,7 @@ import java.util.Collections;
 import java.util.List;
 
 /**
+ * 路由定位
  * @author tanghc
  */
 public class SopRouteLocator implements RouteLocator, Ordered {
@@ -32,6 +32,11 @@ public class SopRouteLocator implements RouteLocator, Ordered {
         return zuulRouteRepository.listAll();
     }
 
+    /**
+     * 这里决定使用哪个路由
+     * @param path
+     * @return
+     */
     @Override
     public Route getMatchingRoute(String path) {
         ApiParam param = ZuulContext.getApiParam();

sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/zuul/route/ZuulRouteRepository.java

@@ -11,6 +11,7 @@ import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
+ * 本地存放路由内容的地方
  * @author tanghc
  */
 public class ZuulRouteRepository implements RouteRepository<ZuulServiceRouteInfo, Route> {

sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/zuul/route/ZuulZookeeperRouteManager.java

@@ -8,6 +8,7 @@ import org.springframework.cloud.netflix.zuul.filters.Route;
 import org.springframework.core.env.Environment;
 
 /**
+ * 路由内容管理，新增活修改路由
  * @author tanghc
  */
 @Slf4j