add zookeeper service discovery support(#3557)

apollo-adminservice/pom.xml

@@ -175,6 +175,16 @@
 				</dependency>
 			</dependencies>
 		</profile>
+		<profile>
+			<id>zookeeper-discovery</id>
+			<dependencies>
+				<!-- zookeeper discovery -->
+				<dependency>
+					<groupId>org.springframework.cloud</groupId>
+					<artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
+				</dependency>
+			</dependencies>
+		</profile>
 	</profiles>
 
 </project>

apollo-adminservice/src/main/resources/application-zookeeper-discovery.properties

@@ -0,0 +1,23 @@
+#
+# Copyright 2021 Apollo Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+apollo.eureka.server.enabled=false
+eureka.client.enabled=false
+
+#zookeeper enabled
+spring.cloud.zookeeper.enabled=true
+spring.cloud.zookeeper.discovery.enabled=true
+spring.cloud.zookeeper.discovery.register=true
+spring.cloud.zookeeper.discovery.instance-id=${spring.cloud.client.ip-address}:${server.port}

apollo-configservice/pom.xml

@@ -185,6 +185,16 @@
 				</dependency>
 			</dependencies>
 		</profile>
+		<profile>
+			<id>zookeeper-discovery</id>
+			<dependencies>
+				<!-- zookeeper discovery -->
+				<dependency>
+					<groupId>org.springframework.cloud</groupId>
+					<artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
+				</dependency>
+			</dependencies>
+		</profile>
 	</profiles>
 
 </project>

apollo-configservice/src/main/java/com/ctrip/framework/apollo/metaservice/controller/HomePageController.java

@@ -29,7 +29,7 @@
 /**
  * For non-eureka discovery services such as kubernetes and nacos, there is no eureka home page, so we need to add a default one
  */
-@Profile({"kubernetes", "nacos-discovery", "consul-discovery"})
+@Profile({"kubernetes", "nacos-discovery", "consul-discovery", "zookeeper-discovery"})
 @RestController
 public class HomePageController {
   private final DiscoveryService discoveryService;

apollo-configservice/src/main/java/com/ctrip/framework/apollo/metaservice/service/DefaultDiscoveryService.java

@@ -33,7 +33,7 @@
  * Default discovery service for Eureka
  */
 @Service
-@ConditionalOnMissingProfile({"kubernetes", "nacos-discovery", "consul-discovery"})
+@ConditionalOnMissingProfile({"kubernetes", "nacos-discovery", "consul-discovery", "zookeeper-discovery"})
 public class DefaultDiscoveryService implements DiscoveryService {
 
   private final EurekaClient eurekaClient;

apollo-configservice/src/main/java/com/ctrip/framework/apollo/metaservice/service/ZookeeperDiscoveryService.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2021 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.metaservice.service;
+
+import java.util.Collections;
+import java.util.List;
+
+import com.ctrip.framework.apollo.core.dto.ServiceDTO;
+import com.ctrip.framework.apollo.tracer.Tracer;
+import com.google.common.collect.Lists;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.cloud.client.ServiceInstance;
+import org.springframework.cloud.client.discovery.DiscoveryClient;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+import org.springframework.util.CollectionUtils;
+
+/**
+ * Service discovery zookeeper implementation
+ */
+@Service
+@Profile({"zookeeper-discovery"})
+@ConditionalOnClass(name = {"org.springframework.cloud.zookeeper.discovery.ZookeeperDiscoveryClient"})
+public class ZookeeperDiscoveryService implements DiscoveryService {
+
+	private final DiscoveryClient discoveryClient;
+
+	public ZookeeperDiscoveryService(DiscoveryClient discoveryClient) {
+		this.discoveryClient = discoveryClient;
+	}
+
+	@Override
+	public List<ServiceDTO> getServiceInstances(String serviceId) {
+
+		if (discoveryClient == null || CollectionUtils.isEmpty(discoveryClient.getInstances(serviceId))) {
+			Tracer.logEvent("Apollo.Discovery.NotFound", serviceId);
+			return Collections.emptyList();
+		}
+
+		List<ServiceDTO> serviceDTOList = Lists.newLinkedList();
+		discoveryClient.getInstances(serviceId).forEach(instance -> {
+			ServiceDTO serviceDTO = this.toServiceDTO(instance, serviceId);
+			serviceDTOList.add(serviceDTO);
+		});
+
+		return serviceDTOList;
+	}
+
+	private ServiceDTO toServiceDTO(ServiceInstance instance, String appName) {
+		ServiceDTO service = new ServiceDTO();
+		service.setAppName(appName);
+		service.setInstanceId(instance.getInstanceId());
+		String homePageUrl = "http://" + instance.getHost() + ":" + instance.getPort() + "/";
+		service.setHomepageUrl(homePageUrl);
+		return service;
+	}
+}

apollo-configservice/src/main/resources/application-zookeeper-discovery.properties

@@ -0,0 +1,23 @@
+#
+# Copyright 2021 Apollo Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+apollo.eureka.server.enabled=false
+eureka.client.enabled=false
+
+#zookeeper enabled
+spring.cloud.zookeeper.enabled=true
+spring.cloud.zookeeper.discovery.enabled=true
+spring.cloud.zookeeper.discovery.register=true
+spring.cloud.zookeeper.discovery.instance-id=${spring.cloud.client.ip-address}:${server.port}

apollo-configservice/src/test/java/com/ctrip/framework/apollo/metaservice/service/ZookeeperDiscoveryServiceTest.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2021 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.metaservice.service;
+
+import java.util.List;
+
+import com.ctrip.framework.apollo.core.dto.ServiceDTO;
+import com.google.common.collect.Lists;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import org.springframework.cloud.client.ServiceInstance;
+import org.springframework.cloud.client.discovery.DiscoveryClient;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class ZookeeperDiscoveryServiceTest {
+
+    @Mock
+    private DiscoveryClient zookeeperDiscoveryClient;
+
+    private ZookeeperDiscoveryService zookeeperDiscoveryService;
+
+    private String someServiceId;
+
+    @Before
+    public void setUp() throws Exception {
+        zookeeperDiscoveryService = new ZookeeperDiscoveryService(zookeeperDiscoveryClient);
+        someServiceId = "someServiceId";
+    }
+
+    @Test
+    public void testGetServiceInstancesWithEmptyInstances() {
+        when(zookeeperDiscoveryClient.getInstances(someServiceId)).thenReturn(null);
+        assertTrue(zookeeperDiscoveryService.getServiceInstances(someServiceId).isEmpty());
+    }
+
+    @Test
+    public void testGetServiceInstances() {
+        String someIp = "1.2.3.4";
+        int somePort = 8080;
+        String someInstanceId = "someInstanceId";
+        ServiceInstance someServiceInstance = mockServiceInstance(someInstanceId, someIp, somePort);
+
+        when(zookeeperDiscoveryClient.getInstances(someServiceId)).thenReturn(
+                Lists.newArrayList(someServiceInstance));
+
+        List<ServiceDTO> serviceDTOList = zookeeperDiscoveryService.getServiceInstances(someServiceId);
+        ServiceDTO serviceDTO = serviceDTOList.get(0);
+        assertEquals(1, serviceDTOList.size());
+        assertEquals(someServiceId, serviceDTO.getAppName());
+        assertEquals("http://1.2.3.4:8080/", serviceDTO.getHomepageUrl());
+
+    }
+
+    private ServiceInstance mockServiceInstance(String instanceId, String ip, int port) {
+        ServiceInstance serviceInstance = mock(ServiceInstance.class);
+        when(serviceInstance.getInstanceId()).thenReturn(instanceId);
+        when(serviceInstance.getHost()).thenReturn(ip);
+        when(serviceInstance.getPort()).thenReturn(port);
+
+        return serviceInstance;
+    }
+
+}

docs/zh/deployment/distributed-deployment-guide.md

@@ -512,6 +512,23 @@ spring.cloud.consul.host=127.0.0.1
 spring.cloud.consul.port=8500
 ```
 
+##### 2.2.1.2.9 启用外部Zookeeper服务注册中心替换内置eureka
+1. 修改build.sh/build.bat，将`config-service`和`admin-service`的maven编译命令更改为
+```shell
+mvn clean package -Pgithub,zookeeper-discovery -DskipTests -pl apollo-configservice,apollo-adminservice -am -Dapollo_profile=github,zookeeper-discovery -Dspring_datasource_url=$apollo_config_db_url -Dspring_datasource_username=$apollo_config_db_username -Dspring_datasource_password=$apollo_config_db_password
+```
+2. 分别修改apollo-configservice和apollo-adminservice安装包中config目录下的application-github.properties，配置zookeeper服务器地址
+```properties
+spring.cloud.zookeeper.connect-string=127.0.0.1:2181
+```
+3.本地调试
+- 修改maven`profiles`项,需要在profiles中将`zookeeper-discovery`项勾选
+
+- 分别修改`apollo-configservice`和`apollo-adminservice`服务对应的`VM options`,激活`zookeeper-discovery`的`profile`
+```properties
+-Dapollo_profile=github,zookeeper-discovery
+```
+
 ### 2.2.2 部署Apollo服务端
 
 #### 2.2.2.1 部署apollo-configservice

pom.xml

@@ -670,6 +670,51 @@
 				</dependencies>
 			</dependencyManagement>
 		</profile>
+		<profile>
+			<id>zookeeper-discovery</id>
+			<properties>
+				<apache.curator.version>4.2.0</apache.curator.version>
+				<apache.zookeeper.version>3.4.14</apache.zookeeper.version>
+			</properties>
+			<dependencyManagement>
+				<dependencies>
+					<!-- apache curator -->
+					<dependency>
+						<groupId>org.apache.curator</groupId>
+						<artifactId>curator-x-discovery</artifactId>
+						<version>${apache.curator.version}</version>
+					</dependency>
+					<dependency>
+						<groupId>org.apache.curator</groupId>
+						<artifactId>curator-recipes</artifactId>
+						<version>${apache.curator.version}</version>
+					</dependency>
+					<dependency>
+						<groupId>org.apache.curator</groupId>
+						<artifactId>curator-framework</artifactId>
+						<version>${apache.curator.version}</version>
+					</dependency>
+					<!-- apache curator end -->
+					<!-- zookeeper -->
+					<dependency>
+						<groupId>org.apache.zookeeper</groupId>
+						<artifactId>zookeeper</artifactId>
+						<version>${apache.zookeeper.version}</version>
+						<exclusions>
+							<exclusion>
+								<groupId>log4j</groupId>
+								<artifactId>log4j</artifactId>
+							</exclusion>
+							<exclusion>
+								<groupId>org.slf4j</groupId>
+								<artifactId>slf4j-log4j12</artifactId>
+							</exclusion>
+						</exclusions>
+					</dependency>
+					<!-- zookeeper end -->
+				</dependencies>
+			</dependencyManagement>
+		</profile>
 		<profile>
 			<id>release</id>
 			<build>