Support Consul register #1148 (#1174)

* consul client * consul server * consul other clients * fix test case and checking * update config * delete unuse variate
apache · Mar 18, 2021 · 070ede2 · 070ede2
1 parent 8d3dc60
commit 070ede2
Show file tree

Hide file tree

Showing 60 changed files with 956 additions and 164 deletions.
diff --git a/soul-admin/pom.xml b/soul-admin/pom.xml
@@ -62,6 +62,20 @@
             <version>${project.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.dromara</groupId>
+            <artifactId>soul-register-server-consul</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <!--soul consul register start-->
+        <!--<dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
+            <version>2.2.6.RELEASE</version>
+        </dependency>-->
+        <!--soul consul register end-->
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>

diff --git a/soul-admin/src/main/java/org/dromara/soul/admin/config/ConsulServerConfiguration.java b/soul-admin/src/main/java/org/dromara/soul/admin/config/ConsulServerConfiguration.java
@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.dromara.soul.admin.config;
+
+import org.dromara.soul.register.common.config.SoulRegisterCenterConfig;
+import org.dromara.soul.register.server.consul.SoulConsulConfigWatch;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ConditionalOnProperty(prefix = "soul.register", name = "registerType", havingValue = "consul")
+public class ConsulServerConfiguration {
+
+    /**
+     * Register soulConsulConfigWatch for ConsulServerRegisterRepository to monitor metadata.
+     *
+     * @param config the soul register center config
+     * @param publisher the application event publisher
+     * @return the consul config watch
+     */
+    @Bean
+    public SoulConsulConfigWatch soulConsulConfigWatch(final SoulRegisterCenterConfig config, final ApplicationEventPublisher publisher) {
+        return new SoulConsulConfigWatch(config, publisher);
+    }
+}
diff --git a/soul-admin/src/main/resources/application.yml b/soul-admin/src/main/resources/application.yml
@@ -38,8 +38,8 @@ mybatis:
 
 soul:
   register:
-    registerType: http #http #zookeeper #etcd
-    serverLists : #localhost:2181 #http://localhost:2379
+    registerType: http #http #zookeeper #etcd consul
+    serverLists : http://localhost:9095 #localhost:2181 #http://localhost:2379
     props:
       sessionTimeout: 5000
       connectionTimeout: 2000

diff --git a/soul-bootstrap/pom.xml b/soul-bootstrap/pom.xml
@@ -57,6 +57,28 @@
             <version>${project.version}</version>
         </dependency>
 
+        <!--soul tars plugin end-->
+<!--        <dependency>-->
+<!--            <groupId>org.dromara</groupId>-->
+<!--            <artifactId>soul-spring-boot-starter-plugin-tars</artifactId>-->
+<!--            <version>${project.version}</version>-->
+<!--        </dependency>-->
+
+<!--        <dependency>-->
+<!--            <groupId>com.tencent.tars</groupId>-->
+<!--            <artifactId>tars-client</artifactId>-->
+<!--            <version>1.7.2</version>-->
+<!--        </dependency>-->
+        <!--soul tars plugin end-->
+
+        <!--soul grpc plugin start-->
+<!--        <dependency>-->
+<!--            <groupId>org.dromara</groupId>-->
+<!--            <artifactId>soul-spring-boot-starter-plugin-grpc</artifactId>-->
+<!--            <version>${project.version}</version>-->
+<!--        </dependency>-->
+        <!--soul grpc plugin end-->
+
         <!--if you use http proxy end this-->
 
         <!--soul sofa plugin start-->

diff --git a/soul-client/soul-client-core/pom.xml b/soul-client/soul-client-core/pom.xml
@@ -54,5 +54,10 @@
             <artifactId>soul-register-client-etcd</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.dromara</groupId>
+            <artifactId>soul-register-client-consul</artifactId>
+            <version>${project.version}</version>
+        </dependency>
     </dependencies>
 </project>
diff --git a/...main/java/org/dromara/soul/client/alibaba/dubbo/AlibabaDubboServiceBeanPostProcessor.java b/...main/java/org/dromara/soul/client/alibaba/dubbo/AlibabaDubboServiceBeanPostProcessor.java
@@ -22,7 +22,6 @@
 import com.alibaba.dubbo.config.spring.ServiceBean;
 import lombok.extern.slf4j.Slf4j;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.client.dubbo.common.annotation.SoulDubboClient;
 import org.dromara.soul.client.dubbo.common.dto.DubboRpcExt;
 import org.dromara.soul.common.utils.GsonUtils;
@@ -65,7 +64,7 @@ public class AlibabaDubboServiceBeanPostProcessor implements ApplicationListener
 
     private final String appName;
 
-    public AlibabaDubboServiceBeanPostProcessor(final SoulRegisterCenterConfig config) {
+    public AlibabaDubboServiceBeanPostProcessor(final SoulRegisterCenterConfig config, final SoulClientRegisterRepository soulClientRegisterRepository) {
         Properties props = config.getProps();
         String contextPath = props.getProperty("contextPath");
         String appName = props.getProperty("appName");
@@ -75,7 +74,6 @@ public AlibabaDubboServiceBeanPostProcessor(final SoulRegisterCenterConfig confi
         this.contextPath = contextPath;
         this.appName = appName;
         executorService = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>());
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         publisher.start(soulClientRegisterRepository);
     }
 

diff --git a/...c/main/java/org/dromara/soul/client/apache/dubbo/ApacheDubboServiceBeanPostProcessor.java b/...c/main/java/org/dromara/soul/client/apache/dubbo/ApacheDubboServiceBeanPostProcessor.java
@@ -22,7 +22,6 @@
 import org.apache.dubbo.common.utils.StringUtils;
 import org.apache.dubbo.config.spring.ServiceBean;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.client.dubbo.common.annotation.SoulDubboClient;
 import org.dromara.soul.client.dubbo.common.dto.DubboRpcExt;
 import org.dromara.soul.common.utils.GsonUtils;
@@ -65,7 +64,7 @@ public class ApacheDubboServiceBeanPostProcessor implements ApplicationListener<
 
     private String appName;
 
-    public ApacheDubboServiceBeanPostProcessor(final SoulRegisterCenterConfig config) {
+    public ApacheDubboServiceBeanPostProcessor(final SoulRegisterCenterConfig config, final SoulClientRegisterRepository soulClientRegisterRepository) {
         Properties props = config.getProps();
         String contextPath = props.getProperty("contextPath");
         String appName = props.getProperty("appName");
@@ -75,7 +74,6 @@ public ApacheDubboServiceBeanPostProcessor(final SoulRegisterCenterConfig config
         this.contextPath = contextPath;
         this.appName = appName;
         executorService = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>());
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         soulClientRegisterEventPublisher.start(soulClientRegisterRepository);
     }
 

diff --git a/...l-client-grpc/src/main/java/org/dromara/soul/client/grpc/GrpcClientBeanPostProcessor.java b/...l-client-grpc/src/main/java/org/dromara/soul/client/grpc/GrpcClientBeanPostProcessor.java
@@ -20,7 +20,6 @@
 import io.grpc.BindableService;
 import lombok.extern.slf4j.Slf4j;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.client.grpc.common.annotation.SoulGrpcClient;
 import org.dromara.soul.client.grpc.common.dto.GrpcExt;
 import org.dromara.soul.common.utils.GsonUtils;
@@ -69,8 +68,9 @@ public class GrpcClientBeanPostProcessor implements BeanPostProcessor {
      * Instantiates a new Soul client bean post processor.
      *
      * @param config the soul grpc config
+     * @param soulClientRegisterRepository the soulClientRegisterRepository
      */
-    public GrpcClientBeanPostProcessor(final SoulRegisterCenterConfig config) {
+    public GrpcClientBeanPostProcessor(final SoulRegisterCenterConfig config, final SoulClientRegisterRepository soulClientRegisterRepository) {
         Properties props = config.getProps();
         String contextPath = props.getProperty("contextPath");
         String ipAndPort = props.getProperty("ipAndPort");
@@ -83,7 +83,6 @@ public GrpcClientBeanPostProcessor(final SoulRegisterCenterConfig config) {
         this.host = props.getProperty("host");
         this.port = Integer.parseInt(port);
         executorService = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>());
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         publisher.start(soulClientRegisterRepository);
     }
 

diff --git a/...cloud/src/main/java/org/dromara/soul/client/springcloud/init/ContextRegisterListener.java b/...cloud/src/main/java/org/dromara/soul/client/springcloud/init/ContextRegisterListener.java
@@ -17,12 +17,9 @@
 
 package org.dromara.soul.client.springcloud.init;
 
-import java.util.Properties;
-import java.util.concurrent.atomic.AtomicBoolean;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.common.enums.RpcTypeEnum;
 import org.dromara.soul.register.client.api.SoulClientRegisterRepository;
 import org.dromara.soul.register.common.config.SoulRegisterCenterConfig;
@@ -32,6 +29,9 @@
 import org.springframework.core.env.Environment;
 import org.springframework.lang.NonNull;
 
+import java.util.Properties;
+import java.util.concurrent.atomic.AtomicBoolean;
+
 /**
  * The type Context register listener.
  *
@@ -55,8 +55,9 @@ public class ContextRegisterListener implements ApplicationListener<ContextRefre
      *
      * @param config the config
      * @param env    the env
+     * @param soulClientRegisterRepository the soulClientRegisterRepository
      */
-    public ContextRegisterListener(final SoulRegisterCenterConfig config, final Environment env) {
+    public ContextRegisterListener(final SoulRegisterCenterConfig config, final Environment env, final SoulClientRegisterRepository soulClientRegisterRepository) {
         String registerType = config.getRegisterType();
         String serverLists = config.getServerLists();
         Properties props = config.getProps();
@@ -71,7 +72,6 @@ public ContextRegisterListener(final SoulRegisterCenterConfig config, final Envi
         this.env = env;
         this.contextPath = contextPath;
         this.isFull = Boolean.parseBoolean(props.getProperty("isFull", "false"));
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         publisher.start(soulClientRegisterRepository);
     }
 

diff --git a/...ain/java/org/dromara/soul/client/springcloud/init/SpringCloudClientBeanPostProcessor.java b/...ain/java/org/dromara/soul/client/springcloud/init/SpringCloudClientBeanPostProcessor.java
@@ -17,16 +17,9 @@
 
 package org.dromara.soul.client.springcloud.init;
 
-import java.lang.reflect.Method;
-import java.util.Objects;
-import java.util.Properties;
-import java.util.concurrent.LinkedBlockingQueue;
-import java.util.concurrent.ThreadPoolExecutor;
-import java.util.concurrent.TimeUnit;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.client.springcloud.annotation.SoulSpringCloudClient;
 import org.dromara.soul.register.client.api.SoulClientRegisterRepository;
 import org.dromara.soul.register.common.config.SoulRegisterCenterConfig;
@@ -41,6 +34,13 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+import java.lang.reflect.Method;
+import java.util.Objects;
+import java.util.Properties;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
+
 /**
  * The type Soul client bean post processor.
  *
@@ -64,8 +64,9 @@ public class SpringCloudClientBeanPostProcessor implements BeanPostProcessor {
      *
      * @param config the soul spring cloud config
      * @param env    the env
+     * @param soulClientRegisterRepository the soulClientRegisterRepository
      */
-    public SpringCloudClientBeanPostProcessor(final SoulRegisterCenterConfig config, final Environment env) {
+    public SpringCloudClientBeanPostProcessor(final SoulRegisterCenterConfig config, final Environment env, final SoulClientRegisterRepository soulClientRegisterRepository) {
         String registerType = config.getRegisterType();
         String serverLists = config.getServerLists();
         Properties props = config.getProps();
@@ -81,7 +82,6 @@ public SpringCloudClientBeanPostProcessor(final SoulRegisterCenterConfig config,
         this.env = env;
         this.contextPath = contextPath;
         this.isFull = Boolean.parseBoolean(props.getProperty("isFull", "false"));
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         publisher.start(soulClientRegisterRepository);
     }
 

diff --git a/...d/src/test/java/org/dromara/soul/client/springcloud/init/ContextRegisterListenerTest.java b/...d/src/test/java/org/dromara/soul/client/springcloud/init/ContextRegisterListenerTest.java
@@ -17,6 +17,7 @@
 
 package org.dromara.soul.client.springcloud.init;
 
+import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.register.common.config.SoulRegisterCenterConfig;
 import org.junit.FixMethodOrder;
 import org.junit.Test;
@@ -53,7 +54,7 @@ public void testNotFullRegister() {
         mockRegisterCenter.setRegisterType("http");
         mockRegisterCenter.setProps(properties);
         when(env.getProperty("spring.application.name")).thenReturn("spring-cloud-test");
-        ContextRegisterListener contextRegisterListener = new ContextRegisterListener(mockRegisterCenter, env);
+        ContextRegisterListener contextRegisterListener = new ContextRegisterListener(mockRegisterCenter, env, SoulClientRegisterRepositoryFactory.newInstance(mockRegisterCenter));
         ContextRefreshedEvent contextRefreshedEvent = mock(ContextRefreshedEvent.class);
         contextRegisterListener.onApplicationEvent(contextRefreshedEvent);
     }

diff --git a/...java/org/dromara/soul/client/springcloud/init/SpringCloudClientBeanPostProcessorTest.java b/...java/org/dromara/soul/client/springcloud/init/SpringCloudClientBeanPostProcessorTest.java
@@ -17,6 +17,7 @@
 
 package org.dromara.soul.client.springcloud.init;
 
+import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.client.springcloud.annotation.SoulSpringCloudClient;
 import org.dromara.soul.register.client.http.utils.RegisterUtils;
 import org.dromara.soul.register.common.config.SoulRegisterCenterConfig;
@@ -106,7 +107,7 @@ private SpringCloudClientBeanPostProcessor buildSpringCloudClientBeanPostProcess
         mockRegisterCenter.setServerLists("http://127.0.0.1:8080");
         mockRegisterCenter.setRegisterType("http");
         mockRegisterCenter.setProps(properties);
-        return new SpringCloudClientBeanPostProcessor(mockRegisterCenter, env);
+        return new SpringCloudClientBeanPostProcessor(mockRegisterCenter, env, SoulClientRegisterRepositoryFactory.newInstance(mockRegisterCenter));
     }
 
     @RestController

diff --git a/...ringmvc/src/main/java/org/dromara/soul/client/springmvc/init/ContextRegisterListener.java b/...ringmvc/src/main/java/org/dromara/soul/client/springmvc/init/ContextRegisterListener.java
@@ -17,12 +17,9 @@
 
 package org.dromara.soul.client.springmvc.init;
 
-import java.util.Properties;
-import java.util.concurrent.atomic.AtomicBoolean;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.common.enums.RpcTypeEnum;
 import org.dromara.soul.common.utils.IpUtils;
 import org.dromara.soul.register.client.api.SoulClientRegisterRepository;
@@ -32,6 +29,9 @@
 import org.springframework.context.event.ContextRefreshedEvent;
 import org.springframework.lang.NonNull;
 
+import java.util.Properties;
+import java.util.concurrent.atomic.AtomicBoolean;
+
 /**
  * The type Context register listener.
  */
@@ -55,8 +55,10 @@ public class ContextRegisterListener implements ApplicationListener<ContextRefre
     /**
      * Instantiates a new Context register listener.
      *
+     * @param config the config
+     * @param soulClientRegisterRepository the soulClientRegisterRepository
      */
-    public ContextRegisterListener(final SoulRegisterCenterConfig config) {
+    public ContextRegisterListener(final SoulRegisterCenterConfig config, final SoulClientRegisterRepository soulClientRegisterRepository) {
         String registerType = config.getRegisterType();
         String serverLists = config.getServerLists();
         Properties props = config.getProps();
@@ -73,7 +75,6 @@ public ContextRegisterListener(final SoulRegisterCenterConfig config) {
         this.port = port;
         this.contextPath = contextPath;
         this.isFull = Boolean.parseBoolean(props.getProperty("isFull", "false"));
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         publisher.start(soulClientRegisterRepository);
     }
 

diff --git a/...rc/main/java/org/dromara/soul/client/springmvc/init/SpringMvcClientBeanPostProcessor.java b/...rc/main/java/org/dromara/soul/client/springmvc/init/SpringMvcClientBeanPostProcessor.java
@@ -20,7 +20,6 @@
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.dromara.soul.client.core.disruptor.SoulClientRegisterEventPublisher;
-import org.dromara.soul.client.core.register.SoulClientRegisterRepositoryFactory;
 import org.dromara.soul.client.springmvc.annotation.SoulSpringMvcClient;
 import org.dromara.soul.common.utils.IpUtils;
 import org.dromara.soul.register.client.api.SoulClientRegisterRepository;
@@ -66,7 +65,7 @@ public class SpringMvcClientBeanPostProcessor implements BeanPostProcessor {
     /**
      * Instantiates a new Soul client bean post processor.
      */
-    public SpringMvcClientBeanPostProcessor(final SoulRegisterCenterConfig config) {
+    public SpringMvcClientBeanPostProcessor(final SoulRegisterCenterConfig config, final SoulClientRegisterRepository soulClientRegisterRepository) {
         String registerType = config.getRegisterType();
         String serverLists = config.getServerLists();
         Properties props = config.getProps();
@@ -84,7 +83,6 @@ public SpringMvcClientBeanPostProcessor(final SoulRegisterCenterConfig config) {
         this.contextPath = contextPath;
         this.isFull = Boolean.parseBoolean(props.getProperty("isFull", "false"));
         executorService = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>());
-        SoulClientRegisterRepository soulClientRegisterRepository = SoulClientRegisterRepositoryFactory.newInstance(config);
         publisher.start(soulClientRegisterRepository);
     }