Nacos客戶端是如何在SpringCloud進(jìn)行集成和實(shí)現(xiàn)的

小編給大家分享一下Nacos客戶端是如何在SpringCloud進(jìn)行集成和實(shí)現(xiàn)的，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

Spring Boot的自動(dòng)注冊(cè)

故事要從頭Spring Boot的自動(dòng)注入開始。很多朋友大概都了解過(guò)Spring Boot的自動(dòng)配置功能，而Spring Cloud又是基于Spring  Boot框架的。

因此，在學(xué)習(xí)Nacos注冊(cè)業(yè)務(wù)之前，我們先來(lái)回顧一下Spring Boot的自動(dòng)配置原理，這也是學(xué)習(xí)的入口。

Spring  Boot通過(guò)@EnableAutoConfiguration注解，將所有符合條件的@Configuration配置都加載到當(dāng)前SpringBoot創(chuàng)建并使用的IoC容器。

上述過(guò)程是通過(guò)@Import(AutoConfigurationImportSelector.class)導(dǎo)入的配置功能，AutoConfigurationImportSelector中的方法getCandidateConfigurations，得到待配置的class的類名集合，即所有需要進(jìn)行自動(dòng)配置的(xxxAutoConfiguration)類，這些類配置于META-INF/spring.factories文件中。

最后，根據(jù)這些全限定名類上的注解，如：OnClassCondition、OnBeanCondition、OnWebApplicationCondition條件化的決定要不要自動(dòng)配置。

了解了Spring Boot的基本配置之后，我們來(lái)看看Nacos對(duì)應(yīng)的自動(dòng)配置在哪里。

Spring Cloud中的Nacos自動(dòng)配置

查看Spring  Cloud的項(xiàng)目依賴，本人引入依賴對(duì)應(yīng)的jar包為spring-cloud-starter-alibaba-nacos-discovery-2021.1.jar;

對(duì)應(yīng)的pom依賴為：

<dependency>     <groupId>com.alibaba.cloud</groupId>     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency>

查看jar包中META-INF/spring.factories文件的內(nèi)容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\   com.alibaba.cloud.nacos.discovery.NacosDiscoveryAutoConfiguration,\   com.alibaba.cloud.nacos.endpoint.NacosDiscoveryEndpointAutoConfiguration,\   com.alibaba.cloud.nacos.registry.NacosServiceRegistryAutoConfiguration,\   com.alibaba.cloud.nacos.discovery.NacosDiscoveryClientConfiguration,\   com.alibaba.cloud.nacos.discovery.reactive.NacosReactiveDiscoveryClientConfiguration,\   com.alibaba.cloud.nacos.discovery.configclient.NacosConfigServerAutoConfiguration,\   com.alibaba.cloud.nacos.NacosServiceAutoConfiguration org.springframework.cloud.bootstrap.BootstrapConfiguration=\   com.alibaba.cloud.nacos.discovery.configclient.NacosDiscoveryClientConfigServiceBootstrapConfiguration

可以看到EnableAutoConfiguration類對(duì)應(yīng)了一系列的Nacos自動(dòng)配置類。

其中NacosServiceRegistryAutoConfiguration是用來(lái)封裝實(shí)例化Nacos注冊(cè)流程所需組件的，裝載了對(duì)三個(gè)對(duì)象NacosServiceRegistry、NacosRegistration、NacosAutoServiceRegistration，這三個(gè)對(duì)象整體都是為了Nacos服務(wù)注冊(cè)使用的。

@Configuration(proxyBeanMethods = false) @EnableConfigurationProperties @ConditionalOnNacosDiscoveryEnabled @ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled",         matchIfMissing = true) @AutoConfigureAfter({ AutoServiceRegistrationConfiguration.class,         AutoServiceRegistrationAutoConfiguration.class,         NacosDiscoveryAutoConfiguration.class }) public class NacosServiceRegistryAutoConfiguration {      @Bean     public NacosServiceRegistry nacosServiceRegistry(             NacosDiscoveryProperties nacosDiscoveryProperties) {         return new NacosServiceRegistry(nacosDiscoveryProperties);     }      @Bean     @ConditionalOnBean(AutoServiceRegistrationProperties.class)     public NacosRegistration nacosRegistration(             ObjectProvider<List<NacosRegistrationCustomizer>> registrationCustomizers,             NacosDiscoveryProperties nacosDiscoveryProperties,             ApplicationContext context) {         return new NacosRegistration(registrationCustomizers.getIfAvailable(),                 nacosDiscoveryProperties, context);     }      @Bean     @ConditionalOnBean(AutoServiceRegistrationProperties.class)     public NacosAutoServiceRegistration nacosAutoServiceRegistration(             NacosServiceRegistry registry,             AutoServiceRegistrationProperties autoServiceRegistrationProperties,             NacosRegistration registration) {         return new NacosAutoServiceRegistration(registry,                 autoServiceRegistrationProperties, registration);     } }

其中NacosServiceRegistry封裝的就是注冊(cè)流程，它繼承自ServiceRegistry：

public class NacosServiceRegistry implements ServiceRegistry<Registration> {...}

查看該類源碼，可以看到該類中實(shí)現(xiàn)了服務(wù)注冊(cè)、注銷、關(guān)閉、設(shè)置狀態(tài)、獲取狀態(tài)5個(gè)功能。

我們要追蹤的服務(wù)注冊(cè)功能，便是通過(guò)它提供的register方法來(lái)實(shí)現(xiàn)的。

至此，我們可以梳理一下Nacos客戶端在Spring Cloud中集成并實(shí)例化的處理流程。

