《跟二師兄學(xué)Nacos吧》第1篇 Nacos客戶端服務(wù)注冊(cè)源碼分析
開篇構(gòu)想
在此之前，已經(jīng)寫了十多篇Nacos的文章，感覺Nacos還值得更深入的學(xué)習(xí)一下。于是萌生了寫一個(gè)Nacos源碼系列專欄的文章。
寫作的目標(biāo)呢，有兩個(gè)：第一，能夠系統(tǒng)的學(xué)習(xí)Nacos知識(shí)；第二，能夠基于Nacos學(xué)到涉及到的知識(shí)點(diǎn)或面；
展現(xiàn)形式呢，也有兩個(gè)：第一，單篇足夠簡(jiǎn)單且又有價(jià)值；第二，發(fā)現(xiàn)代碼中的新穎之處；
源碼版本信息
目前在生產(chǎn)實(shí)踐中建議大家采用1.4.2版本，但作為技術(shù)研究，本系列文章會(huì)基于2.0.2版本來(lái)僅僅講解。這是兩個(gè)跨度比較大的版本，建議大家配合源碼進(jìn)行學(xué)習(xí)。
關(guān)于源碼拉取，環(huán)境搭建部分就不再贅述。下面就開始本篇文章，講解Nacos服務(wù)注冊(cè)的客戶端部分。
服務(wù)注冊(cè)信息
講到服務(wù)注冊(cè)，我們先要了解一下Nacos都會(huì)將什么信息傳遞給服務(wù)器。直接從Nacos Client項(xiàng)目的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);
這是服務(wù)注冊(cè)的核心所有代碼。僅從此處的代碼分析，可以看出，Nacos注冊(cè)服務(wù)實(shí)例時(shí)，包含了兩大類信息：Nacos Server連接信息和實(shí)例信息。
Nacos Server連接信息
Nacos Server連接信息，存儲(chǔ)在Properties當(dāng)中，包含以下信息：
Server地址：Nacos服務(wù)器地址，屬性的key為serverAddr；
用戶名：連接Nacos服務(wù)的用戶名，屬性key為username，默認(rèn)值為nacos；
密碼：連接Nacos服務(wù)的密碼，屬性key為password，默認(rèn)值為nacos；
實(shí)例信息
注冊(cè)實(shí)例信息用Instance對(duì)象承載，注冊(cè)的實(shí)例信息又分兩部分：實(shí)例基礎(chǔ)信息和元數(shù)據(jù)。
實(shí)例基礎(chǔ)信息包括：
instanceId：實(shí)例的唯一ID；
ip：實(shí)例IP，提供給消費(fèi)者進(jìn)行通信的地址；
port：端口，提供給消費(fèi)者訪問的端口；
weight：權(quán)重，當(dāng)前實(shí)例的權(quán)限，浮點(diǎn)類型（默認(rèn)1.0D）；
healthy：健康狀況，默認(rèn)true；
enabled：實(shí)例是否準(zhǔn)備好接收請(qǐng)求，默認(rèn)true；
ephemeral：實(shí)例是否為瞬時(shí)的，默認(rèn)為true；
clusterName：實(shí)例所屬的集群名稱；
serviceName：實(shí)例的服務(wù)信息；
Instance類包含了實(shí)例的基礎(chǔ)信息之外，還包含了用于存儲(chǔ)元數(shù)據(jù)的metadata（描述數(shù)據(jù)的數(shù)據(jù)），類型為HashMap。
從Demo中放了兩個(gè)數(shù)據(jù)：
netType：顧名思義，網(wǎng)絡(luò)類型，這里的值為external，也就是外網(wǎng)的意思；
version：版本，Nacos的版本，這里是2.0這個(gè)大版本。
除了Demo中這些“自定義”的信息，在Instance類中還定義了一些默認(rèn)信息，這些信息通過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方法在需要元數(shù)據(jù)默認(rèn)值時(shí)會(huì)被用到：
preserved.heart.beat.interval：心跳間隙的key，默認(rèn)為5s，也就是默認(rèn)5秒進(jìn)行一次心跳；
preserved.heart.beat.timeout：心跳超時(shí)的key，默認(rèn)為15s，也就是默認(rèn)15秒收不到心跳，實(shí)例將會(huì)標(biāo)記為不健康；
preserved.ip.delete.timeout：實(shí)例IP被刪除的key，默認(rèn)為30s，也就是30秒收不到心跳，實(shí)例將會(huì)被移除；
preserved.instance.id.generator：實(shí)例ID生成器key，默認(rèn)為simple；
這些都是Nacos默認(rèn)提供的值，也就是當(dāng)前實(shí)例注冊(cè)時(shí)會(huì)告訴Nacos Server說(shuō)：我的心跳間隙、心跳超時(shí)等對(duì)應(yīng)的值是多少，你按照這個(gè)值來(lái)判斷我這個(gè)實(shí)例是否健康。當(dāng)然，如果你想讓心跳“加速”，出現(xiàn)故障快速被移除，那可以跳短心跳間隙和超時(shí)時(shí)間。但這也意味著給Nacos服務(wù)帶來(lái)一定的壓力。
有了這些信息，我們基本是已經(jīng)知道注冊(cè)實(shí)例時(shí)需要傳遞什么參數(shù)，需要配置什么參數(shù)了。
NamingService接口
NamingService接口是Nacos命名服務(wù)對(duì)外提供的一個(gè)統(tǒng)一接口，看對(duì)應(yīng)的源碼就可以發(fā)現(xiàn)，它提供了大量實(shí)例相關(guān)的接口方法，比如：
服務(wù)實(shí)例注冊(cè)；
服務(wù)實(shí)例注銷；
獲取服務(wù)實(shí)例列表；
獲取服務(wù)單個(gè)實(shí)例；
訂閱服務(wù)事件；
取消訂閱服務(wù)事件；
獲取所有（或指定）服務(wù)名稱；
獲取所有訂閱的服務(wù)；
獲取Nacos服務(wù)的狀態(tài)；
主動(dòng)關(guān)閉服務(wù)；
其中部分功能提供了大量的重載方法，應(yīng)用于不同場(chǎng)景和不同類型實(shí)例或服務(wù)的篩選。這個(gè)就不逐一說(shuō)明，按照需要或注釋進(jìn)行使用即可。
NamingService的實(shí)例化是通過NamingFactory類和上面提到的Nacos服務(wù)信息：
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);
}
}
很明顯，這里采用了反射的機(jī)制來(lái)實(shí)例化NamingService，接口的具體實(shí)現(xiàn)類為NacosNamingService類。
NacosNamingService的實(shí)現(xiàn)
在示例代碼中使用了NamingService#registerInstance方法來(lái)進(jìn)行服務(wù)實(shí)例的注冊(cè)，該方法接收兩個(gè)參數(shù)，服務(wù)名稱和實(shí)例對(duì)象。
@Override
public void registerInstance(String serviceName, Instance instance) throws NacosException {
registerInstance(serviceName, Constants.DEFAULT_GROUP, instance);
}
這個(gè)方法的最大作用是設(shè)置了當(dāng)前實(shí)例的分組信息。我們知道，在Nacos中，通過Namespace、group、Service、Cluster等一層層的將實(shí)例進(jìn)行環(huán)境的隔離。在這里設(shè)置了默認(rèn)的分組為“DEFAULT_GROUP”。
緊接著調(diào)用的registerInstance方法如下：
@Override
public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
NamingUtils.checkInstanceIsLegal(instance);
clientProxy.registerService(serviceName, groupName, instance);
}
這個(gè)方法實(shí)現(xiàn)了兩個(gè)功能：第一，檢查心跳時(shí)間設(shè)置的對(duì)不對(duì)，配置的超時(shí)時(shí)間總不能比心跳間隔還短吧。第二，通過NamingClientProxy這個(gè)代理來(lái)執(zhí)行服務(wù)注冊(cè)操作。
反觀NacosNamingService構(gòu)造方法，會(huì)發(fā)現(xiàn)NamingClientProxy這個(gè)代理接口的具體實(shí)現(xiàn)是有NamingClientProxyDelegate來(lái)完成的。
NamingClientProxyDelegate中實(shí)現(xiàn)
NamingClientProxy調(diào)用registerService實(shí)際上調(diào)用的就是NamingClientProxyDelegate的對(duì)應(yīng)方法：
@Override
public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
getExecuteClientProxy(instance).registerService(serviceName, groupName, instance);
}
真正調(diào)用注冊(cè)服務(wù)的并不是代理實(shí)現(xiàn)類，而是根據(jù)當(dāng)前實(shí)例是否為瞬時(shí)對(duì)象，來(lái)選擇對(duì)應(yīng)的客戶端代理來(lái)進(jìn)行請(qǐng)求的：
private NamingClientProxy getExecuteClientProxy(Instance instance) {
return instance.isEphemeral() ? grpcClientProxy : httpClientProxy;
}
如果當(dāng)前實(shí)例為瞬時(shí)對(duì)象，則采用gRPC協(xié)議（NamingGrpcClientProxy）進(jìn)行請(qǐng)求，否則采用http協(xié)議（NamingHttpClientProxy）進(jìn)行請(qǐng)求。默認(rèn)為瞬時(shí)對(duì)象，也就是說(shuō)，2.0版本中默認(rèn)采用了gRPC協(xié)議進(jìn)行與Nacos服務(wù)進(jìn)行交互。
NamingGrpcClientProxy中實(shí)現(xiàn)
關(guān)于gRPC協(xié)議這部分我們會(huì)單獨(dú)進(jìn)行講解，這里暫時(shí)不做拓展。主要看其registerService方法實(shí)現(xiàn)：
@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中做了兩件事，一件事是通過事件監(jiān)聽器緩存了當(dāng)前注冊(cè)的實(shí)例信息用于恢復(fù)。緩存的數(shù)據(jù)結(jié)構(gòu)為ConcurrentMap<String, Instance>，key為“serviceName@@groupName”，value就是前面封裝的實(shí)例信息。
另外一件事就是封裝了參數(shù)，基于gRPC協(xié)議進(jìn)行服務(wù)的調(diào)用和結(jié)果的處理。
流程圖
下面來(lái)看一張流程圖，來(lái)匯總一下上面講到的整個(gè)業(yè)務(wù)邏輯： 
小結(jié)
關(guān)于Nacos源碼分析的開篇就寫這么多，主要分析了服務(wù)注冊(cè)需要哪些維度的信息、客戶端提供的核心服務(wù)處理類（NamingService）以及注冊(cè)通信協(xié)議的選擇。其中的一些內(nèi)容還可以細(xì)化，比如gRPC協(xié)議的實(shí)現(xiàn)等，我們后續(xù)文章繼續(xù)進(jìn)行呈現(xiàn)。
如果文章內(nèi)容有問題或想技術(shù)討論請(qǐng)聯(lián)系我（微信：zhuan2quan，備注Nacos），如果覺得寫的還不錯(cuò)，值得一起學(xué)習(xí)，那就關(guān)注一下吧。
往期推薦
如果你覺得這篇文章不錯(cuò)，那么，下篇通常會(huì)更好。添加微信好友，可備注“加群”（微信號(hào)：zhuan2quan）。
和花一輩子都看不清的人，
注定是截然不同的搬磚生涯。
