【SpringCloud13】SpringCloud Config分布式配置中心
1.概述
1.1 分布式系统面临的配置问题
微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套集中式的、动态的配置管理设施是必不可少的。
SpringCloud提供了ConfigServer来解决这个问题，否则我们每一个微服务自己带着一个application.yml，上百个配置文件的管理这不直接G啊
1.2 是什么
SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持，配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。
1.3 如何使用
SpringCloud Config分为服务端和客户端两部分。
服务端(Config Server)也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密/解密信息等访问接口
客户端(Client)则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。
1.4 作用
-
集中管理配置文件
-
不同环境不同配置，动态化的配置更新，分环境部署比如dev/test/prod/beta/release
-
运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息
-
当配置发生变动时，服务不需要重启即可感知到配置的变化并应用新的配置
-
将配置信息以REST接口的形式暴露：post、curl访问刷新均可…
1.5 与GitHub整合配置
由于SpringCloud Config默认使用Git来存储配置文件(也有其它方式，比如支持SVN和本地文件)，但最推荐的还是Git，而且使用的是http/https访问的形式
1.6官网
官网
2.Config服务端配置与测试
2.1GitHub创建仓库
用自己的账号在Gitee上新建一个名为springcloud-config的新Repository
2.2由上一步获取新建的git地址
https://gitee.com/czl1270784659/springcloud-config.git
2.3本地硬盘目录上新建git仓库并clone
命令：
git clone https://gitee.com/czl1270784659/springcloud-config.git
2.4在clone下的磁盘中新建springcloud-config
注意： 保存格式必须为UTF-8
如果需要修改操作git和github
git add .git commit -m 'init yml'git push origin main
2.5新建Module模块
新建cloud-config-center-3344它即为Cloud的配置中心模块cloudConfig Center
2.6POM
<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.0modelVersion>
<parent>
<groupId>com.atguigu.springcloudgroupId>
<artifactId>cloud2022artifactId>
<version>1.0-SNAPSHOTversion>
parent>
<artifactId>cloud-config-center-3344artifactId>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-config-serverartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-netflix-eureka-clientartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-devtoolsartifactId>
<scope>runtimescope>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
project>
2.7YML
server:
port: 3344
spring:
application:
name: cloud-config-center #注册进Eureka服务器的微服务名
cloud:
config:
server:
git:
uri: https://gitee.com/czl1270784659/springcloud-config.git #Gitee上面的git仓库名字
####搜索目录
search-paths:
- springcloud-config
####读取分支
label: main
#服务注册到eureka地址
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka
2.8 主启动类
package com.atguigu.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
/**
* 简要描述
*
* @Author: ASuLe
* @Date: ${DATE} ${TIME}
* @Version: 1.0
* @Description: 文件作用详细描述....
*/
@SpringBootApplication
@EnableConfigServer
public class ConfigCenterMain3344 {
public static void main(String[] args) {
SpringApplication.run(ConfigCenterMain3344.class,args);
}
}
2.9 修改Windows下hosts文件，增加映射
| 本机IP | 映射 |
|---|---|
| 127.0.0.1 | config-3344.com |
2.10 测试
查看Config微服务是否可以从Gitee上获取配置内容
注意1： 将仓库设置成共有，否则会报错Authentication is required but no CredentialsProvider has been registered
注意2： 如果是编码问题，会报错Failed to load property source from location ‘file:/C:/Users/12707/AppData/Local/Temp/config-repo-1856996159345519574/config-dev.yml’
测试页面：http://config-3344.com:3344/master/config-dev.yml
2.11配置读取规则
配置要跟官网要求一直
2.11.1 官网要求配置
2.11.2 /{label}/{application}-{profile}.yml
1.master分支
http://config-3344.com:3344/master/config-dev.yml
http://config-3344.com:3344/master/config-test.yml
http://config-3344.com:3344/master/config-prod.yml
2.dev分支
http://config-3344.com:3344/dev/config-dev.yml
http://config-3344.com:3344/dev/config-test.yml
http://config-3344.com:3344/dev/config-prod.yml
2.11.3 /{application}-{profile}.yml
http://config-3344.com:3344/config-dev.yml
http://config-3344.com:3344/config-test.yml
http://config-3344.com:3344/config-prod.yml
http://config-3344.com:3344/config-xxxx.yml（不存在的配置）
2.11.4 /{application}/{profile}[/{label}]
http://config-3344.com:3344/config/dev/master
http://config-3344.com:3344/config/test/master
http://config-3344.com:3344/config/config/master
读取内容不同
2.11.5 重要配置细节总结
- label:分支（branch）表示 git 分支，默认是 master 分支，如果项目是以分支做区分也是可以的，那就可以通过不同的 label 来控制访问不同的配置文件了
- name:服务名就是应用名称，对应到配置文件上来，就是配置文件的名称部分，例如我上面创建的配置文件
- profiles:环境（dev/test/prod）是配置文件的版本，我们的项目有开发版本、测试环境版本、生产环境版本，对应到配置文件上来就是以 application-{profile}.yml 加以区分，例如application-dev.yml、application-sit.yml、application-prod.yml
3.Config客户端配置与测试
3.1 新建cloud-config-client-3355
3.2 POM
<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.0modelVersion>
<parent>
<groupId>com.atguigu.springcloudgroupId>
<artifactId>cloud2022artifactId>
<version>1.0-SNAPSHOTversion>
parent>
<artifactId>cloud-config-client-3355artifactId>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-configartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-netflix-eureka-clientartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-devtoolsartifactId>
<scope>runtimescope>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
project>
3.3 bootstrap.yml
3.3.1 是什么
- applicaiton.yml是用户级的资源配置项
- bootstrap.yml是系统级的，
优先级更加高
pring Cloud会创建一个Bootstrap Context，作为Spring应用的Application Context的父上下文。初始化的时候，Bootstrap Context负责从外部源加载配置属性并解析配置。这两个上下文共享一个从外部获取的Environment。
Bootstrap属性有高优先级，默认情况下，它们不会被本地配置覆盖。 Bootstrap context和Application Context有着不同的约定，所以新增了一个bootstrap.yml文件，保证Bootstrap Context和Application Context配置的分离。
要将Client模块下的application.yml文件改为bootstrap.yml，这是很关键的，因为bootstrap.yml是比application.yml先加载的。bootstrap.yml优先级高于application.yml
3.3.2 YML内容
server:
port: 3355
spring:
application:
name: config-client
cloud:
#Config客户端配置
config:
label: master #分支名称
name: config #配置文件名称
profile: dev #读取后缀名称 上述3个综合：master分支上config-dev.yml的配置文件被读取http://config-3344.com:3344/master/config-dev.yml
uri: http://localhost:3344 #配置中心地址
#服务注册到eureka地址
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka
3.4 主启动
package com.atguigu.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
/**
* 简要描述
*
* @Author: ASuLe
* @Date: ${DATE} ${TIME}
* @Version: 1.0
* @Description: 文件作用详细描述....
*/
@SpringBootApplication
@EnableEurekaClient
public class ConfigClientMain3355 {
public static void main(String[] args) {
SpringApplication.run(ConfigClientMain3355.class, args);
}
}
3.6 业务类
package com.atguigu.springcloud.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 简要描述
*
* @Author: ASuLe
* @Date: 2023/1/17 10:35
* @Version: 1.0
* @Description: 文件作用详细描述....
*/
@RestController
public class ConfigClientMain3355 {
@Value("${config.info}")
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo() {
return configInfo;
}
}
3.7 测试
-
启动Config配置中心3344微服务并自测
-
启动3355作为Client准备访问
3.7 修改config-dev.yml配置并提交至Gitee
-
3.7.1 Linux运维修改Gitee上配置文件的内容已做调整
-
刷新3344，发现ConfigServer配置中心立刻响应
-
刷新3355，发现ConfigClient客户端没有任何响应
-
3355需要重新启动或重新加载才能有响应
问题： 每次运维修改配置文件，客户端都要重启，简直就是噩梦
4.Config客户端之动态刷新
4.1 避免每次更新配置都要重启客户端微服务3355
4.2 动态刷新步骤，修改3355模块
4.2.1 POM引入actuator模块
这里之前已经添加了
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
4.2.2 修改YML，暴露监控端口
# 暴露监控端点
management:
endpoints:
web:
exposure:
include: "*"
4.2.3 业务类Controller修改
添加注解： @RefreshScope
4.2.4 怎么做
-
修改gitee
-
观察3344
-
观察3355
问题：发现3355的版本信息还是4并没有改变，也就是说明配置没有生效
如何解决：需要运维人员发送Post请求刷新3355
必须是POST请求
模拟测试人员发送命令： curl -X POST "http://localhost:3355/actuator/refresh"
查看3355
客户端3355配置文件版本更新了，避免了服务重启
4.3 其他问题
想想还有什么问题？
- 假如有多个微服务客户端3355/3366/3377…
- 每个微服务都要执行一次post请求，手动刷新？
可否广播，一次通知，处处生效？- 我们想大范围的自动刷新，求方法
- 想要精确打击，100台机器只想要通知98台，其余两台因为版本发包的问题，不用换成最新的版本，进行定点通知，定点清除？