Spring Cloud Config 怎么实现动态刷新配置-Git WebHooks

当我们对配置内容做了修改,Spring Cloud Config怎么来进行实时更新呢?

  • 我们使用前两节中创建的config-server和config-client两个服务来继续实现本节内容
现状

1.先把config-server和config-client都启动起来
然后访问:http://localhost:7001/config-client/test来获取我们之前配置的内容spring.datasource.url的值,内容如下:

image.png

因为我们刚刚请求的是configtest-dev.properties文件,所以现在我们把configtest-dev.properties文件修改一下,把值改为jdbc:mysql://dev:3307/,端口号变成3307,修改完后,Push到Git仓库中。
image.png
我们可以看到仓库中的值已经改变,现在我们在重新请求一下http://localhost:7001/config-client/test,发现请求到还是之前的值,并没有后去到新的值。
image.png

先实现"手动"刷新配置
  • 修改config-client工程
  1. 编辑pom.xml,添加
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2.修改application.yml文件,将endpoint信息全部暴露出来

management:
  endpoints:
    web:
      exposure:
        include: "*"

3.修改TestController,添加@RefreshScope实现配置和实例刷新

@RestController
@RefreshScope
@RequestMapping(value = "/config-client")
public class TestController {

    @Value("${spring.datasource.url}")
    private String url;

    @GetMapping(path = "/test")
    public String getSence() {
        return url;
    }
}

到这一步就已经实现手动刷新配置了。

测试

重启config-client,访问:http://localhost:7001/config-client/test

image.png
可以看到当前获取到的值为jdbc:mysql://dev:3306/

再次configtest-dev.properties文件修改一下,把值改为jdbc:mysql://dev:3309/,端口号变成3309,修改完后,Push到Git仓库中。

image.png

可以看到Git仓库中已经变成了jdbc:mysql://dev:3309/
再次访问:http://localhost:7001/config-client/test 发现获取到的值还是3306,没有发生任何改变,怎么办呢?
下面我们就可以来手动刷新了,通过POST(我这里使用的Postman工具)发送请求到:http://localhost:7001/actuator/refresh
image.png
返回内容代表了被更新的参数。
现在我们在来重新访问:http://localhost:7001/config-client/test 就可以看到更新后配置内容了。
image.png

实现动态刷新

动态刷新的两种实现方式
1.基于Git的WebHooks
2.Spring Cloud Bus
本节使用基于Git的WebHooks的方式实现动态刷新,后边的章节在来使用Spring Cloud Bus来实现动态刷新。

使用Git仓库的WebHooks来实现动态刷新,避免手动刷新,当有Git提交变化时,就会给对应的配置主机发送/actuator/refresh请求来实现配置信息的实时更新。

image.png

找到我们对应的仓库,进行设置WebHooks,填入URL后就可以在内容变更后发送 HTTP / HTTPS 的目标通知地址,就是我们刚刚说的http://localhost:7001/actuator/refresh

踩坑

在Git WebHooks 发送通知的时候报错了

image.png
在Postman中调用请求地址是没问题的,于是查找了一些资料发现是因为GitHub在进行post请求的同时默认会在body加上这么一串载荷(payload),spring boot因为无法正常反序列化这串载荷而报了400错误,参考了https://blog.csdn.net/m0_37556444/article/details/82812816
这篇文章,感谢文章博主的分享。
1.添加CustometRequestWrapper类

public class CustometRequestWrapper extends HttpServletRequestWrapper {
    public CustometRequestWrapper(HttpServletRequest request) {
        super(request);
    }

    @Override
    public ServletInputStream getInputStream() throws IOException {
        byte[] bytes = new byte[0];
        ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes);

        return new ServletInputStream() {
            @Override
            public boolean isFinished() {
                return byteArrayInputStream.read() == -1 ? true:false;
            }

            @Override
            public boolean isReady() {
                return false;
            }

            @Override
            public void setReadListener(ReadListener readListener) {

            }

            @Override
            public int read() throws IOException {
                return byteArrayInputStream.read();
            }
        };
    }
}

2.添加Filter

@Component
public class Filter implements javax.servlet.Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest)servletRequest;

        String url = httpServletRequest.getRequestURI();

        //只过滤/actuator/refresh请求
        if (!url.endsWith("/refresh")) {
            filterChain.doFilter(servletRequest, servletResponse);
            return;
        }

        //使用HttpServletRequest包装原始请求达到修改post请求中body内容的目的
        CustometRequestWrapper requestWrapper = new CustometRequestWrapper(httpServletRequest);

        filterChain.doFilter(requestWrapper, servletResponse);
    }

    @Override
    public void destroy() {

    }
}
测试

因为WebHooks的URL地址不能写localhost和127.0.0.1的这些地址,我把config-server和config-client两个服务打包,部署到了服务器上,来看效果。
1.先访问一下http://59.110.164.147:7001/config-client/test(59.110.164.147修改为自己的服务器地址)

image.png
内容为jdbc:mysql://dev:3309/
下面再次configtest-dev.properties文件修改一下,把值改为jdbc:mysql://dev:3310/,端口号变成3310,修改完后,Push到Git仓库中。
image.png
可以看到Git仓库中的值已经变成了jdbc:mysql://dev:3310/
再次访问:http://xxx.xxx.xxx.xxx:7001/config-client/test
image.png
可以看到已经获取到了最新的配置信息,同时也可以到仓库中看到推送信息
image.png

image.png

如果后期系统发展到非常庞大的地步,维护这样的刷新清单将会成为一个非常大的负担,而且容易出错,针对这样的问题,可以通过Spring Cloud Bus来实现以消息总线的方式进行配置变更的通知,并完成集群上的批量配置更新,后续章节中会使用Spring Cloud Bus来实现动态刷新配置。

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

推荐阅读更多精彩内容