很多场景下我们需要动态刷新配置。
一、手动刷新配置
1、复制项目config-client为config-client-refresh
添加依赖,pom.xml如下:
<?xml version="1.0" encoding="UTF-8"?>
<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>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.springclouddemo</groupId>
<artifactId>config-client-refresh</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>config-client-refresh</name>
<description>刷新配置</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR2</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2、将端口修改为7402,其余配置与config-client相同
3、在Controller上添加注解@RestController
package com.springclouddemo.configclientrefresh.controller;
import jdk.nashorn.internal.ir.annotations.Reference;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author 何昌杰
*/
@Reference
@RestController
public class DemoController {
@Value("${profile}")
private String profile;
@GetMapping("/demo")
public String demo(){
return this.profile;
}
}
测试:
1.启动项目config-server、config-client-refresh
2.访问http://localhost:7402/demo,得到响应如下:
dev-1.0
3.修改Git库中的配置文件内容:profile=dev-1.0-change
4.发生POST请求到http://localhost:7402/actuator/refresh,刷新配置
5.再次访问http://localhost:7402/demo,得到响应如下:
dev-1.0-change
说明配置已经刷新。
二、自动刷新配置
上一节讨论了使用/actuator/refresh刷新配置,但是如果所有微服务都需要手动去刷新配置的话,工作量可想而知,不仅如此,随着系统的扩张,将会越来越难以维护。因此,自动刷新配置是十分必要的。
Spring Cloud Bus使用轻量级消息代理(例如RabbitMQ、Kafka等)连接分布式系统的节点,这样就可以广播传播状态的更改或者其他管理指令。使用Spring Cloud Bus的架构如果所示:
由图可知,各个微服务通过消息总线连接到一起,每一个实例都会订阅配置更新事件,当其中一个微服务节点的/bus/refresh端点被请求时,该实例会向消息总线发送一条配置更新事件,其他实例获得该事件后也会更新配置。
1.安装RabbisMQ(过程略)
2.为项目添加RabbisMQ的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-cloud-bus-amqp</artifactId>
</dependency>
3.在bootstrap.properties添加以下内容:
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
测试:
1.启动项目config-server、config-client、改造后的config-client-refresh
2.访问http://localhost:7402/demo,得到响应:dev-1.0-change
3.将Git仓库的配置文件内容修改如下:dev-1.0-change2
4.发生POST请求到http://localhost:7402/bus/refresh,刷新配置
5.再次访问http://localhost:7402/demo和http://localhost:7401/demo,得到响应如下:dev-1.0-change2
说明配置已经自动刷新了。
三、局部刷新
某些场景下(例如灰度发布等),若只想刷新部分微服务的配置,可通过/bus/refresh端点的destination参数来定位要刷新的应用程序。
例如:/bus/refresh?destination=customers:7500,这样消息总线上的微服务实例就会根据destination参数的值来判断是否需要刷新。其中,customers:7500指的是微服务的ApplicationContext ID。
destination参数也可以用来定位特定的微服务。例如:/bus/refresh?destination=customers:**,这样就可以触发customers微服务的所有实例的配置刷新。
- 默认情况下:ApplicationContext ID参数的值是spring.application.name:server.port。
四、架构改进
通过请求某个微服务/bus/refresh端点的方式来实现配置刷新,这种方式并不优雅。原因如下:
- 破坏了微服务的职责单一原则。业务微服务只应关注自身业务,不应承担配置刷新的职责。
- 破坏了微服务各节点的对等性。
- 有一定的局限性。例如,微服务在迁移时,网络地址常常发生变化。此时如果想自动刷新配置,就不得不修改WebHook配置。
改进架构如下:
从图可知:将Config Server也加入到消息总线中,并使用Config Server的/bus/refresh端点来实现配置的刷新。这样,各个微服务只需要关注自身的业务,而不再承担配置刷新的职责。
五、Config与Eureka配合使用
前文在微服务中指定了Config Server的地址,这种方式无法利用服务发现组件的优势,本节将说明Config与Eureka配合使用。
1.将Config Server于Config Client都注册到Eureka Server上。
2.为Config项目添加Eureka依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
3.为启动类添加组件@EnableEurekaClient
4.Config Client的bootstrap.peoperties配置如下
spring.application.name=application
spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.service-id=config-server
spring.cloud.config.profile=dev
spring.cloud.config.label=master
eureka.client.service-url.defaultZone=http://localhost:7000/eureka/
六、Spring Cloud Config用户认证
Config Server是运行匿名访问的,为了防止配置内容外泄,应该保护Config Server的安全,可以通过物理网络安全,或者Config Server添加用户认证的方式。
1、Config Server添加用户认证
1.复制项目config-server为config-server-authentication
2.依赖如下:
<?xml version="1.0" encoding="UTF-8"?>
<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>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.springclouddemo</groupId>
<artifactId>config-server-authentication</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>config-server-authentication</name>
<description>用户认证</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR2</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3.在配置文件中配置一下内容:
server.port=7403
spring.application.name=config-server-authentication
spring.cloud.config.server.git.uri=https://gitee.com/jie_harris/config-server
#spring.cloud.config.server.git.username=
#spring.cloud.config.server.git.password=
spring.security.user.name=hcj
spring.security.user.password=123
eureka.client.service-url.defaultZone=http://localhost:7000/eureka/
这样就为Config Server添加用户认证了。
2、Config Client连接需要用户认证的Config Server
方式一:
spring.cloud.config.uri=http://[user]:[password]@localhost:7400/
方式二:
spring.cloud.config.username=hcj
spring.cloud.config.password=123