所以我们需要一个模块作为分布式配置中心,供其他服务调用。
他有如下几个作用:
- 不同环境不同配置,动态化的配置更新,分环境部署比如
dev/test/prod/beta/release
; - 运行期间动态调整配置,不再需要在每个服务部署的机器上编写配置文件,服务会向配置中心统一拉取配置自己的信息;
- 当配置发生变动时,服务 不需要重启 即可感知到配置的变化并应用新的配置。
服务端编码实现
首先在 pom
中引入依赖:
<dependencies>
<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.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.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
然后配置信息,这里主要是指定 github
上的配置文件仓库地址:
server:
port: 3344
spring:
application:
name: cloud-config-center
cloud:
config:
server:
git:
uri: https://github.com/wsuo/springcloud-config.git
search-paths:
- springcloud-config
label: master
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka
然后编写主启动类即可启动项目:
代码语言:javascript复制@SpringBootApplication
@EnableConfigServer
@EnableEurekaClient
public class ConfigCenterMain3344 {
public static void main(String[] args) {
SpringApplication.run(ConfigCenterMain3344.class, args);
}
}
启动之后访问 http://localhost:3344/master/config-dev.yml
查看打印出来的信息:
这正是我们在 git
仓库中的文件内容。
/master/config-dev.yml
这种写法是读取配置的规则。
能访问到信息就说明搭建成功了,到此为止服务端创建完成。
客户端编码实现
首先导入 pom
依赖:
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</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.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
接下来要引入一个 bootstrap
yml
文件。
文件的内容配置如下:
代码语言:javascript复制server:
port: 3355
spring:
application:
name: config-client
cloud:
config:
label: master
name: config
profile: dev
uri: http://localhost:3344
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka
然后我们写完主启动类之后编写一个接口:
代码语言:javascript复制@SpringBootApplication
@EnableEurekaClient
public class ConfigClientMain3355 {
public static void main(String[] args) {
SpringApplication.run(ConfigClientMain3355.class, args);
}
}
@RestController
@Slf4j
public class ConfigClientController {
@Value("${config.info}")
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo() {
return configInfo;
}
}
该接口可以读取到从远程仓库中获取的配置信息。
我们先在本地修改 version=2
,然后提交到 git
。
这个时候启动 3355
作为客户端。
访问之后查看结果:
但是如果此时我们再次修改文件的内容,那么此时 3344
只需刷新页面之后就能显示出新的数据,但是 3355
需要重启服务器才行。
- 修改
GitHub
上的配置文件内容做调整; ConfigServer
配置中心 立刻响应;ConfigServer
客户端 没有任何响应。
这样肯定是不行的,所以我们需要修改配置。
动态刷新
我们需要使用动态刷新解决客户端配置不同步的问题。
首先我们要确保在 3355 模块中有这个依赖,它负责监控:
代码语言:javascript复制<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
在 bootstrap.yml
中添加配置,起到暴露端口的作用:
management:
endpoints:
web:
exposure:
include: "*"
然后在控制器上添加一个 @RefreshScope
注解:
@RestController
@Slf4j
@RefreshScope
public class ConfigClientController {
@Value("${config.info}")
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo() {
return configInfo;
}
}
但是此时刷新 3355
客户端改动还是不能动态生效。
这个时候我们需要发一个 POST
请求激活一下:
curl -X POST "http://localhost:3355/actuator/refresh"
但是每次都发一次请求去激活配置未免太麻烦,我们可以使用消息总线来完成广播。
消息总线
Spring Cloud Bus 配合 Spring Cloud Config 使用可以实现配置的动态刷新:
Bus 支持两种消息代理: RabbitMQ
和 Kafka
。
它又两种方式,一种是将消息推送到一个主机上,然后让主机根据局域网传播给其他主机,另一种方式是直接推送到配置中心上,让配置中心发送给其他主机。
首先我们需要启动 RabbitMQ。
- 进入安装目录的
sbin
目录,PS D:developRabbitMQRabbitMQ_Serverrabbitmq_server-3.7.4sbin>
: - 输入命令启动服务 rabbitmq-plugins enable rabbitmq_management
这个时候在浏览器访问 http://localhost:15672/
即可看到页面。
给 3344 配置中心服务端添加消息总线支持:
在服务端添加一依赖:
代码语言:javascript复制<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
修改配置文件:
代码语言:javascript复制server:
port: 3344
spring:
application:
name: cloud-config-center
cloud:
config:
server:
git:
uri: https://github.com/wsuo/springcloud-config.git
search-paths:
- springcloud-config
label: master
rabbitmq:
host: localhost
port: 5672
username: guest
password: guest
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka
management:
endpoints:
web:
exposure:
include: 'bus-refresh'
然后给客户端的 pom
和 yml
文件也添加同样的内容。
最后我们启动服务,执行下面的命令向配置中心发送 POST 请求,即可激活所有的客户端,即动态刷新。
代码语言:javascript复制curl -X POST "http://localhost:3344/actuator/bus-refresh"