SpringBoot 配置项动态实时刷新

为了避免更改配置后重新启动应用,本文介绍了SpringBoot应用在运行时重新加载配置的方法。

方案一: 使用spring-cloud-starter-config实现

spring cloud config 不仅可以刷新远程git的配置到内存中,而且还可以结合actuator还可以刷新本地的配置文件到内存中。

  1. 添加 maven 依赖
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--用于监控和管理应用自身信息, 可以动态refresh配置-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!--用于配置管理-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

其中:
(1)spring-cloud-starter-config是为了实现刷新配置
(2)spring-boot-starter-actuator是为了暴露修改/刷新配置的接口

  1. 配置actuator 端点
management:
  server:
    port: 9001
  endpoints:
    web:
      exposure:
        include: "*"
  1. 便写获取配置的测试类
    测试使用@Enviroment 、 @Value、自定义配置类三种方式
@RestController
@RequestMapping("/api/v1/config")
@RefreshScope
public class ConfigController {
    @Autowired
    ConfigProperties configProperties;

    @Autowired
    Environment environment;

    @Value("${server.port}")
    private String port;

    @GetMapping("/getConfig")
    public Map<String, Object> getConfig() {
        Map<String, Object> data = new HashMap<>();
        data.put("AppNameInConfigProperties", configProperties.getAppName());
        data.put("PortInEnvironment", environment.getProperty("server.port"));
        data.put("PortInValue", port);
        return data;
    }
}
package com.mochi.example.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@ConfigurationProperties(prefix="mochi")
@Component
@RefreshScope
public class ConfigProperties {
    private String appName;

    public String getAppName() {
        return appName;
    }

    public void setAppName(String appName) {
        this.appName = appName;
    }
}

配置项如下:

server:
  port: 9311

mochi:
  appName: mochi-app-test

4.1. 使用HTTP请求动态更改配置

使用 curl -X GET 'http://localhost:9311/api/v1/config/getConfig' 查看配置信息

{
  AppNameInConfigProperties: "mochi-app-test",
  PortInEnvironment: "9311",
  PortInValue: "9311"
}

然后使用用 POST 请求访问 http://localhost:9001/actuator/env 来修改具体配置;使用 POST访问http://localhost:9001/actuator/refresh 进行刷新

curl -X POST -H "Content-Type:application/json" --data "{\"name\": \"mochi.appName\", \"value\": \"newappname\"}"  'http://localhost:9001/actuator/env'

curl -X POST 'http://localhost:9001/actuator/refresh'

重新获取配置信息,发现已经更新成最新值了

{
  AppNameInConfigProperties: "newappname",
  PortInEnvironment: "9311",
  PortInValue: "9311"
}

4.2 直接更改配置文件来动态刷新配置
更改 target/classes/application.yaml 中的配置,然后使用 POST访问http://localhost:9001/actuator/refresh 进行刷新即可

{
  AppNameInConfigProperties: "mochi-app-test-new2",
  PortInEnvironment: "9311",
  PortInValue: "9311"
}

方案二: 使用监听配置文件变动来实现

主要使用FileAlterationMonitor、FileAlterationObserver、FileAlterationListenerAdapter 来实现,主要流程如下,其中FileListenerAdaptor需要实现FileAlterationListenerAdapter的 onChange方法:

            // 构造观察类主要提供要观察的文件或目录,当然还有详细信息的filter
            FileAlterationObserver observer = new FileAlterationObserver(
                    new File(configPath), null, null);
            // 构造收听类
            FileListenerAdaptor listener = new FileListenerAdaptor();
            // 为观察对象添加收听对象
            observer.addListener(listener);
            // 配置Monitor,第一个参数单位是毫秒,是监听的间隔;第二个参数就是绑定我们之前的观察对象。
            FileAlterationMonitor fileMonitor = new FileAlterationMonitor(
                    1000, new FileAlterationObserver[]{observer});

            // 启动开始监听
            fileMonitor.start();

更多干货,欢迎关注个人博客:http://mochi.website/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342