Nacos系列【25】源码分析篇之Spring Cloud启动器

柔光的暖阳◎ 2024-04-08 10:10 60阅读 0赞

> **有道无术，术尚可求，有术无道，止于术。**
> 
> 版本說明：
> 
> spring-boot：2.6.3
> 
> spring-cloud：2021.0.1
> 
> spring-cloud-alibaba：2.2.8.RELEASE
> 
> Nacos：2.1.1

#### 文章目录 ####

*   *  前言
     *  应用检测
     *  集成 ribbon
     *  自动注册
     *  服务发现

### 前言 ###

[源碼地址][Link 1]

`spring-cloud-starter-alibaba-nacos-discovery`是一个基于`Spring Cloud`开发的`Nacos`服务注册启动器。

**源码结构如下**：  
![在这里插入图片描述][eb513a1e68234305b991430c5071c3e9.png]

### 应用检测 ###

基于`Spring Boot Actuator`提供了服务注册健康检测，从源码中可以看到健康状态、服务发现这两个端点：  
![在这里插入图片描述][75f842ebadb74bb0945260f6396551ba.png]  
可以参考[Spring Boot 2.x系列][Spring Boot 2.x]来获取这些监控端点。

访问健康状态端点，可以看到当前服务发现和配置中心的状态为`UP`：  
![在这里插入图片描述][1be8817f4c0f4150876a3d51c5630cff.png]  
访问服务发现端点，可以看到当前注册的服务名、IP、端口等信息：  
![在这里插入图片描述][54eb0f5b37e24252b5342ae42147b2d3.png]

### 集成 ribbon ###

`ribbon` 是一个客户端负载均衡组件，主要功能是提供客户端的软件负载均衡算法和服务调用。`Nacos`默认提供了集成，引入了`spring-cloud-starter-netflix-ribbon`包，需要注意的是`spring cloud`数字年份版本移除了`netflix`所有组件。  
![在这里插入图片描述][c07db2a0fc0c412e870031a15dbe4043.png]  
`ConditionalOnRibbonNacos`是一个条件注入注解，可以通过`ribbon.nacos.enabled`配置关闭`ribbon`：

@Retention(RetentionPolicy.RUNTIME)
    @Target({
        ElementType.TYPE, ElementType.METHOD})
    @ConditionalOnProperty(
        value = {
        "ribbon.nacos.enabled"},
        matchIfMissing = true
    )
    public @interface ConditionalOnRibbonNacos {
        
    }

`ExtendBalancer` 继承自`Balancer`，是一个负载均衡器，可以看到`Nacos`这里默认采用的是随机权重算法：  
![在这里插入图片描述][cf5e4f9a91a44095a02d48edcab8871b.png]  
`NacosServer`继承`netflix Server`类，是一个服务对象，维护了服务实例、元数据等信息：  
![在这里插入图片描述][c511887ef5564e24afdcff0199c6e975.png]  
`NacosRule`继承自`AbstractLoadBalancerRule`抽象类，可以看出这是一个负载均衡规则类，从服务提供者的实例中选出一个可用服务：  
![在这里插入图片描述][e3867b7ba24a4a859d6a3284230e467c.png]

`NacosServerList`服务列表，顾名思义封装了所有的服务对象：  
![在这里插入图片描述][bd254531bf0f422f8bd3c2cb2e6ec989.png]  
`NacosServerIntrospector`从方法看，是获取服务的元数据和是否`Https`:  
![在这里插入图片描述][58d75e443ca147718ce0e912aae49384.png]  
`NacosRibbonClientConfiguration`配置类，注入了两个Bean 对象：

@Configuration(
        proxyBeanMethods = false
    )
    // 使用 ribbon.nacos.enabled 可以关闭
    @ConditionalOnRibbonNacos
    public class NacosRibbonClientConfiguration {
        
        @Autowired
        private PropertiesFactory propertiesFactory;
    
        // 服务列表对象
        @Bean
        @ConditionalOnMissingBean
        public ServerList<?> ribbonServerList(IClientConfig config, NacosDiscoveryProperties nacosDiscoveryProperties) {
        
            if (this.propertiesFactory.isSet(ServerList.class, config.getClientName())) {
        
                ServerList serverList = (ServerList)this.propertiesFactory.get(ServerList.class, config, config.getClientName());
                return serverList;
            } else {
        
                NacosServerList serverList = new NacosServerList(nacosDiscoveryProperties);
                serverList.initWithNiwsConfig(config);
                return serverList;
            }
        }
        // 注入NacosServerIntrospector
        @Bean
        @ConditionalOnMissingBean
        public NacosServerIntrospector nacosServerIntrospector() {
        
            return new NacosServerIntrospector();
        }
    }

`RibbonNacosAutoConfiguration`自动配置类的主要作用是使用`@RibbonClients`注解，将`NacosRibbonClientConfiguration`配置类注入到上下文中：  
![在这里插入图片描述][c9f8a765aacc456d8530eaa86f89d875.png]

### 自动注册 ###

在微服务架构中，**服务注册、服务发现、注册中心**的概念，想必大家都很熟悉了，所谓`自动服务注册`就是项目启动的时候，会自动将当前服务自己的信息地址注册到注册中心。

