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，添加

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

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来实现动态刷新配置。