【SpringCloud框架之Config分布式配置中心】

╰半夏微凉° 2023-09-25 16:42 139阅读 0赞

本笔记内容为尚硅谷SpringCloud框架开发Config配置中心部分

目录

一、概述

1、是什么

2、作用

二、Config服务端配置与测试

1、建仓库并克隆

2、新建项目

1.新建Module

2.POM

3.YML

4.主启动类

5.windows下修改hosts文件，增加映射

6.测试通过Config微服务是否可以从GitHub上获取配置内容

7.配置读取规则

三、Config客户端配置与测试

1、新建Module

2、POM

3、bootstrap.yml

4、主启动

5、业务类

6、测试

7、动态刷新问题

四、Config客户端之动态刷新

1、动态刷新步骤

1.POM引入actuator监控

2.修改YML，暴露监控端口

4.@RefreshScope业务类Controller修改

5.此时修改github

6.问题

2、思考

一、概述

微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套集中式的、动态的配置管理设施是必不可少的。

SpringCloud提供了ConfigServer来解决这个问题，我们每一个微服务自己带着一个application.yml，上百个配置文件的管理

官网 ：Spring Cloud Config

1、是什么

SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持，配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。

4b1ec09952774251b068d98e507a8960.png

SpringCloud Config分为服务端和客户端两部分。

服务端也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密/解密信息等访问接口

客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。

2、作用

  • 集中管理配置文件。
  • 不同环境不同配置，动态化的配置更新，分环境部署比如dev/test/prod/beta/release。
  • 运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息。
  • 当配置发生变动时，服务不需要重启即可感知到配置的变化并应用新的配置。
  • 将配置信息以REST接口的形式暴露：post、curl访问刷新均可。

与GitHub整合配置：由于SpringCloud Config默认使用Git来存储配置文件(也有其它方式,比如支持SVN和本地文件)，但最推荐的还是Git，而且使用的是http/https访问的形式（推荐码云）

二、Config服务端配置与测试

1、建仓库并克隆

这里是用GitHub作为例子（根据自己情况决定）

①用你自己的账号在GitHub上新建一个名为springcloud-config的新Repository

②由上一步获得刚新建的git地址，git@github.com:zzyybs/springcloud-config.git

③本地硬盘目录上新建git仓库并clone

本地地址：D:\44\SpringCloud2020

git命令：git clone git@github.com:zzyybs/springcloud-config.git

aafadb9ec727484d917e8d4dfc7113e2.png

④此时在本地D盘符下D:\44\SpringCloud2020\springcloud-config

表示多个环境的配置文件、保存格式必须为UTF-8

如果需要修改，此处模拟运维人员操作git和github

git add .

git commit -m “init yml”

git push origin master

1e7c150d9b1e403aa151ac77e53ebe5b.png

2、新建项目

1.新建Module

新建Module模块cloud-config-center-3344它即为Cloud的配置中心模块cloudConfig Center

2.POM

339bae2fd86b40089403dd83a6f0047c.png

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>mscloud</artifactId>
  7.         <groupId>com.atguigu.springcloud</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>cloud-config-center-3344</artifactId>
  15.     <dependencies>
  16.         <dependency>
  17.             <groupId>org.springframework.cloud</groupId>
  18.             <artifactId>spring-cloud-config-server</artifactId>
  19.         </dependency>
  20.         <dependency>
  21.             <groupId>org.springframework.cloud</groupId>
  22.             <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-web</artifactId>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-actuator</artifactId>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-devtools</artifactId>
  36.             <scope>runtime</scope>
  37.             <optional>true</optional>
  38.         </dependency>
  39.         <dependency>
  40.             <groupId>org.projectlombok</groupId>
  41.             <artifactId>lombok</artifactId>
  42.             <optional>true</optional>
  43.         </dependency>
  44.         <dependency>
  45.             <groupId>org.springframework.boot</groupId>
  46.             <artifactId>spring-boot-starter-test</artifactId>
  47.             <scope>test</scope>
  48.         </dependency>
  49.     </dependencies>
  52. </project>