`Nacos`通过实现`Spring Cloud`提供的接口能力来实现注册功能，集成代码如下：  
![在这里插入图片描述][6bbbca92e6664b968d81bf7c8bee5783.png]

`ServiceRegistry`是`Spring Cloud`提供的服务注册接口，声明了注册功能各种方法：

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);
    }

`NacosServiceRegistry`实现了该接口，提供了注册的相关方法，流程后续会解读：  
![在这里插入图片描述][88469582351f45dc988e0a62a9f2205c.png]

`ServiceInstance`也是`Spring Cloud`提供了接口，它表示一个具体的服务实例对象，`NacosRegistration`实现了该接口：  
![在这里插入图片描述][465d0f64c46b4381baff6915790d95df.png]  
`AbstractAutoServiceRegistration`抽象类也是`Spring Cloud`提供，这就是自动注册实现的核心代码，由它来调用服务注册实例进行自动注册，`NacosAutoServiceRegistration`继承自该抽象类，并主要实现了其注册方法：  
![在这里插入图片描述][30b21a2feb40469db9a68dc80fa265c5.png]  
`NacosServiceRegistryAutoConfiguration`自动配置类，主要负责自动配置的开关，以及注册相关Bean 对象：

@Configuration(
        proxyBeanMethods = false
    )
    @EnableConfigurationProperties
    @ConditionalOnNacosDiscoveryEnabled
    // 可以使用spring.cloud.service-registry.auto-registration.enabled参数关闭自动注册
    @ConditionalOnProperty(
        value = {
        "spring.cloud.service-registry.auto-registration.enabled"},
        matchIfMissing = true
    )
    @AutoConfigureAfter({
        AutoServiceRegistrationConfiguration.class, AutoServiceRegistrationAutoConfiguration.class, NacosDiscoveryAutoConfiguration.class})
    public class NacosServiceRegistryAutoConfiguration {
        
    
        // Nacos 服务注册器
        @Bean
        public NacosServiceRegistry nacosServiceRegistry(NacosServiceManager nacosServiceManager, NacosDiscoveryProperties nacosDiscoveryProperties) {
        
            return new NacosServiceRegistry(nacosServiceManager, nacosDiscoveryProperties);
        }
        // 服务实例
        @Bean
        @ConditionalOnBean({
        AutoServiceRegistrationProperties.class})
        public NacosRegistration nacosRegistration(ObjectProvider<List<NacosRegistrationCustomizer>> registrationCustomizers, NacosDiscoveryProperties nacosDiscoveryProperties, ApplicationContext context) {
        
            return new NacosRegistration((List)registrationCustomizers.getIfAvailable(), nacosDiscoveryProperties, context);
        }
        // 自动注册器
        @Bean
        @ConditionalOnBean({
        AutoServiceRegistrationProperties.class})
        public NacosAutoServiceRegistration nacosAutoServiceRegistration(NacosServiceRegistry registry, AutoServiceRegistrationProperties autoServiceRegistrationProperties, NacosRegistration registration) {
        
            return new NacosAutoServiceRegistration(registry, autoServiceRegistrationProperties, registration);
        }
    }

### 服务发现 ###

`服务发现`，即消费端自动发现服务地址列表的能力，是微服务框架需要具备的关键能力，借助于自动化的服务发现，微服务之间可以在无需感知对方部署位置与 IP 地址的情况下实现通信。  
![在这里插入图片描述][b241cc2d1b144ed4852b7339930cf28b.png]  
`NacosWatch`实现了`SmartLifecycle`接口，所以应用在启动后会调用其`start()`方法，还实现了`ApplicationEventPublisherAware`接口，所以具备了事件发布能力。该类的具体作用，后续会解答。

`NacosServiceManager`从名字上看是服务管理器的意思，它主要维护了`NamingService`和`NamingMaintainService`对象，这两个对象是  
`Nacos`原生客户端提供的接口，是由工厂创建，`NamingService`主要负责注册、注销服务，`NamingMaintainService`主要负责更新服务。

`NacosServiceManager`负责构建这两个对象。  
![在这里插入图片描述][1739cfd6f462461cad649d03f7f2adbe.png]

`NacosServiceInstance`实现了`ServiceInstance`接口，表示一个具体的服务实例，维护了当前服务ID、端口、元数据等信息。  
![在这里插入图片描述][58e9397582df4039b781f916a1faf0fa.png]  
`NacosServiceAutoConfiguration`没什么好说的，只是注册了一个`NacosServiceManager`对象。  
![在这里插入图片描述][57052c9612314d60af3775b7fbf5f246.png]  
`ConditionalOnNacosDiscoveryEnabled`就是一个条件注解，表示是否开启Nacos服务注册中心，通过 `spring.cloud.nacos.discovery.enabled`参数配置进行控制。

@Retention(RetentionPolicy.RUNTIME)
    @Target({
        ElementType.TYPE, ElementType.METHOD})
    @ConditionalOnProperty(
        value = {
        "spring.cloud.nacos.discovery.enabled"},
        matchIfMissing = true
    )
    public @interface ConditionalOnNacosDiscoveryEnabled {
        
    }

