Nacos+@RefreshScope 为什么配置能动态刷新？

女爷i 2023-09-27 19:48 108阅读 0赞

`@RefeshScope`这个注解想必大家都用过，在微服务配置中心的场景下经常出现，他可以用来刷新Bean中的属性配置，那大家对他的实现原理了解吗？它为什么可以做到动态刷新呢？

## 注解的作用 ##

`@RefreshScope`注解是Spring Cloud中的一个注解，用来实现Bean中属性的动态刷新。

/**
     * Convenience annotation to put a <code>@Bean</code> definition in
     * {@link org.springframework.cloud.context.scope.refresh.RefreshScope refresh scope}.
     * Beans annotated this way can be refreshed at runtime and any components that are using
     * them will get a new instance on the next method call, fully initialized and injected
     * with all dependencies.
     *
     * @author Dave Syer
     *
     */
    @Target({ ElementType.TYPE, ElementType.METHOD })
    @Retention(RetentionPolicy.RUNTIME)
    @Scope("refresh")
    @Documented
    public @interface RefreshScope {
    
     /**
      * @see Scope#proxyMode()
      * @return proxy mode
      */
     ScopedProxyMode proxyMode() default ScopedProxyMode.TARGET_CLASS;
    
    }

上面是`RefreshScope`的源码，该注解被`@Scope`注解使用，`@Scope`用来比较`Spring Bean`的作用域，具体使用参考相关文章。

注解的属性`proxyMode`默认使用`TARGET_CLASS`作为代理。

### 实例 ###

1、controller中添加`@RefreshScope`

![f1d62426074e9c0f669118c265be61a9.png][]

2、nacos配置中心中配置

![50deef3a1275305ee72ac0e65b5458c3.png][]

3、验证, 修改配置中心后，可以不重启动，刷新配置

![7186927528c675a637c8edc4cb99cd6e.png][]

![58a40c21f6e45e4605c16190d842dbfb.png][]

![31a20d5a65b1bd358eb27c6c5390a374.png][]

4、去掉`@RefreshScope` 就不会自动刷新。

## 原理解析 ##

为了实现动态刷新配置，主要就是想办法达成以下两个核心目标：

1.  让Spring容器重新加载Environment环境配置变量
2.  Spring Bean重新创建生成

`@RefreshScope`主要就是基于`@Scope`注解的作用域代理的基础上进行扩展实现的，加了`@RefreshScope`注解的类，在被Bean工厂创建后会加入自己的`refresh scope` 这个`Bean`缓存中，后续会优先从Bean缓存中获取，当配置中心发生了变更，会把变更的配置更新到spring容器的`Environment`中，并且同事bean缓存就会被清空，从而就会从bean工厂中创建bean实例了，而这次创建bean实例的时候就会继续经历这个bean的生命周期，使得`@Value`属性值能够从`Environment`中获取到最新的属性值，这样整个过程就达到了动态刷新配置的效果。关注公众号：码猿技术专栏，回复关键词：1111 获取阿里内部Java性能调优手册~

![3815e03be7a477a5deac37e0c13e37cf.png][]

### 获取RefreshScope注解的Bean ###

![57bd13b7629a063d151294ce76416da8.png][]

通过打上断点查看堆栈可知：

1、因为Class被加上了`@RefreshScope`注解，那么这个BeanDefinition信息中的scope为refresh，在getBean的的时候会单独处理逻辑。

public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport implements ConfigurableBeanFactory {
    
    protected <T> T doGetBean(
       String name, @Nullable Class<T> requiredType, @Nullable Object[] args, boolean typeCheckOnly)
       throws BeansException {
    
        // 如果scope是单例的情况, 这里不进行分析
        if (mbd.isSingleton()) {
         .....
        }
                    // 如果scope是prototype的情况, 这里不进行分析
        else if (mbd.isPrototype()) {
         ......
        }
                    // 如果scope是其他的情况，本例中是reresh
        else {
         String scopeName = mbd.getScope();
         if (!StringUtils.hasLength(scopeName)) {
          throw new IllegalStateException("No scope name defined for bean '" + beanName + "'");
         }
                        // 获取refresh scope的实现类RefreshScope，这个类在哪里注入，我们后面讲
         Scope scope = this.scopes.get(scopeName);
         if (scope == null) {
          throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
         }
         try {
                            // 这边是获取bean,调用的是RefreshScope中的的方法
          Object scopedInstance = scope.get(beanName, () -> {
           beforePrototypeCreation(beanName);
           try {
            return createBean(beanName, mbd, args);
           }
           finally {
            afterPrototypeCreation(beanName);
           }
          });
          beanInstance = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
         }
         catch (IllegalStateException ex) {
          throw new ScopeNotActiveException(beanName, scopeName, ex);
         }
        }
       }
       catch (BeansException ex) {
        beanCreation.tag("exception", ex.getClass().toString());
        beanCreation.tag("message", String.valueOf(ex.getMessage()));
        cleanupAfterBeanCreationFailure(beanName);
        throw ex;
       }
       finally {
        beanCreation.end();
       }
      }
    
      return adaptBeanInstance(name, beanInstance, requiredType);
     }
        
    }

2、`RefreshScope`继承成了`GenericScope`类，最终调用的的是`GenericScope`的`get`方法

