文章目录
-
- 1、本节概要
- 2、@EnableDiscoveryClient 和@EnableEurekaClient 的区别
- 3、Eureka Client 启动时做了什么
-
- 3.1 @ConditionalOnClass(EurekaClientConfig.class)
- 3.2 @ConditionalOnBean(EurekaDiscoveryClientConfiguration.Marker.class)
- 3.3、 EurekaClientAutoConfiguration
- 3.4、 EurekaAutoServiceRegistration
- 3.5、 EurekaServiceRegistry
- 3.6、 ApplicationInfoManager
- 3.7、DiscoveryClient -> initScheduledTasks()
- 3.8、InstanceInfoReplicator -> onDemandUpdate
- 3.9、DiscoveryClient -> register
1、本节概要
根据前文我们对Eureka Server 有了一定的了解,本节我们主要学习Eureka Client 与 Eureka Server 如何通讯的及相关通信机制是什么,本文会弄清楚一下几个问题:
-
@EnableDiscoveryClient 和 @EnableEurekaClient的区别
-
Eureka Client 启动时做了什么事情(初始化工作)
-
Eureka Client 怎么注册到 Eureka Server(服务注册)
-
怎么获取 Eureka Server 上的服务的(服务获取)
-
怎么保证 Eureka Client 本地的服务列表与Eureka Server 上的服务列表保持一致的(服务同步)
2、@EnableDiscoveryClient 和@EnableEurekaClient 的区别
当我们使用服务发现的注解时,却发现了两种注解,经过尝试发现两者的使用效果是一样的,那么他们的区别是什么呢,通过查询官方文档是这样解释的:
Spring Cloud Commons provides the @EnableDiscoveryClient annotation.
This looks for implementations of the DiscoveryClient interface with
META-INF/spring.factories. Implementations of the Discovery Client add
a configuration class to spring.factories under the
org.springframework.cloud.client.discovery.EnableDiscoveryClient key.
Examples of DiscoveryClient implementations include Spring Cloud
Netflix Eureka, Spring Cloud Consul Discovery, and Spring Cloud
Zookeeper Discovery.
Spring Cloud Commons 提供 @EnableDiscoveryClient 注解。这将使用META-INF / spring.factories查找DiscoveryClient接口的实现。Discovery Client的实现将配置类添加到org.springframework.cloud.client.discovery.EnableDiscoveryClient项下的spring.factories。比如 DiscoveryClient 实现包括Spring Cloud Netflix Eureka,Spring Cloud Consul Discovery和Spring Cloud Zookeeper Discovery。
By default, implementations of DiscoveryClient auto-register the local
Spring Boot server with the remote discovery server. This behavior can
be disabled by setting autoRegister=false in @EnableDiscoveryClient.
默认情况下,DiscoveryClient 的实现会使用远程发现服务器自动注册本地Spring Boot服务器。可以通过在@EnableDiscoveryClient中设置autoRegister = false来禁用此行为。
简而言之 spring cloud 中服务发现有多种实现(eureka、consul、zookeeper等等),@EnableDiscoveryClient 基于 spring-cloud-commons, @EnableEurekaClient 基于 spring-cloud-netflix。
如果选用的注册中心是eureka,那么就推荐@EnableEurekaClient,如果是其他的注册中心,那么推荐使用@EnableDiscoveryClient。
我们看一下这两个注解的源码:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(EnableDiscoveryClientImportSelector.class)
public @interface EnableDiscoveryClient {
/**
* 如果为true,本服务奖自动注册到指定的服务中心,默认是启用的,
可以通过设置为 false 来禁用自动注册
*/
boolean autoRegister() default true;
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface EnableEurekaClient {
}
3、Eureka Client 启动时做了什么
我们根据注解 @EnableEurekaClient 找到该注解所在工程 spring-cloud-netflix-eureka-client-2.0.1.RELEASE.jar 下的 META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.netflix.eureka.config.EurekaClientConfigServerAutoConfiguration,\
org.springframework.cloud.netflix.eureka.config.EurekaDiscoveryClientConfigServiceAutoConfiguration,\
org.springframework.cloud.netflix.eureka.EurekaClientAutoConfiguration,\
org.springframework.cloud.netflix.ribbon.eureka.RibbonEurekaAutoConfiguration,\
org.springframework.cloud.netflix.eureka.EurekaDiscoveryClientConfiguration
org.springframework.cloud.bootstrap.BootstrapConfiguration=\
org.springframework.cloud.netflix.eureka.config.EurekaDiscoveryClientConfigServiceBootstrapConfiguration
本文主要看 org.springframework.cloud.netflix.eureka.EurekaClientAutoConfiguration,其它的主要是客户端查找配置中心及客户端负载均衡(Ribbon)的引导服务,在后续文章的学习总结中再做介绍。
下面我们就从 EurekaClientAutoConfiguration 的源码着手,看看都有哪些操作,先看一下该配置类的注解有哪些
@Configuration
# 加载配置文件解析
@EnableConfigurationProperties
# 加载client配置项
@ConditionalOnClass(EurekaClientConfig.class)
# 加载 DiscoveryClientOptionalArgsConfiguration 到容器
@Import(DiscoveryClientOptionalArgsConfiguration.class)
# 客户端启用引导标记
@ConditionalOnBean(EurekaDiscoveryClientConfiguration.Marker.class)
# 启用eureka client,默认启用
@ConditionalOnProperty(value = "eureka.client.enabled", matchIfMissing = true)
# 当前配置类EurekaClientAutoConfiguration 加载完毕后的后续加载操作
@AutoConfigureBefore({ NoopDiscoveryClientAutoConfiguration.class,
CommonsClientAutoConfiguration.class, ServiceRegistryAutoConfiguration.class })
@AutoConfigureAfter(name = {"org.springframework.cloud.autoconfigure.RefreshAutoConfiguration",
"org.springframework.cloud.netflix.eureka.EurekaDiscoveryClientConfiguration",
"org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationAutoConfiguration"})
public class EurekaClientAutoConfiguration {
}
3.1 @ConditionalOnClass(EurekaClientConfig.class)
@ImplementedBy(DefaultEurekaClientConfig.class)
public interface EurekaClientConfig {}
查看默认实现 DefaultEurekaClientConfig,eureka client 默认值加载
@Singleton
@ProvidedBy(DefaultEurekaClientConfigProvider.class)