添加描述

Author: saleson

spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/BambooRibbonConnectionPoint.java

@@ -1,5 +1,10 @@
 package cn.springcloud.bamboo;
 
+
+/**
+ * 个接口是负责将bamboo跟ribbon连接起来的，将请求的信息， 以及根据业务需要添加的一些路由信息，和获取请求接口的目标版本，
+ * 还有触发执行LoadBanceRequestTrigger等，都是由该接口的实现类DefaultRibbonConnectionPoint负责实现。
+ */
 public interface BambooRibbonConnectionPoint {
 
 
@@ -12,7 +17,6 @@ public interface BambooRibbonConnectionPoint {
 //    void executeBeforeReuqestTrigger();
 
 
-
 //    void executeAfterReuqestTrigger();
 
 }

spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/LoadBalanceRequestTrigger.java

@@ -1,11 +1,32 @@
 package cn.springcloud.bamboo;
 
+/**
+ * Ribbon请求的触发器，在ribbon请求发起时， 会被执行
+ */
 public interface LoadBalanceRequestTrigger {
 
 
+    /**
+     * 判断是否需要执行的方法
+     *
+     * @return
+     */
     boolean shouldExecute();
 
+
+    /**
+     * 请求之前执行
+     *
+     * @param connectPointContext
+     */
     void before(ConnectPointContext connectPointContext);
 
+
+    /**
+     * 请求完成之后执行
+     * 如果出现异常，该方法依然会被执行
+     *
+     * @param connectPointContext
+     */
     void after(ConnectPointContext connectPointContext);
 }

spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/RequestVersionExtractor.java

@@ -1,11 +1,20 @@
 package cn.springcloud.bamboo;
 
+
+/**
+ * 这个接口负责获取请求需要访问的目标接口的版本。
+ * 比如有些接口版本是放在路径上，如:/v1/api/test/get。也有放在uri参数中:/api/test/get?v=1。
+ * 也有可能放到header中，所以在bamboo抽象出来一个接口， 具体的实现由开发者根据业务去实现。
+ */
 public interface RequestVersionExtractor {
 
     String extractVersion(BambooRequest bambooRequest);
 
 
-    class Default implements RequestVersionExtractor{
+    /**
+     * 默认从querystring中获取：/api/test?version=1
+     */
+    class Default implements RequestVersionExtractor {
         private static final String VERSION = "version";
 
         @Override

spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/web/RequestIpKeeper.java

@@ -10,34 +10,33 @@ public final class RequestIpKeeper {
 
     private static RequestIpKeeper INSTANCE = new RequestIpKeeper();
 
-    private RequestIpKeeper(){
+    private RequestIpKeeper() {
 
     }
 
-    public static RequestIpKeeper instance(){
+    public static RequestIpKeeper instance() {
         return INSTANCE;
     }
 
 
-    public void setIp(String ip){
+    void setIp(String ip) {
         ipLocal.set(ip);
     }
 
 
-    public String getIp(){
+    public String getIp() {
         return ipLocal.get();
     }
 
 
-    public void clear(){
+    public void clear() {
         ipLocal.remove();
     }
 
 
-
-    public static String getRequestIp(){
+    public static String getRequestIp() {
         String ip = instance().getIp();
-        if(StringUtils.isEmpty(ip)){
+        if (StringUtils.isEmpty(ip)) {
             ip = BambooAppContext.getLocalIp();
         }
         return ip;

spring-cloud-gray-client/src/main/java/cn/springcloud/gray/client/GrayClientConfig.java

@@ -3,19 +3,49 @@
 public interface GrayClientConfig {
 
 
+    /**
+     * 启动时是否灰度注册
+     *
+     * @return
+     */
     boolean isGrayEnroll();
 
+    /**
+     * 向灰度服务器注册的延迟时间(ms)
+     *
+     * @return
+     */
     int grayEnrollDealyTimeInMs();
 
 
+    /**
+     * 灰度服务器的url
+     *
+     * @return
+     */
     String getServerUrl();
 
 
+    /**
+     * 更新灰度列表的时间间隔(ms)
+     *
+     * @return
+     */
     int getServiceUpdateIntervalTimerInMs();
 
 
+    /**
+     * 在和灰度服务器通信时，如果交互失败，是否重试。
+     *
+     * @return
+     */
     boolean isRetryable();
 
+    /**
+     * 重试次数
+     *
+     * @return
+     */
     int getRetryNumberOfRetries();
 
 }