[菜鸟SpringCloud实战入门]第七章：配置中心客户端主动刷新机制 + 配置中心服务化和高可用改造

秒速五厘米 2022-03-06 05:54 122阅读 0赞

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxeHg2NjYx_size_16_color_FFFFFF_t_70]

# 前言 #

欢迎来到菜鸟SpringCloud实战入门系列(SpringCloudForNoob)，该系列通过层层递进的实战视角，来一步步学习和理解SpringCloud。

本系列适合有一定Java以及SpringBoot基础的同学阅读。

每篇文章末尾都附有本文对应的Github源代码，方便同学调试。

Github仓库地址：

[https://github.com/qqxx6661/springcloud\_for\_noob][https_github.com_qqxx6661_springcloud_for_noob]

# 菜鸟SpringCloud实战入门系列 #

你可以**通过以下两种途径查看菜鸟SpringCloud实战入门系列**：

*  关注我的公众号：Rude3Knife 点击公众号下方：技术推文——SpringCloud
 *  [菜鸟SpringCloud实战入门专栏导航页(CSDN)][SpringCloud_CSDN]

**前文回顾：**

*  [\[菜鸟SpringCloud实战入门\]第一章：构建多模块的Maven项目+创建注册中心Eureka子模块][SpringCloud_Maven_Eureka]
 *  [\[菜鸟SpringCloud实战入门\]第二章：创建服务提供者并在Eureka进行注册][SpringCloud_Eureka]
 *  [\[菜鸟SpringCloud实战入门\]第三章：将Eureka改造为高可用集群][SpringCloud_Eureka 1]
 *  [\[菜鸟SpringCloud实战入门\]第四章：远程调用服务实战][SpringCloud]
 *  [\[菜鸟SpringCloud实战入门\]第五章：熔断器Hystrix的使用 + 可视化监控Hystrix Dashboard和Turbine][SpringCloud_Hystrix_ _ _Hystrix Dashboard_Turbine]
 *  [\[菜鸟SpringCloud实战入门\]第六章：配置中心Spring Cloud Config初体验][SpringCloud_Spring Cloud Config]
 *  …更多文章请查看上方：菜鸟SpringCloud入门实战专栏导航页

# 实战版本 #

*  SpringBoot：2.0.3.RELEASE
 *  SpringCloud：Finchley.RELEASE

# \-----正文开始----- #

## 配置中心客户端主动刷新机制 + 配置中心服务化和高可用改造 ##

### 客户端Refresh：客户端主动获取配置信息 ###

经过上一章节配置好Spring Cloud Config后，客户端（config-client模块）能够获得从服务端（config-server模块）传来的配置文件信息。

文末写出了一个问题，客户端并不能获取更新后的配置信息，想要刷新信息，必须重启config-client模块，这显然不切实际。

#### 实验：验证客户端无法更新 ####

下面做一个实验，启动客户端和服务端，随后更新dev配置文件，新加了（new）：

![在这里插入图片描述][20190317231653313.png]

随后push到远程仓库，我们再次直接访问服务端的 [http://localhost:8769/spring-cloud-config-dev.properties][http_localhost_8769_spring-cloud-config-dev.properties] ：

![在这里插入图片描述][20190317231648992.png]

发现更新成了新的配置文件。

之后访问客户端：

![在这里插入图片描述][20190317231644750.png]

发现依然是老的配置文件信息，客户端只在启动时获取了当时的配置文件信息。

#### 开启更新机制 ####

我们只需要在config-server模块中进行改动。

实现Refresh机制需要添加依赖spring-boot-starter-actuator，这个依赖在我们的root模块中就已经添加，在config-server模块就不需要重复添加了。如果你在root父模块没有添加，那么就需要加上。

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

**大坑：**

**对需要刷新的类加上注解@RefreshScope**：

当配置更改时，标有@RefreshScope的Bean将得到特殊处理来生效配置。

**注意这里不是直接加载主类上，除非你的controller写在了主类里。**

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RefreshScope
    public class HelloController {
        @Value("${config.hello}")
        private String hello;
    
        @RequestMapping("/hello")
        public String from() {
            return this.hello;
        }
    }

对于springboot 1.5.X 以上版本，需要在配置文件中关闭安全认证。

management.security.enabled=false

对于springboot 2，上述配置不起作用，需要修改server端配置文件，将端口暴露：

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

还要将客户端端口暴露：

management:
      endpoints:
        web:
          exposure:
            include: refresh

**测试：**

我们开启服务端和客户端，先测试下未更新前获取的配置信息：

![在这里插入图片描述][20190317231636175.png]

随后我们修改配置文件并push：

![在这里插入图片描述][201903172316324.png]

然后**以post请求**访问 `curl -v -X POST "http://localhost:8002/actuator/refresh"` ：

![在这里插入图片描述][20190317231627900.png]  
得到了：

![在这里插入图片描述][20190317231623740.png]

如果在不变更的情况下，再次发送POST请求：

![在这里插入图片描述][20190317231619534.png]

#### 使用Webhook监听配置更新 ####

> WebHook是当某个事件发生时，通过发送http post请求的方式来通知信息接收方。Webhook来监测你在Github.com上的各种事件，最常见的莫过于push事件。如果你设置了一个监测push事件的Webhook，那么每当你的这个项目有了任何提交，这个Webhook都会被触发，这时Github就会发送一个HTTP POST请求到你配置好的地址。

> 如此一来，你就可以通过这种方式去自动完成一些重复性工作，比如，你可以用Webhook来自动触发一些持续集成（CI）工具的运作，比如Travis CI；又或者是通过 Webhook 去部署你的线上服务器。下图就是github上面的webhook配置。

这种机制适用于只有少数微服务的情况，在大量未服务的情况下，这种机制就显得捉襟见肘。

#### 消息总线机制 ####

如果项目少配置少的情况可以通过/refresh来手动刷新配置，如果项目比较复杂的情况呢这种肯定是行不通的，Spring Cloud Bus消息总线可以解决配置修改的真正的动态刷新。我们放在下一章进行学习。

### 配置中心服务化和高可用改造 ###

目前我们的两个子模块config-server和config-client是相互耦合的，client需要输入server的地址来调用它，这样的调用违反了低耦合原则（低耦合：就是A模块与B模块存在依赖关系，那么当B发生改变时，A模块仍然可以正常工作，那么就认为A与B是低耦合的。）

现在我们就是用之前学习的Eureka来对配置中心进行改造。

#### 服务端改造 ####

改造集中在两方面，一个是在注册中心注册，一个是开启多个服务端达到高可用的目的。

添加依赖（由于eureka的依赖在我们的父模块已经添加，所以对于config-server模块我们不需要改动）：

<dependencies>
    	<dependency>
    		<groupId>org.springframework.cloud</groupId>
    		<artifactId>spring-cloud-config-server</artifactId>
    	</dependency>
    	<dependency>
    		<groupId>org.springframework.cloud</groupId>
    		<artifactId>spring-cloud-starter-eureka</artifactId>
    	</dependency>
    </dependencies>

配置文件新增注册配置：

server:
      port: 8769
    spring:
      application:
        name: spring-cloud-config-server
      cloud:
        config:
          server:
            git:
              uri: https://xxxxxxxxxxx.git # 配置git仓库的地址
              search-paths: config-repo                              # git仓库地址下的相对地址，可以配置多个，用,分割。
              username: xxxxxx                                     # git仓库的账号
              password: xxxxx                                   # git仓库的密码
    # 客户端调用需要
    management:
      endpoints:
        web:
          exposure:
            include: "*"
    eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:8761/eureka/

启动类添加@EnableDiscoveryClient:

@SpringBootApplication
    @EnableConfigServer
    @EnableDiscoveryClient
    public class ConfigServerApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigServerApplication.class, args);
        }
    }

