feat(registry): support the option, whether to check the connection …

dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/RegistryFactory.java

@@ -20,6 +20,7 @@
 import org.apache.dubbo.common.extension.Adaptive;
 import org.apache.dubbo.common.extension.SPI;
 
+import static org.apache.dubbo.common.constants.CommonConstants.CHECK_KEY;
 import static org.apache.dubbo.common.constants.CommonConstants.PROTOCOL_KEY;
 import static org.apache.dubbo.common.extension.ExtensionScope.APPLICATION;
 
@@ -47,4 +48,8 @@ public interface RegistryFactory {
      */
     @Adaptive({PROTOCOL_KEY})
     Registry getRegistry(URL url);
+
+    static boolean isCheck(URL url) {
+        return url.getParameter(CHECK_KEY, true) && url.getPort() != 0;
+    }
 }

dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/support/AbstractRegistryFactory.java

@@ -26,7 +26,6 @@
 import org.apache.dubbo.rpc.model.ApplicationModel;
 import org.apache.dubbo.rpc.model.ScopeModelAware;
 
-import static org.apache.dubbo.common.constants.CommonConstants.CHECK_KEY;
 import static org.apache.dubbo.common.constants.CommonConstants.INTERFACE_KEY;
 import static org.apache.dubbo.common.constants.CommonConstants.TIMESTAMP_KEY;
 import static org.apache.dubbo.common.constants.LoggerCodeConstants.REGISTRY_FAILED_CREATE_INSTANCE;
