devbox
weixin_40725706
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

【Nacos】微服务注册在不同的group上，支持跨group服务发现，二次开发

作者：weixin_40725706 | 2024-07-30 04:44:08

赞

踩

【Nacos】微服务注册在不同的group上，支持跨group服务发现，二次开发

        Nacos具备微服务注册和发现，以及配置管理的功能，本文详情描述【注册和发现】的原理，以及基本使用，包括如何进行跨group注册和发现。

一、Nacos配置

  1. spring:
  2.   cloud:
  3.     nacos:
  4.       discovery:
  5.         server-addr: nacosIP地址:8849
  6.         namespace: dev
  7.         group: Product
  8.       config:
  9.         server-addr: nacosIP地址:8849
  10.         namespace: dev
  11.         group: Product
  12.         file-extension: yaml
  13.         refresh-enabled: true
  14.         enable-remote-sync-config: true
  15.         name: product.yaml
  1. spring:
  2.   cloud:
  3.     nacos:
  4.       discovery:
  5.         server-addr: nacosIP地址:8849
  6.         namespace: dev
  7.         group: Order
  8.       config:
  9.         server-addr: nacosIP地址:8849
  10.         namespace: dev
  11.         group: Order
  12.         file-extension: yaml
  13.         refresh-enabled: true
  14.         enable-remote-sync-config: true
  15.         name: order.yaml
  16.         extension-configs:
  17.           - data-id: config-global.yaml
  18.             group: Order
  19.             refresh: true
一、NacosServiceDiscovery 中 getInstances 获取注册在nacos上的服务实例清单

  1. public List<ServiceInstance> getInstances(String serviceId) throws NacosException {
  2.     String group = this.discoveryProperties.getGroup();
  3.     List<Instance> instances = this.namingService().selectInstances(serviceId, group, true);
  4.     return hostToServiceInstanceList(instances, serviceId);
  5. }

  但是原始功能不支持跨group服务发现，所以我们需要重写 getInstances方法。