#### 客户端改造 ####

依赖修改：同服务端相同，我们不需要修改，父模块将注册中心等都已经引入（见第一章）

启动类添加@EnableDiscoveryClient：同上。

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    @SpringBootApplication
    @EnableDiscoveryClient
    public class ConfigClientApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigClientApplication.class, args);
        }
    
    }

配置文件yml修改：

在前面我们给config-client子模块配置了两个yml文件，一个是传统application.yml一个是bootstrap.yml，bootstrap.yml的启动优先于application.yml

我们修改bootstrap.yml，添加注册中心配置，并将config的配置加上：

*  spring.cloud.config.discovery.enabled ：开启Config服务发现支持
 *  spring.cloud.config.discovery.serviceId ：指定server端的name,也就是server端spring.application.name的值
 *  删除spring.cloud.config.uri

spring:
      cloud:
        config:
          name: spring-cloud-config
          profile: dev
          label: master
          discovery:
            enabled: true
            service-id: spring-cloud-config-server
    eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:8761/eureka/

随后我们启动三个模块：

*  Eureka子模块
 *  config-server
 *  config-client

![在这里插入图片描述][2019031723161321.png]

查看Eureka状态 [http://localhost:8761/][http_localhost_8761] ：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxeHg2NjYx_size_16_color_FFFFFF_t_70 1]

为了达成高可用，我们将config-server的端口号再修改为8770，启动一个新的config-server，这样就有两个config-server同时为我们服务。

调用客户端接口：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxeHg2NjYx_size_16_color_FFFFFF_t_70 2]

