快捷導(dǎo)航

SpringBoot兩種方式刷新配置信息

更新時間：2023年08月24日 14:41:58 作者：_不吃貓的魚_

這篇文章主要介紹了SpringBoot兩種方式刷新配置信息,一種是@?ConfigurationProperties?不能自動刷新，需要手動調(diào)用contextRefresher.refresh()方法來刷新配置，第二種方法可以嘗試下，需要的朋友可以參考下

一、第一種方式

@?ConfigurationProperties?不能自動刷新，需要手動調(diào)用contextRefresher.refresh()方法來刷新配置。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "biz")
public class BizConfig {
    private String key;
    private Long refresh;
    //省略 gettersetter...
}

二、第二種方式

@RefreshScope 注解可以使得這個類具備刷新功能，可以在配置文件內(nèi)容變更后，刷新并更新這個配置類的屬性值。

 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;
/**
 *
 * @RefreshScope 注解可以使得這個類具備刷新功能，可以在配置文件內(nèi)容變更后，刷新并更新這個配置類的屬性值。使用@RefreshScope注解，僅僅只能刷新@Value的配置屬性。
 *
 * 在這個配置類中，使用了 @Value 注解注入了一個屬性 uuid，該屬性的值來源于配置文件中 rest.uuid 屬性的值。
 * 由于該配置類使用了 @RefreshScope 注解，所以如果配置文件中 rest.uuid 的值發(fā)生變化，
 * Spring Cloud Config Server 就會通知該配置類，然后調(diào)用 setUuid() 方法刷新該屬性的值，從而實現(xiàn)了動態(tài)刷新配置的效果。
 *
 *
 * 如果使用@RefreshScope注解，僅僅只能刷新@Value的配置屬性，
 * 而對于@ConfigurationProperties則不能自動刷新，需要手動調(diào)用contextRefresher.refresh()方法來刷新配置。
 *
 * 因此，在DemoController中的refresh()方法，通過開啟一個新的線程來異步調(diào)用contextRefresher.refresh()方法，
 * 實現(xiàn)對@ConfigurationProperties的刷新。這樣就可以保證對于@Value和@ConfigurationProperties兩種配置屬性都可以進行刷新。
 */
@RefreshScope
@Component
public class ValueConfig {
    @Value("${rest.uuid}")
    private String uuid;
   // 省略 gettersetter
}

使用 contextRefresher.refresh() 刷新

import com.alibaba.fastjson.JSONObject;
import com.lfsun.bootdynamicrefresh.config.BizConfig;
import com.lfsun.bootdynamicrefresh.config.ValueConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.context.refresh.ContextRefresher;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class DemoController {
    @Autowired
    private ContextRefresher contextRefresher;
    @Autowired
    private BizConfig bizConfig;
    @Autowired
    private ValueConfig valueConfig;
    /**
     * 查詢配置信息
     */
    @GetMapping(path = "/show")
    public String show() {
        JSONObject res = new JSONObject();
        res.put("biz", JSONObject.toJSONString(bizConfig));
        res.put("uuid", valueConfig.getUuid());
        return res.toJSONString();
    }
    /**
     * 刷新配置信息
     */
    @GetMapping(path = "/refresh")
    public String refresh() {
        // 新開一個線程進行配置信息的刷新，避免阻塞其他請求的處理
        new Thread(() -> contextRefresher.refresh()).start();
        // 返回刷新后的配置信息
        return show();
    }
}

配置文件 application.yml

biz:
  refresh: ${random.long}
  key: refresh-test
rest:
  uuid: ${random.uuid}
server:
  port: 8081

pom.xml

 <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-context</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

實現(xiàn)效果

http://localhost:8081/show/