public class GenericScope
      implements Scope, BeanFactoryPostProcessor, BeanDefinitionRegistryPostProcessor, DisposableBean {
                     @Override
     
      public Object get(String name, ObjectFactory<?> objectFactory) {
      // 将bean添加到缓存cache中
            BeanLifecycleWrapper value = this.cache.put(name, new BeanLifecycleWrapper(name, objectFactory));
      this.locks.putIfAbsent(name, new ReentrantReadWriteLock());
      try {
                // 调用下面的getBean方法
       return value.getBean();
      }
      catch (RuntimeException e) {
       this.errors.put(name, e);
       throw e;
      }
     }       
    
    private static class BeanLifecycleWrapper {
            
      public Object getBean() {
                // 如果bean为空，则创建bean
       if (this.bean == null) {
        synchronized (this.name) {
         if (this.bean == null) {
          this.bean = this.objectFactory.getObject();
         }
        }
       }
                // 否则返回之前创建好的bean
       return this.bean;
      }
                }
            }

小结：

从这边的代码中可以印证了上面的说法，创建后的Bean会缓存到scope的cache中，优先从缓存中获取，如果缓存中是null, 则重新走一遍create bean的流程。

### RefeshScope Bean的创建 ###

上面的在getBean的时候依赖到RefreshScope这个Bean，那么这个Bean是在什么时候加入到Spring Bean中的呢？答案就是`RefreshAutoConfiguration`。

![3170fe75a7e4fac744aa841a5a0d9be5.png][]

### 配置中心刷新后刷新Bean缓存 ###

![bbf82882456c7fc5874c24e2b2f71952.png][]

1、配置中心发生变化后，会收到一个`RefreshEvent`事件，`RefreshEventListner`监听器会监听到这个事件。

public class RefreshEventListener implements SmartApplicationListener {
    
     
    ........
    
     public void handle(RefreshEvent event) {
      if (this.ready.get()) { // don't handle events before app is ready
       log.debug("Event received " + event.getEventDesc());
                // 会调用refresh方法，进行刷新
       Set<String> keys = this.refresh.refresh();
       log.info("Refresh keys changed: " + keys);
      }
     }
    
    }
    
    // 这个是ContextRefresher类中的刷新方法
    public synchronized Set<String> refresh() {
            // 刷新spring的envirionment 变量配置
      Set<String> keys = refreshEnvironment();
            // 刷新其他scope
      this.scope.refreshAll();
      return keys;
     }

2、refresh方法最终调用destroy方法，清空之前缓存的bean

public class RefreshScope extends GenericScope
      implements ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, Ordered {
    
     @ManagedOperation(description = "Dispose of the current instance of all beans "
       + "in this scope and force a refresh on next method execution.")
     public void refreshAll() {
      // 调用父类的destroy
            super.destroy();
      this.context.publishEvent(new RefreshScopeRefreshedEvent());
     }
    }
    
    
    @Override
     public void destroy() {
      List<Throwable> errors = new ArrayList<Throwable>();
      Collection<BeanLifecycleWrapper> wrappers = this.cache.clear();
      for (BeanLifecycleWrapper wrapper : wrappers) {
       try {
        Lock lock = this.locks.get(wrapper.getName()).writeLock();
        lock.lock();
        try {
                        // 这里主要就是把之前的bean设置为null, 就会重新走createBean的流程了
         wrapper.destroy();
        }
        finally {
         lock.unlock();
        }
       }
       catch (RuntimeException e) {
        errors.add(e);
       }
      }
      if (!errors.isEmpty()) {
       throw wrapIfNecessary(errors.get(0));
      }
      this.errors.clear();
     }

## 总结 ##

上面是这个RefreshScope实现动态刷新大致的原理，其中里面还有很多细节，可能需要留给大家自己debug去深入理解。

[f1d62426074e9c0f669118c265be61a9.png]: https://img-blog.csdnimg.cn/img_convert/f1d62426074e9c0f669118c265be61a9.png
[50deef3a1275305ee72ac0e65b5458c3.png]: https://img-blog.csdnimg.cn/img_convert/50deef3a1275305ee72ac0e65b5458c3.png
[7186927528c675a637c8edc4cb99cd6e.png]: https://img-blog.csdnimg.cn/img_convert/7186927528c675a637c8edc4cb99cd6e.png
[58a40c21f6e45e4605c16190d842dbfb.png]: https://img-blog.csdnimg.cn/img_convert/58a40c21f6e45e4605c16190d842dbfb.png
[31a20d5a65b1bd358eb27c6c5390a374.png]: https://img-blog.csdnimg.cn/img_convert/31a20d5a65b1bd358eb27c6c5390a374.png
[3815e03be7a477a5deac37e0c13e37cf.png]: https://img-blog.csdnimg.cn/img_convert/3815e03be7a477a5deac37e0c13e37cf.png
[57bd13b7629a063d151294ce76416da8.png]: https://img-blog.csdnimg.cn/img_convert/57bd13b7629a063d151294ce76416da8.png
[3170fe75a7e4fac744aa841a5a0d9be5.png]: https://img-blog.csdnimg.cn/img_convert/3170fe75a7e4fac744aa841a5a0d9be5.png
[bbf82882456c7fc5874c24e2b2f71952.png]: https://img-blog.csdnimg.cn/img_convert/bbf82882456c7fc5874c24e2b2f71952.png