3.YML

  1. server:
  2.   port: 3344
  4. spring:
  5.   application:
  6.     name:  cloud-config-center #注册进Eureka服务器的微服务名
  7.   cloud:
  8.     config:
  9.       server:
  10.         git:
  11.           uri: git@github.com:zzyybs/springcloud-config.git #GitHub上面的git仓库名字
  12.         ####搜索目录
  13.           search-paths:
  14.             - springcloud-config
  15.       ####读取分支
  16.       label: master
  18. #服务注册到eureka地址
  19. eureka:
  20.   client:
  21.     service-url:
  22.       defaultZone: http://localhost:7001/eureka

4.主启动类

@EnableConfigServer

ConfigCenterMain3344

  1. package com.atguigu.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.config.server.EnableConfigServer;
  7. @SpringBootApplication
  8. @EnableConfigServer
  9. public class ConfigCenterMain3344
  10. {
  11.     public static void main(String[] args) {
  12.             SpringApplication.run(ConfigCenterMain3344.class, args);
  13.     }
  14. }

5.windows下修改hosts文件，增加映射

127.0.0.1 config-3344.com

6.测试通过Config微服务是否可以从GitHub上获取配置内容

启动微服务3344

http://config-3344.com:3344/master/config-dev.yml

7.配置读取规则

①官网

f402a60c844649dda96663148df1f942.png

②/{label}/{application}-{profile}.yml

master分支

http://config-3344.com:3344/master/config-dev.ymlhttp://config-3344.com:3344/master/config-test.ymlhttp://config-3344.com:3344/master/config-prod.yml

dev分支

http://config-3344.com:3344/dev/config-dev.ymlhttp://config-3344.com:3344/dev/config-test.ymlhttp://config-3344.com:3344/dev/config-prod.yml

③/{application}-{profile}.yml

http://config-3344.com:3344/config-dev.ymlhttp://config-3344.com:3344/config-test.ymlhttp://config-3344.com:3344/config-prod.ymlhttp://config-3344.com:3344/config-xxxx.yml(不存在的配置)

④/{application}/{profile}[/{label}]

http://config-3344.com:3344/config/dev/masterhttp://config-3344.com:3344/config/test/masterhttp://config-3344.com:3344/config/test/dev

⑤重要配置细节总结

a446ac7475274235bc95da46a0832f48.png

成功实现了用SpringCloud Config通过GitHub获取配置信息

三、Config客户端配置与测试

1、新建Module

新建cloud-config-client-3355

2、POM

45cee76c608049bcaa3f8aa17928ce4f.png

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>mscloud</artifactId>
  7.         <groupId>com.atguigu.springcloud</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>cloud-config-client-3355</artifactId>
  14.     <dependencies>
  15.         <dependency>
  16.             <groupId>org.springframework.cloud</groupId>
  17.             <artifactId>spring-cloud-starter-config</artifactId>
  18.         </dependency>
  19.         <dependency>
  20.             <groupId>org.springframework.cloud</groupId>
  21.             <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  22.         </dependency>
  23.         <dependency>
  24.             <groupId>org.springframework.boot</groupId>
  25.             <artifactId>spring-boot-starter-web</artifactId>
  26.         </dependency>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-starter-actuator</artifactId>
  30.         </dependency>
  32.         <dependency>
  33.             <groupId>org.springframework.boot</groupId>
  34.             <artifactId>spring-boot-devtools</artifactId>
  35.             <scope>runtime</scope>
  36.             <optional>true</optional>
  37.         </dependency>
  38.         <dependency>
  39.             <groupId>org.projectlombok</groupId>
  40.             <artifactId>lombok</artifactId>
  41.             <optional>true</optional>
  42.         </dependency>
  43.         <dependency>
  44.             <groupId>org.springframework.boot</groupId>
  45.             <artifactId>spring-boot-starter-test</artifactId>
  46.             <scope>test</scope>
  47.         </dependency>
  48.     </dependencies>
  51. </project>

3、bootstrap.yml

applicaiton.yml是用户级的资源配置项

bootstrap.yml是系统级的，优先级更加高

Spring 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

  1. server:
  2.   port: 3355
  4. spring:
  5.   application:
  6.     name: config-client
  7.   cloud:
  8.     #Config客户端配置
  9.     config:
  10.       label: master #分支名称
  11.       name: config #配置文件名称
  12.       profile: dev #读取后缀名称   上述3个综合：master分支上config-dev.yml的配置文件被读取http://config-3344.com:3344/master/config-dev.yml
  13.       uri: http://localhost:3344 #配置中心地址k
  15. #服务注册到eureka地址
  16. eureka:
  17.   client:
  18.     service-url:
  19.       defaultZone: http://localhost:7001/eureka

