Spring Cloud @RefreshScope 原理及使用

@RefreshScope那些事

要说清楚RefreshScope,先要了解Scope

  • Scope(org.springframework.beans.factory.config.Scope)是Spring 2.0开始就有的核心的概念
  • RefreshScope(org.springframework.cloud.context.scope.refresh)是spring cloud提供的一种特殊的scope实现,用来实现配置、实例热加载。
  • Scope -> GenericScope -> RefreshScope

Scope与ApplicationContext生命周期

AbstractBeanFactory#doGetBean创建Bean实例

 protected <T> T doGetBean(...){
  final RootBeanDefinition mbd = ...
  if (mbd.isSingleton()) {
    ...
  } else if (mbd.isPrototype())
    ...
  } else {
     String scopeName = mbd.getScope();
     final Scope scope = this.scopes.get(scopeName);
     Object scopedInstance = scope.get(beanName, new ObjectFactory<Object>() {...});
     ...
  }
  ...
 }

Singleton和Prototype是硬编码的,并不是Scope子类。 Scope实际上是自定义扩展的接口

Scope Bean实例交由Scope自己创建,例如SessionScope是从Session中获取实例的,ThreadScope是从ThreadLocal中获取的,而RefreshScope是在内建缓存中获取的。

@Scope 对象的实例化

@RefreshScope 是scopeName="refresh"的 @Scope

 ...
 @Scope("refresh")
 public @interface RefreshScope {
   ...
 }

@Scope 的注册 AnnotatedBeanDefinitionReader#registerBean

 public void registerBean(...){
  ...
  ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd);
   abd.setScope(scopeMetadata.getScopeName());
  ...
   definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
 }

读取@Scope元数据, AnnotationScopeMetadataResolver#resolveScopeMetadata

public ScopeMetadata resolveScopeMetadata(BeanDefinition definition) {
     AnnotationAttributes attributes = AnnotationConfigUtils.attributesFor(
         annDef.getMetadata(), Scope.class);
     if (attributes != null) {
       metadata.setScopeName(attributes.getString("value"));
       ScopedProxyMode proxyMode = attributes.getEnum("proxyMode");
       if (proxyMode == null || proxyMode == ScopedProxyMode.DEFAULT) {
         proxyMode = this.defaultProxyMode;
       }
       metadata.setScopedProxyMode(proxyMode);
     }
}

Scope实例对象通过ScopedProxyFactoryBean创建,其中通过AOP使其实现ScopedObject接口,这里不再展开

现在来说说RefreshScope是如何实现配置和实例刷新的

RefreshScope注册

RefreshAutoConfiguration#RefreshScopeConfiguration

 @Component
 @ConditionalOnMissingBean(RefreshScope.class)
 protected static class RefreshScopeConfiguration implements BeanDefinitionRegistryPostProcessor{
 ...
   registry.registerBeanDefinition("refreshScope",
   BeanDefinitionBuilder.genericBeanDefinition(RefreshScope.class)
             .setRole(BeanDefinition.ROLE_INFRASTRUCTURE)
             .getBeanDefinition());
 ...
 }

RefreshScope extends GenericScope, 大部分逻辑在 GenericScope 中

GenericScope#postProcessBeanFactory 中向AbstractBeanFactory注册自己

public class GenericScope implements Scope, BeanFactoryPostProcessor...{
   @Override
   public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
     throws BeansException {
     beanFactory.registerScope(this.name/*refresh*/, this/*RefreshScope*/);
     ...
   }
}

RefreshScope 刷新过程

入口在ContextRefresher#refresh

 refresh() {
   Map<String, Object> before = ①extract(
       this.context.getEnvironment().getPropertySources());
   ②addConfigFilesToEnvironment();
   Set<String> keys = ④changes(before,
       ③extract(this.context.getEnvironment().getPropertySources())).keySet();
   this.context.⑤publishEvent(new EnvironmentChangeEvent(keys));
   this.scope.⑥refreshAll();
 }

①提取标准参数(SYSTEM,JNDI,SERVLET)之外所有参数变量
②把原来的Environment里的参数放到一个新建的Spring Context容器下重新加载,完事之后关闭新容器
③提起更新过的参数(排除标准参数)
④比较出变更项
⑤发布环境变更事件,接收:EnvironmentChangeListener/LoggingRebinder
⑥RefreshScope用新的环境参数重新生成Bean
重新生成的过程很简单,清除refreshscope缓存幷销毁Bean,下次就会重新从BeanFactory获取一个新的实例(该实例使用新的配置)