Spring Cloud的ServiceRegistry接口

上面提到NacosServiceRegistry集成自ServiceRegistry，那么ServiceRegistry又是何方神圣呢?

ServiceRegistry接口是Spring Cloud的類，來(lái)看一下ServiceRegistry接口的定義：

public interface ServiceRegistry<R extends Registration> {      void register(R registration);     void deregister(R registration);     void close();     void setStatus(R registration, String status);     <T> T getStatus(R registration); }

可以看出ServiceRegistry接口中定義了服務(wù)注冊(cè)、注銷、關(guān)閉、設(shè)置狀態(tài)、獲取狀態(tài)五個(gè)接口。

如果看其他服務(wù)發(fā)現(xiàn)框架對(duì)Spring Cloud進(jìn)行集成時(shí)，基本上都是實(shí)現(xiàn)的這個(gè)接口。也就是說(shuō)，ServiceRegistry是Spring  Cloud提供的一個(gè)服務(wù)發(fā)現(xiàn)框架集成的規(guī)范。對(duì)應(yīng)的框架安裝規(guī)范實(shí)現(xiàn)對(duì)應(yīng)的功能即可進(jìn)行集成。

我們可以看到Eureka、Zookeeper、Consul在Spring  Cloud中集成也都是實(shí)現(xiàn)了該接口，同時(shí)，如果你需要自定義服務(wù)發(fā)現(xiàn)功能，也可以通過(guò)實(shí)現(xiàn)該接口來(lái)達(dá)到目的。

NacosServiceRegistry服務(wù)注冊(cè)實(shí)現(xiàn)

暫且不關(guān)注其他的輔助類，直接來(lái)看NacosServiceRegistry#register方法，它提供了服務(wù)注冊(cè)的核心業(yè)務(wù)邏輯實(shí)現(xiàn)。

我們把該類的輔助判斷去掉，直接展示最核心的代碼如下：

@Override public void register(Registration registration) {      // 獲取NamingService     NamingService namingService = namingService();     String serviceId = registration.getServiceId();     String group = nacosDiscoveryProperties.getGroup();      // 構(gòu)造實(shí)例，封裝信息來(lái)源于配置屬性     Instance instance = getNacosInstanceFromRegistration(registration);     // 將實(shí)例進(jìn)行注冊(cè)     namingService.registerInstance(serviceId, group, instance); }

上述代碼中NamingService已經(jīng)屬于Nacos Client項(xiàng)目提供的API支持了。

關(guān)于Nacos  Client的API流程查看，可直接查看Nacos對(duì)應(yīng)的源碼，NamingService#registerInstance方法對(duì)應(yīng)的流程圖整理如下：

上述流程圖還可以繼續(xù)細(xì)化，這個(gè)我們?cè)诤罄m(xù)章節(jié)中進(jìn)行專門講解，這里大家知道大概的調(diào)用流程即可。

Spring Cloud服務(wù)注冊(cè)鏈路

下面我們來(lái)梳理一下Spring  Cloud是如何進(jìn)行服務(wù)注冊(cè)的，其中流程的前三分之二部分幾乎所有的服務(wù)注冊(cè)框架都是一樣的流程，只有最后一部分進(jìn)行實(shí)例注冊(cè)時(shí)會(huì)調(diào)用具體的框架來(lái)進(jìn)行實(shí)現(xiàn)。

直接來(lái)看整個(gè)調(diào)用的鏈路圖：

圖中不同的顏色代表這不同的框架，灰色表示業(yè)務(wù)代碼，淺綠色表示SpringBoot框架，深綠色表示Spring框架，淺橙色表示SpringCloud框架，其中這一部分也包含了依賴的Nacos組件部分，最后淺紫色代表著Nacos  Client的包。

核心流程分以下幾步：

第一步，SpringBoot在啟動(dòng)main方法時(shí)調(diào)用到Spring的核心方法refresh;

第二步，在Spring中實(shí)例化了WebServerStartStopLifecycle對(duì)象。

重點(diǎn)說(shuō)一下WebServerStartStopLifecycle對(duì)象，它的start方法被調(diào)用時(shí)會(huì)發(fā)布一個(gè)ServletWebServerInitializedEvent事件類，這個(gè)事件類繼承自WebServerInitializedEvent。后面用來(lái)處理服務(wù)注冊(cè)的類AbstractAutoServiceRegistration同時(shí)也是一個(gè)監(jiān)聽器，專門用來(lái)監(jiān)聽WebServerInitializedEvent事件。

第三步，AbstractApplicationContext的finishRefresh中會(huì)間接調(diào)用DefaultLifecycleProcessor的startBeans方法，進(jìn)而調(diào)用了WebServerStartStopLifecycle的start方法。就像上面說(shuō)的，觸發(fā)了ServletWebServerInitializedEvent事件的發(fā)布。

第四步，AbstractAutoServiceRegistration監(jiān)聽到對(duì)應(yīng)的事件，然后基于Spring  Cloud定義的ServiceRegistry接口進(jìn)行服務(wù)注冊(cè)。

上面的描述省略了一些部分細(xì)節(jié)，但整個(gè)流程基本上就是SpringBoot在啟動(dòng)時(shí)發(fā)布了一個(gè)事件，Spring  Cloud監(jiān)聽到對(duì)應(yīng)的事件，然后進(jìn)行服務(wù)的注冊(cè)。

以上是“Nacos客戶端是如何在SpringCloud進(jìn)行集成和實(shí)現(xiàn)的”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！