开篇构想
在此之前，已经写了十多篇Nacos的文章，感觉Nacos还值得更深入的学习一下。于是萌生了写一个Nacos源码系列专栏的文章。
写作的目标呢，有两个：第一，能够系统的学习Nacos知识;第二，能够基于Nacos学到涉及到的知识点或面;
展现形式呢，也有两个：第一，单篇足够简单且又有价值;第二，发现代码中的新颖之处;
源码版本信息
目前在生产实践中建议大家采用1.4.2版本，但作为技术研究，本系列文章会基于2.0.2版本来仅仅讲解。这是两个跨度比较大的版本，建议大家配合源码进行学习。
关于源码拉取，环境搭建部分就不再赘述。下面就开始本篇文章，讲解Nacos服务注册的客户端部分。
服务注册信息
讲到服务注册，我们先要了解一下Nacos都会将什么信息传递给服务器。直接从Nacos Client项目的NamingTest看起：
- 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);
这是服务注册的核心所有代码。仅从此处的代码分析，可以看出，Nacos注册服务实例时，包含了两大类信息：Nacos Server连接信息和实例信息。
Nacos Server连接信息
Nacos Server连接信息，存储在Properties当中，包含以下信息：
- Server地址：Nacos服务器地址，属性的key为serverAddr;
- 用户名：连接Nacos服务的用户名，属性key为username，默认值为nacos;
- 密码：连接Nacos服务的密码，属性key为password，默认值为nacos;
实例信息
注册实例信息用Instance对象承载，注册的实例信息又分两部分：实例基础信息和元数据。
实例基础信息包括：
- instanceId：实例的唯一ID;
- ip：实例IP，提供给消费者进行通信的地址;
- port：端口，提供给消费者访问的端口;
- weight：权重，当前实例的权限，浮点类型(默认1.0D);
- healthy：健康状况，默认true;
- enabled：实例是否准备好接收请求，默认true;
- ephemeral：实例是否为瞬时的，默认为true;
- clusterName：实例所属的集群名称;
- serviceName：实例的服务信息;
Instance类包含了实例的基础信息之外，还包含了用于存储元数据的metadata(描述数据的数据)，类型为HashMap。
从Demo中放了两个数据：
netType：顾名思义，网络类型，这里的值为external，也就是外网的意思;
version：版本，Nacos的版本，这里是2.0这个大版本。
除了Demo中这些“自定义”的信息，在Instance类中还定义了一些默认信息，这些信息通过get方法提供：
- public long getInstanceHeartBeatInterval() {
- return getMetaDataByKeyWithDefault(PreservedMetadataKeys.HEART_BEAT_INTERVAL,
- Constants.DEFAULT_HEART_BEAT_INTERVAL);
- }
- public long getInstanceHeartBeatTimeOut() {
- return getMetaDataByKeyWithDefault(PreservedMetadataKeys.HEART_BEAT_TIMEOUT,
- Constants.DEFAULT_HEART_BEAT_TIMEOUT);
- }
- public long getIpDeleteTimeout() {
- return getMetaDataByKeyWithDefault(PreservedMetadataKeys.IP_DELETE_TIMEOUT,
- Constants.DEFAULT_IP_DELETE_TIMEOUT);
- }
- public String getInstanceIdGenerator() {
- return getMetaDataByKeyWithDefault(PreservedMetadataKeys.INSTANCE_ID_GENERATOR,
- Constants.DEFAULT_INSTANCE_ID_GENERATOR);
- }
上面的get方法在需要元数据默认值时会被用到：
- preserved.heart.beat.interval：心跳间隙的key，默认为5s，也就是默认5秒进行一次心跳;
- preserved.heart.beat.timeout：心跳超时的key，默认为15s，也就是默认15秒收不到心跳，实例将会标记为不健康;
- preserved.ip.delete.timeout：实例IP被删除的key，默认为30s，也就是30秒收不到心跳，实例将会被移除;
- preserved.instance.id.generator：实例ID生成器key，默认为simple;
这些都是Nacos默认提供的值，也就是当前实例注册时会告诉Nacos Server说：我的心跳间隙、心跳超时等对应的值是多少，你按照这个值来判断我这个实例是否健康。当然，如果你想让心跳“加速”，出现故障快速被移除，那可以跳短心跳间隙和超时时间。但这也意味着给Nacos服务带来一定的压力。
有了这些信息，我们基本是已经知道注册实例时需要传递什么参数，需要配置什么参数了。
NamingService接口
NamingService接口是Nacos命名服务对外提供的一个统一接口，看对应的源码就可以发现，它提供了大量实例相关的接口方法，比如：
- 服务实例注册;
- 服务实例注销;
- 获取服务实例列表;
- 获取服务单个实例;
- 订阅服务事件;
- 取消订阅服务事件;
- 获取所有(或指定)服务名称;
- 获取所有订阅的服务;
- 获取Nacos服务的状态;
- 主动关闭服务;
其中部分功能提供了大量的重载方法，应用于不同场景和不同类型实例或服务的筛选。这个就不逐一说明，按照需要或注释进行使用即可。
NamingService的实例化是通过NamingFactory类和上面提到的Nacos服务信息：
- 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);
- }
- }
很明显，这里采用了反射的机制来实例化NamingService，接口的具体实现类为NacosNamingService类。
NacosNamingService的实现
在示例代码中使用了NamingService#registerInstance方法来进行服务实例的注册，该方法接收两个参数，服务名称和实例对象。
- @Override
- public void registerInstance(String serviceName, Instance instance) throws NacosException {
- registerInstance(serviceName, Constants.DEFAULT_GROUP, instance);
- }
这个方法的最大作用是设置了当前实例的分组信息。我们知道，在Nacos中，通过Namespace、group、Service、Cluster等一层层的将实例进行环境的隔离。在这里设置了默认的分组为“DEFAULT_GROUP”。
紧接着调用的registerInstance方法如下：
- @Override
- public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
- NamingUtils.checkInstanceIsLegal(instance);
- clientProxy.registerService(serviceName, groupName, instance);
- }
这个方法实现了两个功能：第一，检查心跳时间设置的对不对，配置的超时时间总不能比心跳间隔还短吧。第二，通过NamingClientProxy这个代理来执行服务注册操作。
反观NacosNamingService构造方法，会发现NamingClientProxy这个代理接口的具体实现是有NamingClientProxyDelegate来完成的。
NamingClientProxyDelegate中实现
NamingClientProxy调用registerService实际上调用的就是NamingClientProxyDelegate的对应方法：
- @Override
- public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
- getExecuteClientProxy(instance).registerService(serviceName, groupName, instance);
- }
真正调用注册服务的并不是代理实现类，而是根据当前实例是否为瞬时对象，来选择对应的客户端代理来进行请求的：
- private NamingClientProxy getExecuteClientProxy(Instance instance) {
- return instance.isEphemeral() ? grpcClientProxy : httpClientProxy;
- }
如果当前实例为瞬时对象，则采用gRPC协议(NamingGrpcClientProxy)进行请求，否则采用http协议(NamingHttpClientProxy)进行请求。默认为瞬时对象，也就是说，2.0版本中默认采用了gRPC协议进行与Nacos服务进行交互。
NamingGrpcClientProxy中实现
关于gRPC协议这部分我们会单独进行讲解，这里暂时不做拓展。主要看其registerService方法实现：
- @Override
- public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
- NAMING_LOGGER.info("[REGISTER-SERVICE] {} registering service {} with instance {}", namespaceId, serviceName,
- instance);
- namingGrpcConnectionEventListener.cacheInstanceForRedo(serviceName, groupName, instance);
- InstanceRequest request = new InstanceRequest(namespaceId, serviceName, groupName,
- NamingRemoteConstants.REGISTER_INSTANCE, instance);
- requestToServer(request, Response.class);
- }
在NamingGrpcClientProxy中做了两件事，一件事是通过事件监听器缓存了当前注册的实例信息用于恢复。缓存的数据结构为ConcurrentMap
另外一件事就是封装了参数，基于gRPC协议进行服务的调用和结果的处理。
流程图
下面来看一张流程图，来汇总一下上面讲到的整个业务逻辑：
小结
关于Nacos源码分析的开篇就写这么多，主要分析了服务注册需要哪些维度的信息、客户端提供的核心服务处理类(NamingService)以及注册通信协议的选择。其中的一些内容还可以细化，比如gRPC协议的实现等，我们后续文章继续进行呈现。
