灰度发布添加对zookeeper的支持

Author: javaerEric

README.md

@@ -21,6 +21,7 @@
 * spring-cloud-start-gray
 * spring-cloud-start-gray-server
 * [spring-cloud-gray-samples](spring-cloud-gray-samples/README.md)
+* [spring-cloud-gray-zookeeper-samples](spring-cloud-gray-zookeeper-samples/README.md)
 
 #### maven 依赖
 jar包已经上传到maven中央库，可以通过maven直接从中央库下载

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

@@ -4,7 +4,6 @@
 import cn.springcloud.bamboo.autoconfig.BambooAutoConfiguration;
 import cn.springcloud.gray.DefaultGrayManager;
 import cn.springcloud.gray.HttpInformationClient;
-import cn.springcloud.gray.InstanceLocalInfo;
 import cn.springcloud.gray.RetryableInformationClient;
 import cn.springcloud.gray.client.GrayClientInitializingBean;
 import cn.springcloud.gray.client.GrayOptionalArgs;
@@ -13,15 +12,12 @@
 import cn.springcloud.gray.core.GrayManager;
 import cn.springcloud.gray.core.InformationClient;
 import cn.springcloud.gray.decision.DefaultGrayDecisionFactory;
-import cn.springcloud.gray.utils.ServiceUtil;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.cloud.client.serviceregistry.Registration;
 import org.springframework.cloud.netflix.ribbon.RibbonClients;
-import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.annotation.Order;
@@ -53,23 +49,6 @@ public GrayClientInitializingBean grayClientInitializingBean() {
         return new GrayClientInitializingBean();
     }
 
