0
点赞
收藏
分享

微信扫一扫

Nacos源码阅读开篇之Nacos客户端-服务注册信息和NamingService接口

快乐码农Alan007 2022-04-03 阅读 60
javaspring

文章目录

1、Nacos 注册信息

以源码中自带的ManingTest 测试类距离举例，
这是客户端注册的一个测试类，他模仿了一个真实的服务注册进Naocos 的过程，包括NacosServer连接、实例的创建、实力属性的赋值、注册实例，所以在这个其中包含了服务注册的核心代码，可以看出，Nacos注册服务实例时，包含了两大类信息： Nacos Server 连接信息 和 实例信息。
在这里插入图片描述
内容如下：

@Ignore
public class NamingTest {
    
    @Test
    public void testServiceList() throws Exception {
        
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, "127.0.0.1:8848");
        properties.put(PropertyKeyConst.USERNAME, "nacos");
        properties.put(PropertyKeyConst.PASSWORD, "nacos");
        
        Instance instance = new Instance();
        instance.setIp("1.1.1.1");
        instance.setPort(800);
        instance.setWeight(2);
        Map<String, String> map = new HashMap<String, String>();
        map.put("netType", "external");
        map.put("version", "2.0");
        instance.setMetadata(map);
    
        NamingService namingService = NacosFactory.createNamingService(properties);
        namingService.registerInstance("nacos.test.1", instance);
        
        ThreadUtils.sleep(5000L);
        
        List<Instance> list = namingService.getAllInstances("nacos.test.1");
        
        System.out.println(list);
        
        ThreadUtils.sleep(30000L);
        //        ExpressionSelector expressionSelector = new ExpressionSelector();
        //        expressionSelector.setExpression("INSTANCE.metadata.registerSource = 'dubbo'");
        //        ListView<String> serviceList = namingService.getServicesOfServer(1, 10, expressionSelector);
        
    }

1.1、Nacos Server 连接信息

Nacos Server 连接信息，存储在Properties当中，包含以下内容：

  • Server地址：Nacos服务地址，属性的key 为serverAddr；
  • 用户名： 连接Nacos服务的用户名，属性的key为username，默认值为nacos；
  • 密码：连接Nacos 服务的用户密码，属性的key为password ，默认值为 nacos；

1.2、实例信息

  • InstanceId：实例的唯一ID
  • Ip：实例IP，提供给消费者进行通讯的地址
  • port：端口，提供给消费者访问的端口
  • weight：权重，当前实例的权限，浮点类型（1.0D）
  • enabled：实例是否准备好接收请求，默认true；
  • ephemeral：实例所属的机群名称；
  • clusterName： 实例所属的机群名称；
  • servlceName：实例的服务信息；

Instance类包含了实例的基础信息之外，还包含了用于存储元数据的metadata 1（描述数据的数据），类型为HashMap，从当前这个Demo中我们可以得知存放的两个数据：

  • netType：故名思义，网络类型，这里的值为extenal，也就是外网的意思；
  • version：版本，Nacos的版本，这里是2.0这个大版本

除了Demo中这些“自定义”的信息，在Instance类中还定义了一些默认信息，这些信息通过get方法获取：

#类 --> com.alibaba.nacos.api.naming.pojo.Instance;
# 获取一次心跳的间隙 默认是5秒
public long getInstanceHeartBeatInterval() {
        return getMetaDataByKeyWithDefault(PreservedMetadataKeys.HEART_BEAT_INTERVAL,
                Constants.DEFAULT_HEART_BEAT_INTERVAL);
    }
  # 获取实例的心跳超时时间 默认是15秒  
    public long getInstanceHeartBeatTimeOut() {
        return getMetaDataByKeyWithDefault(PreservedMetadataKeys.HEART_BEAT_TIMEOUT,
                Constants.DEFAULT_HEART_BEAT_TIMEOUT);
    }
# 获取实例的超时铲除时间 默认是30秒    
    public long getIpDeleteTimeout() {
        return getMetaDataByKeyWithDefault(PreservedMetadataKeys.IP_DELETE_TIMEOUT,
                Constants.DEFAULT_IP_DELETE_TIMEOUT);
    }