### 本章代码 ###

[https://github.com/qqxx6661/springcloud\_for\_noob/tree/master/07-config-server-config-client-eureka][https_github.com_qqxx6661_springcloud_for_noob_tree_master_07-config-server-config-client-eureka]

### 参考 ###

[http://www.ityouknow.com/springcloud/2017/05/23/springcloud-config-svn-refresh.html][http_www.ityouknow.com_springcloud_2017_05_23_springcloud-config-svn-refresh.html]

[https://blog.csdn.net/youanyyou/article/details/78993060][https_blog.csdn.net_youanyyou_article_details_78993060]

[http://www.ityouknow.com/springcloud/2017/05/25/springcloud-config-eureka.html][http_www.ityouknow.com_springcloud_2017_05_25_springcloud-config-eureka.html]

# \-----正文结束----- #

**菜鸟SpringCloud实战入门专栏全导航：通过以下两种途径查看**

*  关注我的公众号：Rude3Knife 点击公众号下方：技术推文——SpringCloud
 *  [菜鸟SpringCloud实战专栏(CSDN)][SpringCloud_CSDN]

# 关注我 #

我是蛮三刀把刀，后端开发。主要关注后端开发，数据安全，爬虫等方向。

来微信和我聊聊：yangzd1102

Github个人主页：

[https://github.com/qqxx6661][https_github.com_qqxx6661]

### 原创博客主要内容 ###

*  Java知识点复习全手册
 *  Leetcode算法题解析
 *  剑指offer算法题解析
 *  Python爬虫相关技术实战
 *  后端开发相关技术实战
 *  SpringCloud实战

**同步更新公众号及以下全部博客：**

**1. Csdn**

[http://blog.csdn.net/qqxx6661][http_blog.csdn.net_qqxx6661]

**2. 知乎**

[https://www.zhihu.com/people/yang-zhen-dong-1/][https_www.zhihu.com_people_yang-zhen-dong-1]

**3. 掘金**

[https://juejin.im/user/5b48015ce51d45191462ba55][https_juejin.im_user_5b48015ce51d45191462ba55]

**4. 简书**

[https://www.jianshu.com/u/b5f225ca2376][https_www.jianshu.com_u_b5f225ca2376]

### 个人公众号：Rude3Knife ###

![个人公众号：Rude3Knife][Rude3Knife]

**如果文章对你有帮助，不妨收藏起来并转发给您的朋友们~**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxeHg2NjYx_size_16_color_FFFFFF_t_70]: /images/20220306/c05ad4eb6ff8427ca611f6dc913fe11f.png
[https_github.com_qqxx6661_springcloud_for_noob]: https://github.com/qqxx6661/springcloud_for_noob
[SpringCloud_CSDN]: https://blog.csdn.net/qqxx6661/column/info/35018
[SpringCloud_Maven_Eureka]: https://blog.csdn.net/qqxx6661/article/details/88367149
[SpringCloud_Eureka]: https://blog.csdn.net/qqxx6661/article/details/88375904
[SpringCloud_Eureka 1]: https://blog.csdn.net/qqxx6661/article/details/88396539
[SpringCloud]: https://blog.csdn.net/qqxx6661/article/details/88430062
[SpringCloud_Hystrix_ _ _Hystrix Dashboard_Turbine]: https://blog.csdn.net/qqxx6661/article/details/88559088
[SpringCloud_Spring Cloud Config]: https://blog.csdn.net/qqxx6661/article/details/88604499
[20190317231653313.png]: /images/20220306/bb37dfdcd2974a3baafea703687fab05.png
[http_localhost_8769_spring-cloud-config-dev.properties]: http://localhost:8769/spring-cloud-config-dev.properties
[20190317231648992.png]: /images/20220306/202e28813df943828aeead17ea92e9a3.png
[20190317231644750.png]: /images/20220306/a375ad0eb88544bda8cdef6cc952d3ef.png
[20190317231636175.png]: /images/20220306/402033d79d4445d08d2f343eed723505.png
[201903172316324.png]: /images/20220306/921e9b0d81594805b5e41a13a947a5dc.png
[20190317231627900.png]: /images/20220306/5b282b35fc034934b3a703c598fb9fbb.png
[20190317231623740.png]: /images/20220306/31168fcd6b90401486add7622c241016.png
[20190317231619534.png]: /images/20220306/c5439512122e483cb8430d0149d3d460.png
[2019031723161321.png]: /images/20220306/56668a640e2e447093db69ca78ab9dda.png
[http_localhost_8761]: http://localhost:8761/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxeHg2NjYx_size_16_color_FFFFFF_t_70 1]: /images/20220306/261afe3f2e644a70b84222fcf2229a73.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxeHg2NjYx_size_16_color_FFFFFF_t_70 2]: /images/20220306/b04358ca09b0453b966b77adc1e25a5f.png
[https_github.com_qqxx6661_springcloud_for_noob_tree_master_07-config-server-config-client-eureka]: https://github.com/qqxx6661/springcloud_for_noob/tree/master/07-config-server-config-client-eureka
[http_www.ityouknow.com_springcloud_2017_05_23_springcloud-config-svn-refresh.html]: http://www.ityouknow.com/springcloud/2017/05/23/springcloud-config-svn-refresh.html
[https_blog.csdn.net_youanyyou_article_details_78993060]: https://blog.csdn.net/youanyyou/article/details/78993060
[http_www.ityouknow.com_springcloud_2017_05_25_springcloud-config-eureka.html]: http://www.ityouknow.com/springcloud/2017/05/25/springcloud-config-eureka.html
[https_github.com_qqxx6661]: https://github.com/qqxx6661
[http_blog.csdn.net_qqxx6661]: http://blog.csdn.net/qqxx6661
[https_www.zhihu.com_people_yang-zhen-dong-1]: https://www.zhihu.com/people/yang-zhen-dong-1/
[https_juejin.im_user_5b48015ce51d45191462ba55]: https://juejin.im/user/5b48015ce51d45191462ba55
[https_www.jianshu.com_u_b5f225ca2376]: https://www.jianshu.com/u/b5f225ca2376
[Rude3Knife]: /images/20220306/5eb0e81b28f94b8abc635dfb9784cf6e.png