SpringCloud @RefreshScope刷新机制源码分析

今天小编给大家分享一下SpringCloud @RefreshScope刷新机制源码分析的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。

一、前言

用过spring cloud的同学都知道在使用动态配置刷新的我们要配置一个@RefreshScope 在类上才可以实现对象属性的的动态更新，本着知其所以然的态度，晚上没事儿又把这个点回顾了一下，下面就来简单的说下自己的理解。

总览下，实现@RefreshScope 动态刷新的就需要以下几个：

• @ Scope

• @RefreshScope

• RefreshScope

• GenericScope

• Scope

• ContextRefresher

二、@Scope

一句话，@RefreshScope 能实现动态刷新全仰仗着@Scope 这个注解，这是为什么呢？

@Scope 代表了Bean的作用域，我们来看下其中的属性：

@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface Scope {@AliasFor("scopeName")String value() default "";@AliasFor("value")String scopeName() default "";ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;}

通过代码我们可以清晰的看到两个主要属性value 和 proxyMode，value就不多说了，大家平时经常用看看注解就可以。proxyMode 这个就有意思了，而这个就是@RefreshScope 实现的本质了。

我们需要关心的就是ScopedProxyMode.TARGET_CLASS 这个属性，当ScopedProxyMode 为TARGET_CLASS 的时候会给当前创建的bean 生成一个代理对象，会通过代理对象来访问，每次访问都会创建一个新的对象。

理解起来可能比较晦涩，那先来看下实现再回头来看这句话。

三、RefreshScope 的实现原理

先来看下@RefreshScope

@Target({ ElementType.TYPE, ElementType.METHOD })@Retention(RetentionPolicy.RUNTIME)@Scope("refresh")@Documentedpublic @interface RefreshScope {ScopedProxyMode proxyMode() default ScopedProxyMode.TARGET_CLASS;}

可以看出，它使用就是 @Scope ，其内部就一个属性默认 ScopedProxyMode.TARGET_CLASS。知道了是通过spring Scope 来实现的那就简单了，我们来看下Scope 这个接口

public interface Scope {Object get(String name, ObjectFactory<?> objectFactory);@NullableObject remove(String name);void reGISterDestructionCallback(String name, Runnable callback);@NullableObject resolveContextualObject(String key);@NullableString getConversationId();}

看下接口，我们只看Object get(String name, ObjectFactory<?> objectFactory); 这个方法帮助我们来创建一个新的bean ，也就是说，@RefreshScope 在调用 刷新的时候会使用此方法来给我们创建新的对象，这样就可以通过spring 的装配机制将属性重新注入了，也就实现了所谓的动态刷新。

那它究竟是怎么处理老的对象，又怎么除法创建新的对象呢？

在开头我提过几个重要的类，而其中 RefreshScope extends GenericScope, GenericScope implements Scope。

所以通过查看代码，是GenericScope 实现了 Scope 最重要的 get(String name, ObjectFactory<?> objectFactory) 方法，在GenericScope 里面 包装了一个内部类 BeanLifecycleWrapperCache 来对加了 @RefreshScope 从而创建的对象进行缓存，使其在不刷新时获取的都是同一个对象。（这里你可以把 BeanLifecycleWrapperCache 想象成为一个大Map 缓存了所有@RefreshScope 标注的对象）

知道了对象是缓存的，所以在进行动态刷新的时候，只需要清除缓存，重新创建就好了。

来看代码，眼见为实，只留下关键方法：

// ContextRefresher 外面使用它来进行方法调用 ============================== 我是分割线public synchronized Set<String> refresh() {Set<String> keys = refreshEnvironment();this.scope.refreshAll();return keys;}// RefreshScope 内部代码  ============================== 我是分割线@ManagedOperation(description = "Dispose of the current instance of all beans in this scope and force a refresh on next method execution.")public void refreshAll() {super.destroy();this.context.publishEvent(new RefreshScopeRefreshedEvent());}// GenericScope 里的方法 ============================== 我是分割线//进行对象获取，如果没有就创建并放入缓存@Overridepublic Object get(String name, ObjectFactory<?> objectFactory) {BeanLifecycleWrapper value = this.cache.put(name,new BeanLifecycleWrapper(name, objectFactory));locks.putIfAbsent(name, new ReentrantReadWriteLock());try {return value.getBean();}catch (RuntimeException e) {this.errors.put(name, e);throw e;}}//进行缓存的数据清理@Overridepublic void destroy() {List<Throwable> errors = new ArrayList<Throwable>();Collection<BeanLifecycleWrapper> wrappers = this.cache.clear();for (BeanLifecycleWrapper wrapper : wrappers) {try {Lock lock = locks.get(wrapper.getName()).writeLock();lock.lock();try {wrapper.destroy();}finally {lock.unlock();}}catch (RuntimeException e) {errors.add(e);}}if (!errors.isEmpty()) {throw wrapifNecessary(errors.get(0));}this.errors.clear();}

通过观看源代码我们得知，我们截取了三个片段所得之，ContextRefresher 就是外层调用方法用的，GenericScope 里面的 get 方法负责对象的创建和缓存，destroy 方法负责再刷新时缓存的清理工作。

以上就是“SprinGCloud @RefreshScope刷新机制源码分析”这篇文章的所有内容，感谢各位的阅读！相信大家阅读完这篇文章都有很大的收获，小编每天都会为大家更新不同的知识，如果还想学习更多的知识，请关注编程网精选频道。