您当前的位置：首页 >> 家居装修

SpringCloud 配置动态刷新 @RefreshScope 原文

2023-04-21 12:16:26

2. @RefreshScope评注@Target({ ElementType.TYPE, ElementType.METHOD })@Retention(RetentionPolicy.RUNTIME)@Scope("refresh")@Documentedpublic @interface RefreshScope { /** * @see Scope#proxyMode() */ ScopedProxyMode proxyMode() default ScopedProxyMode.TARGET_CLASS;}

它适用就是 @Scope ，一个scopeName="refresh"的@Scope。

proxyMode个数为ScopedProxyMode.TARGET_CLASS，通过CGLIB特性全都权全由的方式聚合Bean。

适用 @RefreshScope 评注的 bean，不仅但会聚合一个beanName的bean，意味着情况同时但会聚合 scopedTarget.beanName的 bean。

@RefreshScope不用原则上适用，需要和其他其他bean评注相辅相成适用，如：@Controller、@Service、@Component、@Repository等。

3. Scope模块public interface Scope { /** * Return the object with the given name from the underlying scope, * {@link org.springframework.beans.factory.ObjectFactory#getObject() creating it} * if not found in the underlying storage mechanism. *

This is the central operation of a Scope, and the only operation * that is absolutely required. * @param name the name of the object to retrieve * @param objectFactory the {@link ObjectFactory} to use to create the scoped * object if it is not present in the underlying storage mechanism * @return the desired object (never {@code null}) * @throws IllegalStateException if the underlying scope is not currently active */ Object get(String name, ObjectFactory objectFactory); @Nullable Object remove(String name); void registerDestructioncallback(String name, Runnable callback); @Nullable Object resolveContextualObject(String key); @Nullable String getConversationId();}Object get(String name, ObjectFactory objectFactory)

这个方式借助我们来创设一个一新的bean ，反之亦然，@RefreshScope 在命令行创出的的时候但会适用此方式来给我们创设一新的并不一定，这样就可以通过spring 的安装机制将类型原先的流向了，也就发挥起着了所谓的特性创出的。

RefreshScope extends GenericScope, GenericScope implements ScopeMLT-

GenericScope 发挥起着了 Scope 最重要的 get(String name, ObjectFactory objectFactory) 方式，在GenericScope 之中面包装了一个内部类 BeanLifecycleWrapperCache 来对加了 @RefreshScope 从而创设的并不一定进行时文件系统，使其在不创出的时受益的都是同一个并不一定。（这之中你可以把 BeanLifecycleWrapperCache 想像成为一个大Map 文件系统了所有@RefreshScope 标记的并不一定）

知道了并不一定是文件系统的，所以在进行时特性创出的的时候，只需要清扫文件系统，原先的创设就好了。

// ContextRefresher 外面适用它来进行时方式命令行 ============================== 我是分割线 public synchronized Set refresh() { Set 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 之中的方式 ============================== 我是分割线 //进行时并不一定受益，如果很难就创设并放到文件系统 @Override public 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; } } // 模板Bean public Object getBean() { if (this.bean == null) { String var1 = this.name; synchronized(this.name) { if (this.bean == null) { this.bean = this.objectFactory.getObject(); } } } return this.bean; } //进行时文件系统的数据清扫 @Override public void destroy() { List errors = new ArrayList(); Collection 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类之中有一个成员表达式BeanLifecycleWrapperCache，可用文件系统所有早就聚合的Bean，在命令行get方式时尝试从文件系统查找，如果很难的话就聚合一个一新并不一定放到文件系统，并通过模板getBean其完全相同的Bean。

destroy 方式全由于是又创出的时文件系统的清扫临时工。丢弃文件系统后，下基辛格并不一定时就但会原先的创设一新的并不一定并放到文件系统了。

所以在原先的创设一新的并不一定时，也就受益了最一新的配有，也就远超了配有创出的的目的。