二、NacosServiceDiscoveryV2 继承 NacosServiceDiscovery，并重写 getInstances

  1. import com.alibaba.cloud.nacos.NacosServiceInstance;
  2. import com.alibaba.cloud.nacos.NacosServiceManager;
  3. import com.alibaba.cloud.nacos.discovery.NacosServiceDiscovery;
  4. import com.alibaba.nacos.api.exception.NacosException;
  5. import com.alibaba.nacos.api.naming.NamingService;
  6. import com.alibaba.nacos.api.naming.pojo.Instance;
  7. import com.alibaba.nacos.api.naming.pojo.ListView;
  8. import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
  9. import org.springframework.cloud.client.ServiceInstance;
  10.  
  11. import java.util.*;
  12.  
  13. import static com.baomidou.mybatisplus.core.toolkit.CollectionUtils.isEmpty;
  14. import static java.util.Objects.isNull;
  15.  
  16. /**
  17.  * @description: naocs服务发现重写
  18.  */
  19. public class NacosServiceDiscoveryV2 extends NacosServiceDiscovery {
  20.  
  21.     private final NacosDiscoveryPropertiesV2 discoveryProperties;
  22.  
  23.     private final NacosShareProperties nacosShareProperties;
  24.  
  25.     private final NacosServiceManager nacosServiceManager;
  26.  
  27.     public NacosServiceDiscoveryV2(NacosDiscoveryPropertiesV2 discoveryProperties, NacosShareProperties nacosShareProperties, NacosServiceManager nacosServiceManager) {
  28.         super(discoveryProperties, nacosServiceManager);
  29.         this.discoveryProperties = discoveryProperties;
  30.         this.nacosShareProperties = nacosShareProperties;
  31.         this.nacosServiceManager = nacosServiceManager;
  32.     }
  33.  
  34.     /**
  35.      * Return all instances for the given service.
  36.      * @param serviceId id of service
  37.      * @return list of instances
  38.      * @throws NacosException nacosException
  39.      */
  40.     @Override
  41.     public List<ServiceInstance> getInstances(String serviceId) throws NacosException {
  42.         String group = discoveryProperties.getGroup();
  43.         List<Instance> instances = discoveryProperties.namingServiceInstance()
  44.                 .selectInstances(serviceId, group, true);
  45.         if (isEmpty(instances)) {
  46.             Map<String, Set<String>> namespaceGroupMap = nacosShareProperties.getNamespaceGroupMap();
  47.             Map<String, NamingService> namespace2NamingServiceMap = discoveryProperties.shareNamingServiceInstances();
  48.             for (Map.Entry<String, NamingService> entry : namespace2NamingServiceMap.entrySet()) {
  49.                 String namespace;
  50.                 NamingService namingService;
  51.                 if (isNull(namespace = entry.getKey()) || isNull(namingService = entry.getValue()))
  52.                     continue;
  53.                 Set<String> groupNames = namespaceGroupMap.get(namespace);
  54.                 List<Instance> shareInstances;
  55.                 if (isEmpty(groupNames)) {
  56.                     shareInstances = namingService.selectInstances(serviceId, group, true);
  57.                     if (CollectionUtils.isNotEmpty(shareInstances))
  58.                         break;
  59.                 } else {
  60.                     shareInstances = new ArrayList<>();
  61.                     for (String groupName : groupNames) {
  62.                         List<Instance> subShareInstances = namingService.selectInstances(serviceId, groupName, true);
  63.                         if (CollectionUtils.isNotEmpty(subShareInstances)) {
  64.                             shareInstances.addAll(subShareInstances);
  65.                         }
  66.                     }
  67.                 }
  68.                 if (CollectionUtils.isNotEmpty(shareInstances)) {
  69.                     instances = shareInstances;
  70.                     break;
  71.                 }
  72.             }
  73.         }
  74.         return hostToServiceInstanceList(instances, serviceId);
  75.     }
  76.  
  77.     /**
  78.      * Return the names of all services.
  79.      * @return list of service names
  80.      * @throws NacosException nacosException
  81.      */
  82.     public List<String> getServices() throws NacosException {
  83.         String group = discoveryProperties.getGroup();
  84.         ListView<String> services = discoveryProperties.namingServiceInstance()
  85.                 .getServicesOfServer(1, Integer.MAX_VALUE, group);
  86.         return services.getData();
  87.     }
  88.  
  89.     public static List<ServiceInstance> hostToServiceInstanceList(
  90.             List<Instance> instances, String serviceId) {
  91.         List<ServiceInstance> result = new ArrayList<>(instances.size());
  92.         for (Instance instance : instances) {
  93.             ServiceInstance serviceInstance = hostToServiceInstance(instance, serviceId);
  94.             if (serviceInstance != null) {
  95.                 result.add(serviceInstance);
  96.             }
  97.         }
  98.         return result;
  99.     }
  100.  
  101.     public static ServiceInstance hostToServiceInstance(Instance instance,
  102.                                                         String serviceId) {
  103.         if (instance == null || !instance.isEnabled() || !instance.isHealthy()) {
  104.             return null;
  105.         }
  106.         NacosServiceInstance nacosServiceInstance = new NacosServiceInstance();
  107.         nacosServiceInstance.setHost(instance.getIp());
  108.         nacosServiceInstance.setPort(instance.getPort());
  109.         nacosServiceInstance.setServiceId(serviceId);
  110.  
  111.         Map<String, String> metadata = new HashMap<>();
  112.         metadata.put("nacos.instanceId", instance.getInstanceId());
  113.         metadata.put("nacos.weight", instance.getWeight() + "");
  114.         metadata.put("nacos.healthy", instance.isHealthy() + "");
  115.         metadata.put("nacos.cluster", instance.getClusterName() + "");
  116.         metadata.putAll(instance.getMetadata());
  117.         nacosServiceInstance.setMetadata(metadata);
  118.  
  119.         if (metadata.containsKey("secure")) {
  120.             boolean secure = Boolean.parseBoolean(metadata.get("secure"));
  121.             nacosServiceInstance.setSecure(secure);
  122.         }
  123.         return nacosServiceInstance;
  124.     }
  125.  
  126.     private NamingService namingService() {
  127.         return nacosServiceManager
  128.                 .getNamingService(discoveryProperties.getNacosProperties());
  129.     }
  130. }

原理：

1、根据 serviceId 和 group 获取当前实例

2、获取所有group清单，并根据group找到group下所有实例

3、将group清单，加入到自己的实例清单中。