RefreshScope#refreshAll

 public void refreshAll() {
     <b>super.destroy();</b>
     this.context.publishEvent(new RefreshScopeRefreshedEvent());
 }
GenericScope#destroy
 public void destroy() {
   ...
   Collection<BeanLifecycleWrapper> wrappers = <b>this.cache.clear()</b>;
   for (BeanLifecycleWrapper wrapper : wrappers) {
     <b>wrapper.destroy();</b>
   }
 }

Spring Cloud Bus 如何触发 Refresh

BusAutoConfiguration#BusRefreshConfiguration 发布一个RefreshBusEndpoint

@Configuration
 @ConditionalOnClass({ Endpoint.class, RefreshScope.class })
 protected static class BusRefreshConfiguration {

   @Configuration
   @ConditionalOnBean(ContextRefresher.class)
   @ConditionalOnProperty(value = "endpoints.spring.cloud.bus.refresh.enabled", matchIfMissing = true)
   protected static class BusRefreshEndpointConfiguration {
     @Bean
     public RefreshBusEndpoint refreshBusEndpoint(ApplicationContext context,
         BusProperties bus) {
       return new RefreshBusEndpoint(context, bus.getId());
     }
   }
 }

RefreshBusEndpoint 会从http端口触发广播RefreshRemoteApplicationEvent事件

 @Endpoint(id = "bus-refresh")
 public class RefreshBusEndpoint extends AbstractBusEndpoint {
    public void busRefresh() {
     publish(new RefreshRemoteApplicationEvent(this, getInstanceId(), null));
   }
 }

BusAutoConfiguration#refreshListener 负责接收事件(所有配置bus的节点)

 @Bean
 @ConditionalOnProperty(value = "spring.cloud.bus.refresh.enabled", matchIfMissing = true)
 @ConditionalOnBean(ContextRefresher.class)
 public RefreshListener refreshListener(ContextRefresher contextRefresher) {
   return new RefreshListener(contextRefresher);
 }

RefreshListener#onApplicationEvent 触发 ContextRefresher

public void onApplicationEvent(RefreshRemoteApplicationEvent event) {
   Set<String> keys = contextRefresher.refresh();
 }

大部分需要更新的服务需要打上@RefreshScope, EurekaClient是如何配置更新的