学过`Spring Boot Starter` 启动器的都知道，首先是有一个配置类用于配置当前组件，服务注册的配置类为`NacosDiscoveryProperties`，可以看到提供了服务注册需要的地址、权重、元数据、心跳等配置项。  
![在这里插入图片描述][9c17e907a353411ab6b9c9c90c18b899.png]  
在`spring.factories`文件中，可以看到很多自动配置类，这些类会在应用启动时，使用`SPI`机制将当前类中注册的Bean 对象加载到应用上下文中。  
![在这里插入图片描述][2dea4f41e4ae4800bd2e534bad0f5f5e.png]  
`NacosDiscoveryClient`服务发现客户端实现了`DiscoveryClient`接口，提供了获取其他服务实例的功能，通过`NacosServiceDiscovery`类来获取逻辑：  
![在这里插入图片描述][bf7362b5782f421d9a4c634f4743c4b8.png]  
`NacosServiceDiscovery`是`Nacos`就是实际提供了服务发现功能的类，可以看到他是通过`NamingService`来获取实例：![0e8d450b80d24525b0de9f870ef2abc8.png][]  
`NacosDiscoveryAutoConfiguration`注入了服务注册发现配置类，以及服务发现功能类：  
![在这里插入图片描述][4e4879217f244dc5a6fc6d8b59aa94b1.png]

`NacosDiscoveryClientConfiguration`注入了服务发现客户端以及`NacosWatch`:  
![在这里插入图片描述][b963ff3095744ff39cd44e999a829480.png]  
`configclient`是集成了`Spring Cloud Config`配置中心：  
![在这里插入图片描述][165754f4a7ac4383814c6a04eaed486a.png]

[Link 1]: https://github.com/alibaba/spring-cloud-alibaba/tree/2.2.x/spring-cloud-alibaba-starters
[eb513a1e68234305b991430c5071c3e9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/703c1337da2c463281b75b9e2f020e90.png
[75f842ebadb74bb0945260f6396551ba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/12c8ec1d4c914a31aa3d75f2b4a2a874.png
[Spring Boot 2.x]: https://blog.csdn.net/qq_43437874/category_11869707.html?spm=1001.2014.3001.5482
[1be8817f4c0f4150876a3d51c5630cff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/cb03378356e14f80ac8c4a41c8418864.png
[54eb0f5b37e24252b5342ae42147b2d3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/93272727ee7d4134bdf3003c18b21777.png
[c07db2a0fc0c412e870031a15dbe4043.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/2b3f64e1617640f89f1c12b8ad2f6393.png
[cf5e4f9a91a44095a02d48edcab8871b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/924349b2458a43bdafaee4218d1691a8.png
[c511887ef5564e24afdcff0199c6e975.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/8a6ffe12b942436991a45642b35b29d7.png
[e3867b7ba24a4a859d6a3284230e467c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/cd6eda801deb4c5091e373a1c70cbbf4.png
[bd254531bf0f422f8bd3c2cb2e6ec989.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/fa5adab682df40e3b0c7ad205c2df23a.png
[58d75e443ca147718ce0e912aae49384.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d74b22e78895455ebf3367dbc07c6bc9.png
[c9f8a765aacc456d8530eaa86f89d875.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/8863481b454846208fda35cb04945121.png
[6bbbca92e6664b968d81bf7c8bee5783.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/9ae26191cb0b4338bf643b467117f959.png
[88469582351f45dc988e0a62a9f2205c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ba502343859d429799a85d4568b42c7a.png
[465d0f64c46b4381baff6915790d95df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/57210912b9ff423292d92f6d9b441ed4.png
[30b21a2feb40469db9a68dc80fa265c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/3cd42e21c074415a8d8dd1332c2f2160.png
[b241cc2d1b144ed4852b7339930cf28b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/132b77b9a89d4735b010ea9b0ec3f141.png
[1739cfd6f462461cad649d03f7f2adbe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/8eebc8029a7a482aa94beb7d9a59c194.png
[58e9397582df4039b781f916a1faf0fa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/097c406c9b084d27b495a5c53d483a1f.png
[57052c9612314d60af3775b7fbf5f246.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7c49dae7b0ef46a49ddd2064ba7734de.png
[9c17e907a353411ab6b9c9c90c18b899.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/08dbbd7a6e254004bc5f7e96db49b224.png
[2dea4f41e4ae4800bd2e534bad0f5f5e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a7b0dac1a2b043fd8401e1048741ce60.png
[bf7362b5782f421d9a4c634f4743c4b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/8a3a8af25e984427b9ecf78281b47d8c.png
[0e8d450b80d24525b0de9f870ef2abc8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/36733f60565e49aa8b07230670c179b4.png
[4e4879217f244dc5a6fc6d8b59aa94b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/cf5baa54468a475aaf0772af4137d6ec.png
[b963ff3095744ff39cd44e999a829480.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/aff30386d6e94439bc81498d5d7a611a.png
[165754f4a7ac4383814c6a04eaed486a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4285167724454c1ca48046779a3571d2.png