SpringCloud-Spring Cloud Config配置属性刷新之自动刷新

概述

 

    有图可知，微服务A的所有实例都通过消息总线连接到了一起，每个实例都会订阅配置更新事件。当其中一个微服务节点的/bus/refres端点被请求时，该实例就会向消息总线发送一个配置更新事件，其他实例获得该事件后也会更新配置；

 

Erlang下载、安装

 

http://www.erlang.org/downloads

http://erlang.org/download/otp_win64_21.0.1.exe

 

 

Rabbitmq下载、安装

 

http://www.rabbitmq.com/

 

 

 

 

创建工程-microservice-config-client-refresh-bus

 

pom.xml

config-learning/microservice-config-client-refresh-bus/pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<parent>
		<groupId>com.itmuch.cloud</groupId>
		<artifactId>microservice-spring-cloud</artifactId>
		<version>0.0.1-SNAPSHOT</version>
	</parent>

	<artifactId>microservice-config-client-refresh-bus</artifactId>
	<packaging>jar</packaging>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-config</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

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

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-bus-amqp</artifactId>
		</dependency>
	</dependencies>
</project>

说明：

    1）添加依赖；

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>

 

 

 

bootstrap.yml

spring:
  cloud:
    config:
      uri: http://localhost:8080
      profile: dev
      label: master   # 当configserver的后端存储是Git时，默认就是master 
    bus:
      trace:
        enabled: true
  application:
    name: foobar
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

说明：

    1）加上rabbitmq相关的配置；

 

 

 

 

 

 

application.yml

server:
  port: 8082

 

 

ConfigClientController

com.itmuch.cloud.ConfigClientController

package com.itmuch.cloud;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RefreshScope
public class ConfigClientController {

  @Value("${profile}")
  private String profile;

  @GetMapping("/profile")
  public String getProfile() {
    return this.profile;
  }
}

说明：

    1）加上注解@RefreshScope;

    2）需要说明的是@RefreshScope注解的意义是，在刷新配置的时候，如果被标注的配置正在使用，那么就在执行完成之后再去更新配置。此外，此注解最好不要与@Configuration注解一起使用，官方也不推荐这样用，会出现一些莫名其妙的问题。

 

 

 

ConfigServerApplication

com.itmuch.cloud.ConfigServerApplication

package com.itmuch.cloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

 

测试

(1) 启动microservice-config-server
(2) 启动microservice-config-client-refresh-cloud-bus，可发现此时控制台打印类似于以下的内容：

2018-07-21 19:14:54.787  INFO 33176 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/bus/refresh],methods=[POST]}" onto public void org.springframework.cloud.bus.endpoint.RefreshBusEndpoint.refresh(java.lang.String)

说明此时有一个 /bus/refresh 端点。

(3) 将microservice-config-client-refresh-cloud-bus的端口改成8082，再启动一个节点。

(4) 访问 http://localhost:8081/profile ，可获得结果：profile: profile-dev

(5) 将git仓库中的 foobar-dev.yml文件内容改为 profile: profile-dev2.0

(6) 发送POST请求到其中一个Config Client节点的的/bus/refresh端点，例如：

C:\Users\shangwu>curl -X POST http://localhost:8081/bus/refresh

指定任何一个节点都可以；

 

(7) 访问两个Config Client节点的/profile端点，会发现两个节点都会返回 dev2.0 ，说明配置内容已被刷新。

 

 

借助Git仓库的WebHook

借助Git仓库的WebHook，我们就可轻松实现配置的自动刷新。

上面的Payload URL就填写我们的配置中心触发刷新的地址，当然这里不能写localhost啦，要外网访问地址才行。

还有这里面有个Secret的秘钥验证，如果这里填写的话，在配置文件上要写上encrypt.key与之对应。

 

 

 

 

 

==============================

QQ群：143522604

群里有相关资源

欢迎和大家一起学习、交流、提升！

==============================