# 获取实例的 实际ID
    public String getInstanceIdGenerator() {
        return getMetaDataByKeyWithDefault(PreservedMetadataKeys.INSTANCE_ID_GENERATOR,
                Constants.DEFAULT_INSTANCE_ID_GENERATOR);
    }

上面的get方法在需要原数据默认时会被用到：

  • PreservedMetadataKeys.HEART_BEAT_INTERVAL：心跳间隙的key，默认为5s，也就是默认5s 进行一次心跳；
  • PreservedMetadataKeys.HEART_BEAT_TIMEOUT：心跳超时的key，默认为15s，也就是默认15s收不到心跳，实例将会标记为不健康；
  • PreservedMetadataKeys.IP_DELETE_TIMEOUT： 实例IP被删除的key，默认为30s，也就是30s收不到心跳，实例将会被移除；
  • PreservedMetadataKeys.INSTANCE_ID_GENERATOR： 实例ID 生成器key，默认为simple；
    这些都是Nacos默认提供的值，也就是当前用力注册时会高数Nacos Server说：我的心跳间隙，心跳超时等对应的值是多少，你按照这个值来判断我这个实例是否健康。

有了这些信息，我们疾病是已经知道注册实例是需要传递什么参数，需要配置什么参数了。

1.3、NamingService接口

NamingService接口是Nacos命名服务对外借口的一个统一接口，看对应的源码就可以发现，它提供了大量实例相关的借口方法；

  • 服务实例注册
  • 服务实例注销
  • 获取服务实例
  • 查询健康服务实例
  • 查询集群中健康的服务实例
  • 使用负载均衡策略选择一个将康的服务实例
  • 订阅服务时间
  • 取消订阅服务事件
  • 获取所有(或指定)服务名称
  • 获取Nacos服务的状态
  • 主动关闭服务

在这些方法中提供了大量的重载方法，应用于不同类型实例和服务的筛选，所以我们只需要在不同的情况下使用不同的方法即可。
NamingService的实例画是通过NamingFactory类和上面的Nacos服务信息，从代码中可以看出这里采用的反射机制来市里话NamingService，具体的实现类为NacosNamingService：

#类 com.alibaba.nacos.api.naming.NamingFactory;

public static NamingService createNamingService(Properties properties) throws NacosException {
        try {
            Class<?> driverImplClass = Class.forName("com.alibaba.nacos.client.naming.NacosNamingService");
            Constructor constructor = driverImplClass.getConstructor(Properties.class);
            return (NamingService) constructor.newInstance(properties);
        } catch (Throwable e) {
            throw new NacosException(NacosException.CLIENT_INVALID_PARAM, e);
        }
    }

1.4、 NacosNamingService的实现

在示例代码中使用了NamingService的registerInstance方法来进行服务实现的注册，该方法接收两个参数、服务名称和实力对象。这个方法的最大作用是设置了当前实例的分组信息。我们知道，在Nacos中，通过Namespace、group、Service、Cluster等一层层的将实例进行环境的隔离。在这里设置了默认的分组为“DEFAULT_GROUP”。

#com.alibaba.nacos.client.naming.NacosNamingService;
#num = 137 row
@Override
    public void registerInstance(String serviceName, Instance instance) throws NacosException {
        registerInstance(serviceName, Constants.DEFAULT_GROUP, instance);
    }

紧接着调用的registerInstance方法如下，这个方法实现了两个功能：
第一、查看心跳时间配置的对不对（心跳默认为5s）
第二、通过NamingClientProxy 这个代理来执行服务注册操作

#com.alibaba.nacos.client.naming.NacosNamingService;
#num = 142 row
@Override
    public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
        NamingUtils.checkInstanceIsLegal(instance);
        clientProxy.registerService(serviceName, groupName, instance);
    }

通过clientProxy我们发现NamingClientProxy这个代理借口的具体实现是由NamingClientProxyDelegate来实现的，这个可以从NacosNamingService构造方法中来看出。

#com.alibaba.nacos.client.naming.NacosNamingService;
#num = 80 row
public NacosNamingService(Properties properties) throws NacosException {
        init(properties);
    }

初始化方法init中