EurekaClientAutoConfiguration#RefreshableEurekaClientConfiguration

 @Configuration
 @ConditionalOnRefreshScope
 protected static class RefreshableEurekaClientConfiguration{
   @Bean
   @RefreshScope
   public EurekaClient eurekaClient(...) {
     return new CloudEurekaClient(manager, config, this.optionalArgs,
         this.context);
   }

   @Bean
   @RefreshScope
   public ApplicationInfoManager eurekaApplicationInfoManager(...) {
     ...
     return new ApplicationInfoManager(config, instanceInfo);
   }
 }

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • Spring Cloud @RefreshScope 原理及使用

    @RefreshScope那些事 要说清楚RefreshScope,先要了解Scope Scope(org.springframework.beans.factory.config.Scope)是Spring 2.0开始就有的核心的概念 RefreshScope(org.springframework.cloud.context.scope.refresh)是spring cloud提供的一种特殊的scope实现,用来实现配置.实例热加载. Scope -> GenericScope -> R

  • Spring Cloud Feign原理详解

    目录 Feign的大体机制 @EnableFeignClients 和 @FeignClient 注解 registerDefaultConfiguration方法 registerFeignClients方法 feign客户端的动态代理 Feign 主要是帮助我们方便进行rest api服务间的调用,其大体实现思路就我们通过标记注解在一个接口类上(注解上将包含要调用的接口信息),之后在调用时根据注解信息组装好请求信息,接下来基于ribbon这些负载均衡器来生成真实的服务地址,最后将请求发送出去

  • Spring Cloud原理详解

    之前一直在看<Spring Cloud微服务实战>,最近又看了架构笔记的<拜托!面试请不要再问我Spring Cloud底层原理>,对Spring Cloud的主要组件的原理有了更深的理解,特地做一下总结 一.Spring Cloud核心组件:Eureka (1)Netflix Eureka 1).Eureka服务端:也称服务注册中心,同其他服务注册中心一样,支持高可用配置.如果Eureka以集群模式部署,当集群中有分片出现故障时,那么Eureka就转入自我保护模式.它允许在分片故

  • Spring Cloud动态配置刷新RefreshScope使用示例详解

    目录 引言 一.了解@RefreshScope,先要了解@Scope 二.RefreshScope 的实现原理 三.使用——@RefreshScope 使用流程 引言 用过Spring Cloud的同学都知道在使用动态配置刷新的我们要配置一个 @RefreshScope,在类上才可以实现对象属性的的动态更新. @RefreshScope 能实现动态刷新全仰仗着 @Scope这个注解. 一.了解@RefreshScope,先要了解@Scope 1.RefreshScope继承于GenericSco

  • 浅谈Spring Cloud Ribbon的原理

    Ribbon是Netflix发布的开源项目,主要功能是提供客户端的软件负载均衡算法,将Netflix的中间层服务连接在一起.Ribbon客户端组件提供一系列完善的配置项如连接超时,重试等.简单的说,就是在配置文件中列出Load Balancer(简称LB)后面所有的机器,Ribbon会自动的帮助你基于某种规则(如简单轮询,随即连接等)去连接这些机器.我们也很容易使用Ribbon实现自定义的负载均衡算法. 说起负载均衡一般都会想到服务端的负载均衡,常用产品包括LBS硬件或云服务.Nginx等,都是

  • Spring Cloud 负载均衡器 Ribbon原理及实现

    Ribbon简介 分布式系统中,各个微服务会部署多个实例,如何将服务消费者均匀分摊到多个服务提供者实例上,就要使用到负载均衡器 Ribbon 是负载均衡器 ,它提供了很多负载均衡算法,例如轮询.随即等,在配置服务提供者地址后,可以将服务消费者请求均匀的分发 为服务消费者整合Ribbon 添加 Ribbon 依赖库 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spri

  • Spring Cloud Hystrix入门和Hystrix命令原理分析

    断路由器模式 在分布式架构中,当某个服务单元发生故障之后,通过断路由器的故障监控(类似熔断保险丝),向调用方返回一个错误响应,而不是长时间的等待.这样就不会使得线程因调用故障服务被长时间占用不释放,避免了故障在分布式系统中的蔓延. Spring Cloud Hystrix针对上述问题实现了断路由器.线程隔离等一系列服务保护功能.它是基于Netflix Hystrix实现,该框架的目标在于通过控制那些访问远程系统.服务和第三方库的节点,从而对延迟和故障提供更强大的容错能力. Hystrix具备服务

  • Spring Cloud Ribbon的踩坑记录与原理详析

    简介 Spring Cloud Ribbon 是一个基于Http和TCP的客服端负载均衡工具,它是基于Netflix Ribbon实现的.它不像服务注册中心.配置中心.API网关那样独立部署,但是它几乎存在于每个微服务的基础设施中.包括前面的提供的声明式服务调用也是基于该Ribbon实现的.理解Ribbon对于我们使用Spring Cloud来讲非常的重要,因为负载均衡是对系统的高可用.网络压力的缓解和处理能力扩容的重要手段之一.在上节的例子中,我们采用了声明式的方式来实现负载均衡.实际上,内部

  • spring cloud Ribbon用法及原理解析

    这篇文章主要介绍了spring cloud Ribbon用法及原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 简介 这篇文章主要介绍一下ribbon在程序中的基本使用,在这里是单独拿出来写用例测试的,实际生产一般是配置feign一起使用,更加方便开发.同时这里也通过源码来简单分析一下ribbon的基本实现原理. 基本使用 这里使用基于zookeeper注册中心+ribbon的方式实现一个简单的客户端负载均衡案例. 服务提供方 首先是一个

  • Spring Cloud 中自定义外部化扩展机制原理及实战记录

    目录 自定义PropertySource 扩展PropertySourceLocator Spring.factories 编写controller测试 阶段性总结 SpringApplication.run PropertySourceBootstrapConfiguration.initialize ApplicationContextInitializer的理解和使用 创建一个TestApplicationContextInitializer 添加spi加载 Spring Cloud针对E

随机推荐