Nacos客戶端服務注冊源碼分析
開篇構想
在此之前，已經寫了十多篇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協議的實現等，我們后續文章繼續進行呈現。