d1b4a9158542475a934539865c1eb513.png

修改config-dev.yml配置并提交到GitHub中，比如加个变量age或者版本号version

4、主启动

类ConfigClientMain3355

  1. package com.atguigu.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
  7. @EnableEurekaClient
  8. @SpringBootApplication
  9. public class ConfigClientMain3355
  10. {
  11.     public static void main(String[] args)
  12.     {
  13.         SpringApplication.run(ConfigClientMain3355.class,args);
  14.     }
  15. }

5、业务类

  1. package com.atguigu.springcloud.controller;
  3. import org.springframework.cloud.context.config.annotation.RefreshScope;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  7. import org.springframework.beans.factory.annotation.Value;
  9. @RestController
  10. public class ConfigClientController
  11. {
  12.     @Value("${config.info}")
  13.     private String configInfo;
  15.     @GetMapping("/configInfo")
  16.     public String getConfigInfo() 
  18.     {
  19.         return configInfo;
  20.     }
  21. }

6、测试

启动Config配置中心3344微服务并自测

http://config-3344.com:3344/master/config-prod.ymlhttp://config-3344.com:3344/master/config-dev.yml

启动3355作为Client准备访问

http://localhost:3355/configInfo

成功实现了客户端3355访问SpringCloud Config3344通过GitHub获取配置信息

7、动态刷新问题

问题随时而来，分布式配置的动态刷新问题

Linux运维修改GitHub上的配置文件内容做调整

刷新3344，发现ConfigServer配置中心立刻响应

刷新3355，发现ConfigClient客户端没有任何响应

3355没有变化除非自己重启或者重新加载

难到每次运维修改配置文件，客户端都需要重启？？噩梦

四、Config客户端之动态刷新

1、动态刷新步骤

修改3355模块

1.POM引入actuator监控

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-actuator</artifactId>
  4. </dependency>

2.修改YML，暴露监控端口

b135d6cc85b945b4b2106218f75098cf.png

  1. server:
  2.   port: 3355
  4. spring:
  5.   application:
  6.     name: config-client
  7.   cloud:
  8.     #Config客户端配置
  9.     config:
  10.       label: master #分支名称
  11.       name: config #配置文件名称
  12.       profile: dev #读取后缀名称   上述3个综合：master分支上config-dev.yml的配置文件被读取
  13.       uri: http://localhost:3344 #配置中心地址k
  15. #服务注册到eureka地址
  16. eureka:
  17.   client:
  18.     service-url:
  19.       defaultZone: http://localhost:7001/eureka
  20. # 暴露监控端点
  21. management:
  22.   endpoints:
  23.     web:
  24.       exposure:
  25.         include: "*"

4.@RefreshScope业务类Controller修改

  1. package com.atguigu.springcloud.controller;
  3. import org.springframework.cloud.context.config.annotation.RefreshScope;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  7. import org.springframework.beans.factory.annotation.Value;
  9. @RestController
  10. @RefreshScope
  11. public class ConfigClientController
  12. {
  13.     @Value("${config.info}")
  14.     private String configInfo;
  16.     @GetMapping("/configInfo")
  17.     public String getConfigInfo() {
  18.         return configInfo;
  19.     }
  20. }

5.此时修改github

修改了信息后访问—-> 3344 ——>3355

http://localhost:3355/configInfo

发现3355没有改变

6.问题

需要运维人员发送Post请求刷新3355

#必须是POST请求

curl -X POST “http://localhost:3355/actuator/refresh“

657ce972fb4049afa38c21716dc5279a.png

再次访问：http://localhost:3355/configInfo

成功实现了客户端3355刷新到最新配置内容，避免了服务重启

2、思考

假如有多个微服务客户端3355/3366/3377

每个微服务都要执行一次post请求，手动刷新？

可否广播，一次通知，处处生效？

我们想大范围的自动刷新，具体见下一篇笔记SpringCloud Bus消息总线

【SpringCloud框架之Bus消息总线】_蛋饼吧的博客-CSDN博客

结束！

发表评论

表情：
评论列表 （有 0 条评论，139人围观）

还没有评论，来说两句吧...

相关阅读