@@ -74,7 +73,7 @@ public Registry getRegistry(URL url) {
 
         String key = createRegistryCacheKey(url);
         Registry registry = null;
-        boolean check = url.getParameter(CHECK_KEY, true) && url.getPort() != 0;
+        boolean check = RegistryFactory.isCheck(url);
 
         // Lock the registry access process to ensure a single instance of the registry
         registryManager.getRegistryLock().lock();

dubbo-registry/dubbo-registry-nacos/src/main/java/org/apache/dubbo/registry/nacos/NacosConnectionManager.java

@@ -60,11 +60,14 @@ public class NacosConnectionManager {
 
     private final boolean check;
 
+    private final Properties nacosProperties;
+
     public NacosConnectionManager(URL connectionURL, boolean check, int retryTimes, int sleepMsBetweenRetries) {
         this.connectionURL = connectionURL;
         this.check = check;
         this.retryTimes = retryTimes;
         this.sleepMsBetweenRetries = sleepMsBetweenRetries;
+        this.nacosProperties = buildNacosProperties(this.connectionURL);
         // create default one
         this.namingServiceList.add(createNamingService());
     }
@@ -78,6 +81,7 @@ protected NacosConnectionManager(NamingService namingService) {
         this.retryTimes = 0;
         this.sleepMsBetweenRetries = 0;
         this.check = false;
+        this.nacosProperties = null;
         // create default one
         this.namingServiceList.add(namingService);
     }
@@ -116,7 +120,7 @@ public synchronized void shutdownAll() {
      * @return {@link NamingService}
      */
     protected NamingService createNamingService() {
-        Properties nacosProperties = buildNacosProperties(this.connectionURL);
+        // Properties nacosProperties = buildNacosProperties(this.connectionURL);
         NamingService namingService = null;
         try {
             for (int i = 0; i < retryTimes + 1; i++) {
@@ -177,6 +181,9 @@ private boolean testNamingService(NamingService namingService) {
 
     private Properties buildNacosProperties(URL url) {
         Properties properties = new Properties();
+        if (StringUtils.isEmpty(url.getHost())) {
+            return properties;
+        }
         setServerAddr(url, properties);
         setProperties(url, properties);
         return properties;

dubbo-registry/dubbo-registry-nacos/src/main/java/org/apache/dubbo/registry/nacos/util/NacosNamingServiceUtils.java

@@ -19,6 +19,7 @@
 import org.apache.dubbo.common.URL;
 import org.apache.dubbo.common.logger.ErrorTypeAwareLogger;
 import org.apache.dubbo.common.logger.LoggerFactory;
+import org.apache.dubbo.registry.RegistryFactory;
 import org.apache.dubbo.registry.client.DefaultServiceInstance;
 import org.apache.dubbo.registry.client.ServiceInstance;
 import org.apache.dubbo.registry.nacos.NacosConnectionManager;
@@ -114,8 +115,17 @@ public static NacosNamingServiceWrapper createNamingService(URL connectionURL) {
         boolean check = connectionURL.getParameter(NACOS_CHECK_KEY, true);
         int retryTimes = connectionURL.getPositiveParameter(NACOS_RETRY_KEY, 10);
         int sleepMsBetweenRetries = connectionURL.getPositiveParameter(NACOS_RETRY_WAIT_KEY, 10);
-        NacosConnectionManager nacosConnectionManager =
-                new NacosConnectionManager(connectionURL, check, retryTimes, sleepMsBetweenRetries);
+        NacosConnectionManager nacosConnectionManager;
+        try {
+            nacosConnectionManager =
+                    new NacosConnectionManager(connectionURL, check, retryTimes, sleepMsBetweenRetries);
+        } catch (IllegalStateException e) {
+            if (RegistryFactory.isCheck(connectionURL)) {
+                throw e;
+            }
+            nacosConnectionManager =
+                    new NacosConnectionManager(connectionURL, false, retryTimes, sleepMsBetweenRetries);
+        }
         return new NacosNamingServiceWrapper(nacosConnectionManager, retryTimes, sleepMsBetweenRetries);
     }
 }

dubbo-registry/dubbo-registry-zookeeper/src/main/java/org/apache/dubbo/registry/zookeeper/ZookeeperServiceDiscovery.java

@@ -23,11 +23,13 @@
 import org.apache.dubbo.common.logger.LoggerFactory;
 import org.apache.dubbo.common.utils.CollectionUtils;
 import org.apache.dubbo.common.utils.ConcurrentHashMapUtils;
+import org.apache.dubbo.registry.RegistryFactory;
 import org.apache.dubbo.registry.client.AbstractServiceDiscovery;
 import org.apache.dubbo.registry.client.ServiceDiscovery;
 import org.apache.dubbo.registry.client.ServiceInstance;
 import org.apache.dubbo.registry.client.event.ServiceInstancesChangedEvent;
 import org.apache.dubbo.registry.client.event.listener.ServiceInstancesChangedListener;
+import org.apache.dubbo.remoting.zookeeper.curator5.ZookeeperClient;
 import org.apache.dubbo.rpc.RpcException;
 import org.apache.dubbo.rpc.model.ApplicationModel;
 
@@ -80,8 +82,19 @@ public class ZookeeperServiceDiscovery extends AbstractServiceDiscovery {
 
     public ZookeeperServiceDiscovery(ApplicationModel applicationModel, URL registryURL) {
         super(applicationModel, registryURL);
+        boolean check = RegistryFactory.isCheck(registryURL);
+        CuratorFramework curatorFramework;
         try {
-            this.curatorFramework = buildCuratorFramework(registryURL, this);
+            try {
+                curatorFramework = buildCuratorFramework(registryURL, this);
+            } catch (IllegalStateException e) {
+                if (check) {
+                    throw e;
+                }
+                curatorFramework = buildCuratorFramework(
+                        registryURL.addParameter(ZookeeperClient.ZOOKEEPER_CHECK_KEY, false), this);
+            }
+            this.curatorFramework = curatorFramework;
             this.rootPath = getRootPath(registryURL);
             this.serviceDiscovery = buildServiceDiscovery(curatorFramework, rootPath);
             this.serviceDiscovery.start();

dubbo-registry/dubbo-registry-zookeeper/src/main/java/org/apache/dubbo/registry/zookeeper/util/CuratorFrameworkUtils.java

@@ -22,6 +22,7 @@
 import org.apache.dubbo.registry.client.ServiceInstance;
 import org.apache.dubbo.registry.zookeeper.ZookeeperInstance;
 import org.apache.dubbo.registry.zookeeper.ZookeeperServiceDiscovery;
+import org.apache.dubbo.remoting.zookeeper.curator5.ZookeeperClient;
 import org.apache.dubbo.rpc.model.ScopeModelUtil;
 
 import java.lang.reflect.Method;
@@ -117,7 +118,8 @@ public List<ACL> getAclForPath(String path) {
             throw new IllegalStateException("zookeeper client initialization failed");
         }
 
-        if (!curatorFramework.getZookeeperClient().isConnected()) {
+        boolean check = connectionURL.getParameter(ZookeeperClient.ZOOKEEPER_CHECK_KEY, true);
+        if (check && !curatorFramework.getZookeeperClient().isConnected()) {
             throw new IllegalStateException("failed to connect to zookeeper server");
         }
 

dubbo-registry/dubbo-registry-zookeeper/src/test/java/org/apache/dubbo/registry/zookeeper/ZookeeperServiceDiscoveryTest.java

@@ -41,6 +41,7 @@
 import org.apache.curator.x.discovery.ServiceDiscoveryBuilder;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -50,6 +51,7 @@
 import org.mockito.internal.util.collections.Sets;
 
 import static java.util.Arrays.asList;
+import static org.apache.dubbo.common.constants.CommonConstants.CHECK_KEY;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
@@ -84,23 +86,20 @@ class ZookeeperServiceDiscoveryTest {
     private ServiceDiscovery mockServiceDiscovery;
     private ServiceCacheBuilder mockServiceCacheBuilder;
     private ServiceCache mockServiceCache;
+    private static final CuratorFrameworkFactory.Builder spyBuilder = spy(CuratorFrameworkFactory.builder());
 
     @BeforeAll
     public static void beforeAll() {
         zookeeperConnectionAddress1 = "zookeeper://localhost:" + "2181";
-    }
-
-    @BeforeEach
-    public void init() throws Exception {
-        // mock begin
-        // create mock bean begin
-        CuratorFrameworkFactory.Builder realBuilder = CuratorFrameworkFactory.builder();
-        CuratorFrameworkFactory.Builder spyBuilder = spy(realBuilder);
         curatorFrameworkFactoryMockedStatic = mockStatic(CuratorFrameworkFactory.class);
         curatorFrameworkFactoryMockedStatic
                 .when(CuratorFrameworkFactory::builder)
                 .thenReturn(spyBuilder);
         serviceDiscoveryBuilderMockedStatic = mockStatic(ServiceDiscoveryBuilder.class);
+    }
+
+    @BeforeEach
+    public void init() throws Exception {
         mockServiceDiscoveryBuilder = mock(ServiceDiscoveryBuilder.class);
         mockServiceDiscovery = mock(ServiceDiscovery.class);
         mockServiceCacheBuilder = mock(ServiceCacheBuilder.class);
@@ -200,6 +199,32 @@ public void onEvent(ServiceInstancesChangedEvent event) {
         assertTrue(serviceInstances.isEmpty());
     }
 
+    @Test
+    void testRegistryCheckConnectDefault() {
+        when(mockCuratorZookeeperClient.isConnected()).thenReturn(false);
+
+        URL registryUrl = URL.valueOf(zookeeperConnectionAddress1);
+        ApplicationModel applicationModel = ApplicationModel.defaultModel();
+        registryUrl.setScopeModel(applicationModel);
+
+        Assertions.assertThrowsExactly(IllegalStateException.class, () -> {
+            new ZookeeperServiceDiscovery(applicationModel, registryUrl);
+        });
+    }
+
+    @Test
+    void testRegistryNotCheckConnect() {
+        when(mockCuratorZookeeperClient.isConnected()).thenReturn(false);
+
+        URL registryUrl = URL.valueOf(zookeeperConnectionAddress1).addParameter(CHECK_KEY, false);
+        ApplicationModel applicationModel = ApplicationModel.defaultModel();
+        registryUrl.setScopeModel(applicationModel);
+
+        Assertions.assertDoesNotThrow(() -> {
+            new ZookeeperServiceDiscovery(applicationModel, registryUrl);
+        });
+    }
+
     @AfterAll
     public static void afterAll() throws Exception {
         if (curatorFrameworkFactoryMockedStatic != null) {

dubbo-registry/dubbo-registry-zookeeper/src/test/java/org/apache/dubbo/registry/zookeeper/util/CuratorFrameworkUtilsTest.java

@@ -21,6 +21,7 @@
 import org.apache.dubbo.registry.client.DefaultServiceInstance;
 import org.apache.dubbo.registry.client.ServiceInstance;
 import org.apache.dubbo.registry.zookeeper.ZookeeperInstance;
+import org.apache.dubbo.remoting.zookeeper.curator5.ZookeeperClient;
 import org.apache.dubbo.rpc.model.ApplicationModel;
 
 import java.util.Arrays;
@@ -109,6 +110,25 @@ void testBuildServiceDiscovery() throws Exception {
         curatorFramework.getZookeeperClient().close();
     }
 
+    @Test
+    void testBuildCuratorFrameworkCheckConnectDefault() {
+        when(mockCuratorZookeeperClient.isConnected()).thenReturn(false);
+        Assertions.assertThrowsExactly(IllegalStateException.class, () -> {
+            CuratorFramework curatorFramework = CuratorFrameworkUtils.buildCuratorFramework(registryUrl, null);
+            curatorFramework.getZookeeperClient().close();
+        });
+    }
+
+    @Test
+    void testBuildCuratorFrameworkNotCheckConnect() {
+        when(mockCuratorZookeeperClient.isConnected()).thenReturn(false);
+        URL url = registryUrl.addParameter(ZookeeperClient.ZOOKEEPER_CHECK_KEY, false);
+        Assertions.assertDoesNotThrow(() -> {
+            CuratorFramework curatorFramework = CuratorFrameworkUtils.buildCuratorFramework(url, null);
+            curatorFramework.getZookeeperClient().close();
+        });
+    }
+
     @Test
     void testBuild() {
         ServiceInstance dubboServiceInstance =

dubbo-remoting/dubbo-remoting-zookeeper-curator5/src/main/java/org/apache/dubbo/remoting/zookeeper/curator5/Curator5ZookeeperClient.java

@@ -96,8 +96,8 @@ public List<ACL> getAclForPath(String path) {
             client.getConnectionStateListenable().addListener(new CuratorConnectionStateListener(url));
             client.start();
             boolean connected = client.blockUntilConnected(timeout, TimeUnit.MILLISECONDS);
-
-            if (!connected) {
+            boolean check = url.getParameter(ZOOKEEPER_CHECK_KEY, true);
+            if (check && !connected) {
                 IllegalStateException illegalStateException =
                         new IllegalStateException("zookeeper not connected, the address is: " + url);
 

dubbo-remoting/dubbo-remoting-zookeeper-curator5/src/main/java/org/apache/dubbo/remoting/zookeeper/curator5/ZookeeperClient.java

@@ -26,6 +26,7 @@
  * Common abstraction of Zookeeper client.
  */
 public interface ZookeeperClient {
+    String ZOOKEEPER_CHECK_KEY = "zookeeper.check";
 
     /**
      * Create ZNode in Zookeeper.

dubbo-remoting/dubbo-remoting-zookeeper-curator5/src/main/java/org/apache/dubbo/remoting/zookeeper/curator5/ZookeeperClientManager.java

@@ -31,6 +31,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
+import static org.apache.dubbo.common.constants.CommonConstants.CHECK_KEY;
 import static org.apache.dubbo.common.constants.CommonConstants.TIMEOUT_KEY;
 import static org.apache.dubbo.common.constants.LoggerCodeConstants.TRANSPORT_FAILED_DESTROY_ZOOKEEPER;
 
@@ -85,8 +86,17 @@ public ZookeeperClient connect(URL url) {
                 logger.info("find valid zookeeper client from the cache for address: " + url);
                 return zookeeperClient;
             }
+            boolean check = url.getParameter(CHECK_KEY, true) && url.getPort() != 0;
 
-            zookeeperClient = new Curator5ZookeeperClient(url);
+            try {
+                zookeeperClient = new Curator5ZookeeperClient(url);
+            } catch (IllegalStateException e) {
+                if (check) {
+                    throw e;
+                }
+                zookeeperClient =
+                        new Curator5ZookeeperClient(url.addParameter(ZookeeperClient.ZOOKEEPER_CHECK_KEY, false));
+            }
             logger.info("No valid zookeeper client found from cache, therefore create a new client for url. " + url);
             writeToClientMap(addressList, zookeeperClient);
         }