4. @RefreshScope 发挥起着工序需要特性创出的的类标记@RefreshScope 评注。@RefreshScope 评注标记了@Scope 评注，并意味着了ScopedProxyMode.TARGET_CLASS; 类型，此类型的功能就是于是又创设一个全都权全由，在每次命令行的时候都用它来命令行GenericScope get 方式来受益并不一定。如类型牵涉到原有命令行 ContextRefresher refresh() ；还有>> RefreshScope refreshAll() 进行时文件系统清扫方式命令行；发送创出的惨剧通报，GenericScope 或许的清扫方式destroy() 发挥起着清扫文件系统。在下一次适用并不一定的时候，但会命令行GenericScope get(String name, ObjectFactory objectFactory) 方式创设一个一新的并不一定，并取走文件系统之中，此时一新并不一定因为Spring 的安装机制就是一新的类型了。5. @RefreshScope理论概述

1.SpringCloud程序的存在一个自动安装的类，这个类意味着情况但会自动模板一个RefreshScope下述，该下述是GenericScope的子类，然后申领到密封之中。（RefreshAutoConfiguration.java,）

2.当密封顺利完成的时候，GenericScope但会自己把自己申领到scope之中（ConfigurableBeanFactory#registerScope）（GenericScope）

3.然后当自表述的Bean（被@RefreshScope；也）申领的时候，但会被密封存到时其std为refresh。(AnnotatedBeanDefinitionReader#doRegisterBean)

通过纸片三步，一个带有@RefreshScope的自表述Bean就被申领到密封之中来，其std为refresh。

4.当我们在此此后进行时以来查找的时候，但会绕过Singleton和Prototype分支，进入终于一个分支，通过命令行Scope模块的get()受益到该refreshstd的下述。（AbstractBeanFactory.doGetBean）

二、@RefreshScope同样事项1. @RefreshScope适用同样事项@RefreshScope起着的类，不用是final类，否则顺利完成时但会报错。@RefreshScope不用原则上适用，需要和其他其他bean评注相辅相成适用，如：@Controller、@Service、@Component、@Repository、@Configuration等。@RefreshScope 最好不要；也在 @Scheduled、listener、Timmer等类之中,因为配有的创出的但会引发原本的并不一定被清扫，需要原先的适用并不一定才能出发聚合一新并不一定（但因为并不一定没了，又没法原先的适用并不一定，死循环）2. @RefreshScope特性创出的失效

考虑适用的bean是否是@RefreshScope聚合的那个scopedTarget.beanName的 bean

springboot某些低版本貌似有缺陷，在Controller类上适用不但会颁布（网上有这么说的，没具体学术研究）

应付方式1：评注上加类型@RefreshScope(proxyMode = ScopedProxyMode.DEFAULT)应付方式2：从举例来说适用其他类原则上封安装有参数，适用@RefreshScope+@Value方式应付方式3：从举例来说适用@ConfigurationProperties3. 不适用@RefreshScope也能发挥起着特性创出的

从举例来说适用@ConfigurationProperties，并不需要加@RefreshScope就能发挥起着特性更一新。

@ConfigurationProperties发挥起着特性创出的的理论：

@ConfigurationProperties有ConfigurationPropertiesRebinder这个国安局器，国安局着EnvironmentChangeEvent惨剧。当牵涉到EnvironmentChange惨剧后，但会原先的构造原本的加了@ConfigurationProperties评注的Bean并不一定。这个是Spring Cloud的意味着发挥起着。

4. 动态表达式借助@RefreshScope特性创出的的内壁（求得大佬解答）@RefreshScope@Componentpublic class TestConfig { public static int url; @Value("${pesticide.url}") public void setUrl(int url) { TestConfig.url = url; } public void getUrl() { }}@RestController@RequestMapping("test")public class TestController { @Autowired private TestConfig testConfig; @GetMapping("testConfig") public int testConfig(){ System.out.println("TestConfig:"+ TestConfig.url); testConfig.getUrl(); System.out.println("TestConfig:"+ TestConfig.url); return TestConfig.url; }}1.url初始配有的个数为1

催促模块会话：

TestConfig:1TestConfig:12.改写url配有的个数为2，特性创出的事与愿违

催促模块会话：

TestConfig:1TestConfig:2

这之中就显现出了缺陷，不命令行@RefreshScope生产的全都权全由并不一定testConfig的方式前（同样，该方式内无代码），到时的个数还是为1；调了此后，到时的个数为2.在此此后终于催促模块，到时的个数都为2。

TestConfig:2TestConfig:2TestConfig:2TestConfig:2

同样大胆反例主因：概要纸片@RefreshScope 发挥起着工序可知，在第2步骤特性创出的事与愿违时，此时某种程度是于是又创设类一个全都权全由并不一定，并清扫了实际并不一定的文件系统；当终于通过全都权全由并不一定来适用，才但会启动时创设一个一新的下述并不一定，此时才但会更一新url的个数。所以适用动态表达式来是发挥起着特性创出的时，一点要同样：适用并不一定才能出发创设一新的实际并不一定，更一新动态表达式的个数。

Spring Cloud的概要文件指出：

@RefreshScope在@Configuration类上临时工，但也许引发令人惊讶的行为：例如，这并不显然该类之中表述的所有@Beans本身都是@RefreshScope。具体来说，忽视于这些bean的任何东西都不用忽视于创出的顺利完成时对其进行时更一新，除非它本身在@RefreshScope之中从创出的的@Configuration原先的模板（在创出的之中将其重建并原先的流向其忽视项，此时它们将被创出的）。

三、适用@RefreshScope的bean缺陷

这之中之所以要但会探讨适用@RefreshScope的bean缺陷，由纸片纸片所说什么可以概述受益：

适用 @RefreshScope 评注的 bean，不仅但会聚合一个取名为beanName的bean，意味着情况同时但会聚合取名为scopedTarget.beanName的bean适用 @RefreshScope 评注的但会聚合一个全都权全由并不一定，通过这个全都权全由并不一定来命令行取名为scopedTarget.beanName的 bean创出的操控但会引发原本的取名为scopedTarget.beanName的bean被清扫，终于适用但会一新聚合一新的取名为scopedTarget.beanName的bean，但原本的全都权全由并不一定不但会变动

下面比如说：

nacos配有

test: value: 1

配有类受益配有个数

@Data@Component@RefreshScopepublic class TestConfig { @Value("${test.value}") private String value;}

次测试模块

@RestControllerpublic class TestController { @Autowired private TestConfig testConfig; @RequestMapping("test11") public void test11() { // 全都权全由并不一定 System.out.println("@Autowired bean==========" + testConfig.getClass().getName()); // 全都权全由并不一定 TestConfig bean = SpringUtils.getBean(TestConfig.class); System.out.println("Class bean==========" + bean.getClass().getName()); // 全都权全由并不一定 Object bean1 = SpringUtils.getBean("testConfig"); System.out.println("name(testConfig) bean==========" + bean1.getClass().getName()); // 原类并不一定 Object bean2 = SpringUtils.getBean("scopedTarget.testConfig"); System.out.println("name(scopedTarget.testConfig) bean==========" + bean2.getClass().getName()); System.out.println("================================================================================"); }}

次测试

@Autowired流向的是全都权全由并不一定

通过Class受益的是全都权全由并不一定通过取名为beanName的受益的是全都权全由并不一定通过取名为scopedTarget.beanName的受益的是由@RefreshScope聚合的那个原类并不一定

改写配有的个数，次测试

test: value: 2

特性创出的后，全都权全由并不一定很难变立体化，由@RefreshScope聚合的那个原类并不一定被清扫后原先的聚合了一个一新的原类并不一定

小结：@Autowired方式流向的是全都权全由并不一定beanName的受益的是全都权全由并不一定scopedTarget.beanName的受益的@RefreshScope聚合的那个原类并不一定全都权全由并不一定不但会随着配有创出的而更一新@RefreshScope聚合的那个原类并不一定但会随着配有的创出的而更一新（类型时清扫原本的，适用时才聚合一新的）四、其它配有创出的方式

这种方式只能有 spring-boot-starter-actuator 这个starter若无。

POST

refresh的顶层理论详见:org.springframework.cloud.context.refresh.ContextRefresher#refresh

SpringCloud2.0以后，很难/refresh手动命令行的创出的配有邮箱。

SpringCloud2.0前

加入忽视

org.springframework.boot spring-boot-starter-actuator

在类上，表达式上打上@RefreshScope的评注

在顺利完成的时候，都但会见到

RequestMappingHandlerMapping : Mapped "{/refresh,methods=[post]}"

也就是SpringCloud沾染了一个模块 /refresh 来给我们去创出的配有，但是SpringCloud 2.0.0以后，有了偏离。

SpringCloud 2.0后