三、NacosDiscoveryPropertiesV2 继承 NacosDiscoveryProperties，服务发现属性重写 shareNamingServiceInstances、getNacosProperties方法

  1. import com.alibaba.cloud.nacos.NacosDiscoveryProperties;
  2. import com.alibaba.nacos.api.NacosFactory;
  3. import com.alibaba.nacos.api.naming.NamingService;
  4. import com.alibaba.nacos.client.naming.utils.UtilAndComs;
  5. import org.slf4j.Logger;
  6. import org.slf4j.LoggerFactory;
  7.  
  8. import java.util.*;
  9. import java.util.concurrent.ConcurrentHashMap;
  10. import java.util.function.Function;
  11. import java.util.function.Predicate;
  12.  
  13. import static com.alibaba.nacos.api.PropertyKeyConst.*;
  14. import static java.util.Objects.nonNull;
  15.  
  16. /**
  17.  * @description: naocs服务发现属性重写
  18.  */
  19. public class NacosDiscoveryPropertiesV2 extends NacosDiscoveryProperties {
  20.  
  21.     private static final Logger log = LoggerFactory.getLogger(NacosDiscoveryPropertiesV2.class);
  22.  
  23.     private final NacosShareProperties nacosShareProperties;
  24.  
  25.     private static final Map<String, NamingService> NAMESPACE_TO_NAMING_SERVICE_MAP = new ConcurrentHashMap<>();
  26.  
  27.     public NacosDiscoveryPropertiesV2(NacosShareProperties nacosShareProperties) {
  28.         super();
  29.         this.nacosShareProperties = nacosShareProperties;
  30.     }
  31.  
  32.     public Map<String, NamingService> shareNamingServiceInstances() {
  33.         if (!NAMESPACE_TO_NAMING_SERVICE_MAP.isEmpty()) {
  34.             return new HashMap<>(NAMESPACE_TO_NAMING_SERVICE_MAP);
  35.         }
  36.         List<NacosShareProperties.NacosShareEntity> entities = Optional.ofNullable(nacosShareProperties)
  37.                 .map(NacosShareProperties::getEntities).orElse(Collections.emptyList());
  38.         entities.stream().filter(entity -> nonNull(entity) && nonNull(entity.getNamespace()))
  39.                 .filter(distinctByKey(NacosShareProperties.NacosShareEntity::getNamespace))
  40.                 .forEach(entity -> {
  41.                     try {
  42.                         NamingService namingService = NacosFactory.createNamingService(getNacosProperties(entity.getNamespace()));
  43.                         if (namingService != null) {
  44.                             NAMESPACE_TO_NAMING_SERVICE_MAP.put(entity.getNamespace(), namingService);
  45.                         }
  46.                     } catch (Exception e) {
  47.                         log.error("create naming service error! properties={}, e=", this, e);
  48.                     }
  49.                 });
  50.         return new HashMap<>(NAMESPACE_TO_NAMING_SERVICE_MAP);
  51.     }
  52.     private static <T> Predicate<T> distinctByKey(Function<? super T, ?> keyExtractor) {
  53.         Map<Object, Boolean> seen = new ConcurrentHashMap<>();
  54.         return t -> seen.putIfAbsent(keyExtractor.apply(t), Boolean.TRUE) == null;
  55.     }
  56.  
  57.     private Properties getNacosProperties(String namespace) {
  58.         Properties properties = new Properties();
  59.         properties.put(SERVER_ADDR, getServerAddr());
  60.         properties.put(USERNAME, Objects.toString(getUsername(), ""));
  61.         properties.put(PASSWORD, Objects.toString(getPassword(), ""));
  62.         properties.put(NAMESPACE, namespace);
  63.         properties.put(UtilAndComs.NACOS_NAMING_LOG_NAME, getLogName());
  64.         String endpoint = getEndpoint();
  65.         if (endpoint.contains(":")) {
  66.             int index = endpoint.indexOf(":");
  67.             properties.put(ENDPOINT, endpoint.substring(0, index));
  68.             properties.put(ENDPOINT_PORT, endpoint.substring(index + 1));
  69.         }
  70.         else {
  71.             properties.put(ENDPOINT, endpoint);
  72.         }
  73.  
  74.         properties.put(ACCESS_KEY, getAccessKey());
  75.         properties.put(SECRET_KEY, getSecretKey());
  76.         properties.put(CLUSTER_NAME, getClusterName());
  77.         properties.put(NAMING_LOAD_CACHE_AT_START, getNamingLoadCacheAtStart());
  78.  
  79. //        enrichNacosDiscoveryProperties(properties);
  80.         return properties;
  81.     }
  82. }