-
-    @Bean
-    @ConditionalOnMissingBean
-    public InstanceLocalInfo instanceLocalInfo(@Autowired ApplicationContext context,
-                                               @Autowired Registration registration) {
-        String instanceId = ServiceUtil.getInstanceId(registration);
-        if(null == instanceId){
-            context.getId();
-        }
-
-        InstanceLocalInfo localInfo = new InstanceLocalInfo();
-        localInfo.setInstanceId(instanceId);
-        localInfo.setServiceId(registration.getServiceId());
-        localInfo.setGray(false);
-        return localInfo;
-    }
-
     @Bean
     @ConditionalOnMissingBean
     public GrayDecisionFactory grayDecisionFactory() {

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

@@ -0,0 +1,31 @@
+package cn.springcloud.gray.client.config;
+
+import cn.springcloud.gray.InstanceLocalInfo;
+import com.netflix.discovery.EurekaClient;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.cloud.netflix.eureka.serviceregistry.EurekaRegistration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @Author: duozl
+ * @Date: 2018/6/5 18:18
+ */
+@Configuration
+@ConditionalOnBean(EurekaClient.class)
+public class GrayClientEurekaAutoConfiguration {
+
+    @Bean
+    @ConditionalOnMissingBean
+    public InstanceLocalInfo instanceLocalInfo(@Autowired EurekaRegistration registration) {
+        String instanceId = registration.getInstanceConfig().getInstanceId();
+
+        InstanceLocalInfo localInfo = new InstanceLocalInfo();
+        localInfo.setInstanceId(instanceId);
+        localInfo.setServiceId(registration.getServiceId());
+        localInfo.setGray(false);
+        return localInfo;
+    }
+}

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

@@ -0,0 +1,43 @@
+package cn.springcloud.gray.client.config;
+
+import cn.springcloud.gray.InstanceLocalInfo;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.cloud.client.serviceregistry.Registration;
+import org.springframework.cloud.zookeeper.discovery.ZookeeperDiscoveryProperties;
+import org.springframework.cloud.zookeeper.serviceregistry.ZookeeperRegistration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import javax.naming.ConfigurationException;
+
+/**
+ * @Author: duozl
+ * @Date: 2018/6/5 18:18
+ */
+@Configuration
+@ConditionalOnBean(ZookeeperRegistration.class)
+public class GrayClientZookeeperAutoConfiguration {
+    private static final String METADATA_KEY_INSTANCE_ID = "instanceId";
+
+    @Bean
+    @ConditionalOnMissingBean
+    public InstanceLocalInfo instanceLocalInfo(@Autowired Registration registration,
+                                               @Autowired ZookeeperDiscoveryProperties properties)
+            throws ConfigurationException {
+        String instanceId;
+        if (properties.getMetadata().containsKey(METADATA_KEY_INSTANCE_ID)) {
+            instanceId = properties.getMetadata().get(METADATA_KEY_INSTANCE_ID);
+        } else {
+            throw new ConfigurationException("Unable to find config spring.cloud.zookeeper.discovery.metadata" +
+                    ".instanceId!");
+        }
+
+        InstanceLocalInfo localInfo = new InstanceLocalInfo();
+        localInfo.setInstanceId(instanceId);
+        localInfo.setServiceId(registration.getServiceId());
+        localInfo.setGray(false);
+        return localInfo;
+    }
+}

spring-cloud-gray-client/src/main/java/cn/springcloud/gray/client/config/properties/GrayClientProperties.java

@@ -86,9 +86,10 @@ public void setRetryNumberOfRetries(int retryNumberOfRetries) {
      */
     public class InstanceConfig {
 
-        private boolean grayEnroll;
+        private boolean grayEnroll = false;
         private int grayEnrollDealyTimeInMs = 40000;
         private boolean useMultiVersion = false;
+        private String instanceId;
 
         public boolean isGrayEnroll() {
             return grayEnroll;
@@ -118,5 +119,13 @@ public boolean isUseMultiVersion() {
         public void setUseMultiVersion(boolean useMultiVersion) {
             this.useMultiVersion = useMultiVersion;
         }
+
+        public String getInstanceId() {
+            return instanceId;
+        }
+
+        public void setInstanceId(String instanceId) {
+            this.instanceId = instanceId;
+        }
     }
 }

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

@@ -1,5 +1,6 @@
 package cn.springcloud.gray.ribbon;
 
+import cn.springcloud.bamboo.BambooAppContext;
 import cn.springcloud.bamboo.BambooRequest;
 import cn.springcloud.bamboo.BambooRequestContext;
 import cn.springcloud.gray.core.GrayDecision;
@@ -9,6 +10,7 @@
 import com.netflix.loadbalancer.Server;
 
 import java.util.List;
+import java.util.Map;
 
 public class GrayDecisionPredicate extends AbstractServerPredicate {
 
@@ -22,12 +24,14 @@ public boolean apply(PredicateKey input) {
         if (bambooRequestContext == null || bambooRequestContext.getBambooRequest() == null) {
             return false;
         }
+        BambooRequest bambooRequest = bambooRequestContext.getBambooRequest();
         Server server = input.getServer();
-        String instanceId = ServiceUtil.getInstanceId(server);
+        String serviceId = bambooRequest.getServiceId();
+        Map<String, String> serverMetadata = getServerMetadata(serviceId, server);
+        String instanceId = ServiceUtil.getInstanceId(server, serverMetadata);
 
-        BambooRequest bambooRequest = bambooRequestContext.getBambooRequest();
         List<GrayDecision> grayDecisions =
-                getIRule().getGrayManager().grayDecision(bambooRequest.getServiceId(), instanceId);
+                getIRule().getGrayManager().grayDecision(serviceId, instanceId);
         for (GrayDecision grayDecision : grayDecisions) {
             if (grayDecision.test(bambooRequest)) {
                 return true;
@@ -41,5 +45,7 @@ protected GrayLoadBalanceRule getIRule() {
         return (GrayLoadBalanceRule) this.rule;
     }
 
-
+    public Map<String, String> getServerMetadata(String serviceId, Server server) {
+        return BambooAppContext.getEurekaServerExtractor().getServerMetadata(serviceId, server);
+    }
 }

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

@@ -1,5 +1,6 @@
 package cn.springcloud.gray.ribbon;
 
+import cn.springcloud.bamboo.BambooAppContext;
 import cn.springcloud.bamboo.BambooRequestContext;
 import cn.springcloud.bamboo.ribbon.loadbalancer.BambooZoneAvoidanceRule;
 import cn.springcloud.gray.client.GrayClientAppContext;
@@ -13,6 +14,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 /**
  * 灰度发布的负载规则
@@ -46,13 +48,15 @@ protected void init(){
     public Server choose(Object key) {
         ILoadBalancer lb = getLoadBalancer();
         BambooRequestContext requestContext = BambooRequestContext.currentRequestCentxt();
-        if (requestContext != null && getGrayManager().isOpen(requestContext.getServiceId())) {
-            GrayService grayService = getGrayManager().grayService(requestContext.getServiceId());
+        String serviceId = requestContext.getServiceId();
+        if (requestContext != null && getGrayManager().isOpen(serviceId)) {
+            GrayService grayService = getGrayManager().grayService(serviceId);
             List<Server> servers = lb.getAllServers();
             List<Server> grayServers = new ArrayList<>(grayService.getGrayInstances().size());
             List<Server> normalServers = new ArrayList<>(servers.size() - grayService.getGrayInstances().size());
             for (Server server : servers) {
-                String instanceId = ServiceUtil.getInstanceId(server);
+                Map<String, String> serverMetadata = getServerMetadata(serviceId, server);
+                String instanceId = ServiceUtil.getInstanceId(server, serverMetadata);
                 if (grayService.getGrayInstance(instanceId) != null) {
                     grayServers.add(server);
                 } else {
@@ -98,8 +102,11 @@ private Server choose(AbstractServerPredicate serverPredicate, List<Server> serv
         }
     }
 
-
     public GrayManager getGrayManager() {
         return GrayClientAppContext.getGrayManager();
     }
+
+    public static Map<String, String> getServerMetadata(String serviceId, Server server) {
+        return BambooAppContext.getEurekaServerExtractor().getServerMetadata(serviceId, server);
+    }
 }

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

@@ -1,52 +1,30 @@
 package cn.springcloud.gray.utils;
 
 import com.netflix.loadbalancer.Server;
-import org.apache.curator.x.discovery.ServiceInstance;
-import org.springframework.cloud.client.serviceregistry.Registration;
-import org.springframework.cloud.netflix.eureka.serviceregistry.EurekaRegistration;
-import org.springframework.cloud.zookeeper.discovery.ZookeeperInstance;
 import org.springframework.cloud.zookeeper.discovery.ZookeeperServer;
-import org.springframework.cloud.zookeeper.serviceregistry.ZookeeperRegistration;
+
+import java.util.Map;
 
 /**
  * @Author: duozl
  * @Date: 2018/6/5 15:56
  */
 public class ServiceUtil {
+    private static final String METADATA_KEY_INSTANCE_ID = "instanceId";
 
-    public static String getInstanceId(Server server) {
-        String instanceId;
+    public static String getInstanceId(Server server, Map<String, String> serverMetadata) {
         try {
             if (server instanceof ZookeeperServer) {
-                return server.getHostPort();
-            }
-        } catch (Exception e) {
-            // do nothing，可能是类找不到等原因，如果引入了zookeeper的依赖，这个不会找不到
-        }
-        instanceId = server.getMetaInfo().getInstanceId();
-        return instanceId;
-    }
-
-    public static String getInstanceId(Registration registration) {
-        String instanceId = null;
-        try {
-            if (registration instanceof ZookeeperRegistration) {
-                ServiceInstance<ZookeeperInstance> instance = ((ZookeeperRegistration) registration)
-                        .getServiceInstance();
-                instanceId = instance.getAddress() + ":" + instance.getPort();
+                if (serverMetadata.containsKey(METADATA_KEY_INSTANCE_ID)) {
+                    return serverMetadata.get(METADATA_KEY_INSTANCE_ID);
+                } else {
+                    throw new IllegalStateException("Unable to find config spring.cloud.zookeeper.discovery.metadata" +
+                            ".instanceId!");
+                }
             }
         } catch (Throwable e) {
             // do nothing，可能是类找不到等原因，如果引入了zookeeper的依赖，这个不会找不到
         }
-
-        try {
-            if (registration instanceof EurekaRegistration) {
-                instanceId = ((EurekaRegistration) registration).getInstanceConfig().getInstanceId();
-            }
-        } catch (Throwable e) {
-            // do nothing，可能是类找不到等原因，如果引入了eureka的依赖，这个不会找不到
-        }
-
-        return instanceId;
+        return server.getMetaInfo().getInstanceId();
     }
 }

spring-cloud-gray-samples/spring-cloud-gray-service-a-sample/src/main/resources/config/application.yml

@@ -2,7 +2,7 @@ spring:
   application:
     name: service-a
 server:
-  port: 20101
+  port: 20103
 eureka:
   client:
     register-with-eureka: true
@@ -14,5 +14,5 @@ eureka:
 gray:
   client:
     instance:
-      grayEnroll: false #是否在启动后自动注册成灰度实例
+      grayEnroll: true #是否在启动后自动注册成灰度实例
     serverUrl: http://localhost:20202 #灰度服务端的url