#com.alibaba.nacos.client.naming.NacosNamingService;
#num = 84 row
private void init(Properties properties) throws NacosException {
        ValidatorUtils.checkInitParam(properties);
        this.namespace = InitUtils.initNamespaceForNaming(properties);
        InitUtils.initSerialization();
        InitUtils.initWebRootContext(properties);
        initLogName(properties);
        
        this.changeNotifier = new InstancesChangeNotifier();
        NotifyCenter.registerToPublisher(InstancesChangeEvent.class, 16384);
        NotifyCenter.registerSubscriber(changeNotifier);
        this.serviceInfoHolder = new ServiceInfoHolder(namespace, properties);
        this.clientProxy = new NamingClientProxyDelegate(this.namespace, serviceInfoHolder, properties, changeNotifier);# 这里我们可以看出来，是NamingClientProxyDelegate来实现的
    }

1.4、 NamingClientProxyDelegate中的实现

根据上方的分析和源码的阅读，我们可以发现NamingClientProxy调用registerService实际调用的就是NamingClientProxyDeletagate的对应方法。

#com.alibaba.nacos.client.naming.remote.NamingClientProxyDelegate;
# num = 92 row
@Override
    public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
        getExecuteClientProxy(instance).registerService(serviceName, groupName, instance);
    }

真正调用注册服务的并不是代理实现类，而是根据当前实例是否为瞬时对象，来选着对应的客户端代理来进行请求的：
如果当前对象是瞬时对象，则采用gRPC协议（NamingGrpcClientProxy）进行请求，否则采用http协议（NamingHttpProxy）进行请求。默认为瞬时对象，也就是说，2.0版本中默认采用了gRPC协议进行与Nacos服务进行交互。

#com.alibaba.nacos.client.naming.remote.NamingClientProxyDelegate;
# num = 175 row
 private NamingClientProxy getExecuteClientProxy(Instance instance) {
        return instance.isEphemeral() ? grpcClientProxy : httpClientProxy;
    }

1.5、NamingGrpcClientProxy中实现

关于gRPC协议（NamingGrpcClientProxy），我们后续展开，我们主要关注一下registerService方法实现，这里其实做了两件事情：
1.缓存当前注册的实例信息用于恢复，缓存的数据结构为ConcurrentMap<String,Instance>,key为“serviceNaming@@groupName”，value就是前面封装的实例信息。
2.另外一件事情就是封装了参数，给予gRPC进行服务的调用和结果的处理。

#com.alibaba.nacos.client.naming.remote.gprc.NamingGrpcClientProxy;
# num = 109 row
 @Override
    public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
        NAMING_LOGGER.info("[REGISTER-SERVICE] {} registering service {} with instance {}", namespaceId, serviceName,
                instance);
        redoService.cacheInstanceForRedo(serviceName, groupName, instance);//缓存数据
        doRegisterService(serviceName, groupName, instance);//基于gRPC进行的服务的调用
    }

通过NamingTest.testServiceList（）整个的调用流程如下：
在这里插入图片描述
在这里插入图片描述

  1. Nacos数据（如配置和服务）描述信息，如服务版本、权重、容灾策略、负载均衡策略、鉴权配置、各种自定义标签 (label)，从作用范围来看，分为服务级别的元信息、集群的元信息及实例的元信息。摘抄与官网 ↩︎

举报

相关推荐

Nacos 源码分析04 客户端处理请求

客户端返回结果d3软件架构软件研发

手撕Nacos源码，今日撕客户端源码

Java后端ide服务端服务发现Storm大数据

SpringCloud Alibaba Nacos客户端启动时服务自动注册原理

spring cloudjava后端nacos

启用nacos的客户端报错

大数据spring云服务数据库配置Linux系统/运维

Nacos 服务注册源码分析

微服务spring cloudjava

Nacos（1.2）- nacos 服务注册

spring cloud微服务spring boot

【Spring Cloud】 Nacos注册中心 服务端注册服务流程源码

spring bootspringspring cloud

图解+源码讲解 Nacos 客户端动态监听配置机制

后端Spring Cloud监听器服务端ide编程语言

Nacos服务注册

spring cloudjava微服务后端

图解+源码讲解 Nacos 客户端启动拉取配置流程

后端Spring Cloud加载客户端数据编程语言
0 条评论