四、共享share属性类 NacosShareProperties

  1. import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
  2. import org.springframework.boot.context.properties.ConfigurationProperties;
  3. import org.springframework.context.annotation.Configuration;
  4.  
  5. import java.util.*;
  6. import java.util.concurrent.ConcurrentHashMap;
  7.  
  8. import static java.util.Objects.nonNull;
  9.  
  10. /**
  11.  * <pre>
  12.  *  @description: 共享nacos属性
  13.  *  </pre>
  14.  */
  15. @Configuration
  16. @ConfigurationProperties(prefix = "nacos.share")
  17. public class NacosShareProperties {
  18.  
  19.     private final Map<String, Set<String>> NAMESPACE_TO_GROUP_NAME_MAP = new ConcurrentHashMap<>();
  20.  
  21.     /**
  22.      * 共享nacos实体列表
  23.      */
  24.     private List<NacosShareEntity> entities;
  25.  
  26.     public List<NacosShareEntity> getEntities() {
  27.         return entities;
  28.     }
  29.  
  30.     public void setEntities(List<NacosShareEntity> entities) {
  31.         this.entities = entities;
  32.     }
  33.  
  34.     public Map<String, Set<String>> getNamespaceGroupMap() {
  35.         if (CollectionUtils.isEmpty(entities)) {
  36.             return new HashMap<>();
  37.         }
  38.         entities.stream().filter(entity -> nonNull(entity) && nonNull(entity.getNamespace()))
  39.                 .forEach(entity -> {
  40.                     Set<String> groupNames = NAMESPACE_TO_GROUP_NAME_MAP.computeIfAbsent(entity.getNamespace(), k -> new HashSet<>());
  41.                     if (nonNull(entity.getGroupNames()))
  42.                         groupNames.addAll(entity.getGroupNames());
  43.                 });
  44.         return new HashMap<>(NAMESPACE_TO_GROUP_NAME_MAP);
  45.     }
  46.  
  47.     @Override
  48.     public String toString() {
  49.         return "NacosShareProperties{" +
  50.                 "entities=" + entities +
  51.                 '}';
  52.     }
  53.  
  54.     /**
  55.      * 共享nacos实体
  56.      */
  57.     public static final class NacosShareEntity {
  58.  
  59.         /**
  60.          * 命名空间
  61.          */
  62.         private String namespace;
  63.  
  64.         /**
  65.          * 分组
  66.          */
  67.         private List<String> groupNames;
  68.  
  69.         public String getNamespace() {
  70.             return namespace;
  71.         }
  72.  
  73.         public void setNamespace(String namespace) {
  74.             this.namespace = namespace;
  75.         }
  76.  
  77.         public List<String> getGroupNames() {
  78.             return groupNames;
  79.         }
  80.  
  81.         public void setGroupNames(List<String> groupNames) {
  82.             this.groupNames = groupNames;
  83.         }
  84.  
  85.         @Override
  86.         public String toString() {
  87.             return "NacosShareEntity{" +
  88.                     "namespace='" + namespace + '\'' +
  89.                     ", groupNames=" + groupNames +
  90.                     '}';
  91.         }
  92.     }
  93. }

五、整合配置类 NacosDiscoveryAutoConfigurationV2

  1. import com.alibaba.cloud.nacos.ConditionalOnNacosDiscoveryEnabled;
  2. import com.alibaba.cloud.nacos.NacosServiceManager;
  3. import com.alibaba.cloud.nacos.discovery.NacosDiscoveryAutoConfiguration;
  4. import com.alibaba.cloud.nacos.discovery.NacosServiceDiscovery;
  5. import org.springframework.boot.autoconfigure.AutoConfigureBefore;
  6. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  7. import org.springframework.cloud.client.ConditionalOnDiscoveryEnabled;
  8. import org.springframework.context.annotation.Bean;
  9. import org.springframework.context.annotation.Configuration;
  10.  
  11. /**
  12.  * @Auther: yangjian
  13.  */
  14. @Configuration(proxyBeanMethods = false)
  15. @ConditionalOnDiscoveryEnabled
  16. @ConditionalOnNacosDiscoveryEnabled
  17. @AutoConfigureBefore({NacosDiscoveryAutoConfiguration.class})
  18. public class NacosDiscoveryAutoConfigurationV2 {
  19.     @Bean
  20.     @ConditionalOnMissingBean
  21.     public NacosDiscoveryPropertiesV2 nacosProperties(NacosShareProperties nacosShareProperties) {
  22.         return new NacosDiscoveryPropertiesV2(nacosShareProperties);
  23.     }
  24.  
  25.     @Bean
  26.     @ConditionalOnMissingBean
  27.     public NacosServiceDiscovery nacosServiceDiscovery(NacosDiscoveryPropertiesV2 discoveryPropertiesV2
  28.             , NacosShareProperties nacosShareProperties, NacosServiceManager nacosServiceManager) {
  29.         return new NacosServiceDiscoveryV2(discoveryPropertiesV2, nacosShareProperties, nacosServiceManager);
  30.     }
  31. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/weixin_40725706/article/detail/902006
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号