文章目录
- SpringCloud Config概述
- 概述
- 传统方式弊端
- 主要功能
- 与GitHub整合配置
- Config服务端配置与测试
- 服务端配置(即Gitee上的配置文件)
- Config Demo配置
- Spring Cloud Config访问规则
- Config客户端配置与测试
- bootstrap.yml说明
- Config客户端 Demo配置
SpringCloud Config概述
概述
Spring Cloud Config 配置中心是一个可以集中管理应用程序配置信息的服务。它的主要作用是将应用程序配置与代码分离,实现应用程序的动态配置管理。
传统方式弊端
在传统的应用程序中,通常会将配置信息硬编码到代码中,这样做有一些弊端,例如:
- 配置信息分散:各个应用程序的配置信息散布在不同的地方,当需要修改某个配置时,需要找到所有使用该配置的应用程序,分别修改其代码;
- 配置信息暴露:配置信息暴露在代码中,当需要修改配置信息时,需要重新编译、打包、部署应用程序;
- 配置信息不可管理:配置信息分散在不同的应用程序中,难以进行集中管理和监控。
主要功能
- 集中管理配置信息:将应用程序的配置信息集中管理,可以在同一地方修改、管理配置信息;
- 动态更新配置信息:应用程序在启动时从配置中心获取配置信息,可以动态更新应用程序的配置信息,无需重新部署应用程序;
- 管理配置信息版本:配置中心可以管理多个版本的配置信息,方便进行版本控制和回滚操作;
- 安全管理配置信息:配置中心可以对配置信息进行加密和解密操作,保证配置信息的安全性。
综上所述,Spring Cloud Config 配置中心的主要作用是解决应用程序配置信息管理的问题,使应用程序的配置信息与代码分离,实现应用程序的动态配置管理。
与GitHub整合配置
Spring Cloud Config 配置中心可以与 GitHub 整合,使得应用程序的配置信息可以存储在 GitHub 上,方便进行版本控制和管理。
官网:https://cloud.spring.io/spring-cloud-static/spring-cloud-config/2.2.1.RELEASE/reference/html/
Config服务端配置与测试
服务端配置(即Gitee上的配置文件)
- 在Gitee上新建一个名为springcloud-config的新Repository
- 获取该仓库的地址
- 本地硬盘目录上新建git仓库并clone
- 在clone下来的文件夹中添加配置文件
表示多个环境的配置文件例如:config-test.yml、config-dev.yml、config-master.yml
config-dev.yml
spring:
application:
name: springcloud-config-dev
profiles:
active: dev
config-test.yml
spring:
application:
name: springcloud-config-test
profiles:
active: test
config-master.yml
spring:
application:
name: springcloud-config-master
profiles:
active: master
- 将配置文件提交到远程仓库中
git add .
git commit -m "init yml"
git push origin master
查看远程仓库初始化成功
Config Demo配置
新建模块cloud-config-center-3344
pom.xml
<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>
application.yml
server:
port: 3344
spring:
application:
name: cloud-config-center #注册进Eureka服务器的微服务名
cloud:
config:
server:
git:
uri: https://gitee.com/sunruofei/springcloud-config.git #Gitee上面的git仓库名字
####搜索目录
search-paths:
- springcloud-config
username: sunruofei
password: srf199565@
####读取分支
label: master
#服务注册到eureka地址
eureka:
instance:
# 配置eureka的状态显示
hostname: localhost
instance-id: ${eureka.instance.hostname}:${spring.application.name}:${server.port}
client: #服务提供者provider注册进eureka服务列表内
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
启动类ConfigCenterMain3344.java
@SpringBootApplication
@EnableConfigServer
public class ConfigCenterMain3344 {
public static void main(String[] args) {
SpringApplication.run(ConfigCenterMain3344.class, args);
}
}
修改hosts文件添加映射
127.0.0.1 config-3344.com
启动测试
访问:http://config-3344.com:3344/master/config-dev.yml,可以读取到配置
Spring Cloud Config访问规则
Spring Cloud Config 有它的一套访问规则,我们通过这套规则在浏览器上直接访问就可以。
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
{application} 就是应用名称,对应到配置文件上来,就是配置文件的名称部分,例如我上面创建的配置文件。
{profile} 就是配置文件的版本,我们的项目有开发版本、测试环境版本、生产环境版本,对应到配置文件上来就是以 application-{profile}.yml 加以区分,例如application-dev.yml、application-sit.yml、application-prod.yml。
{label} 表示 git 分支,默认是 master 分支,如果项目是以分支做区分也是可以的,那就可以通过不同的 label 来控制访问不同的配置文件了。
Config客户端配置与测试
bootstrap.yml说明
bootstrap.yml 是 Spring Boot 应用程序的配置文件之一,通常用于配置 Spring Cloud 应用程序的配置中心。Bootstrap 配置在应用程序启动阶段之前加载,它可以包含一些应用程序配置的关键信息,比如配置中心的地址和端口,以及一些敏感信息如数据库连接密码等等。
与 application.yml 不同,bootstrap.yml 是在应用程序启动前加载的,并且具有更高的优先级。这意味着,在 application.yml 中定义的配置属性可以被 bootstrap.yml 中定义的相同属性覆盖。这使得 bootstrap.yml 很适合用于定义应用程序的基本配置,例如与 Spring Cloud Config Server 集成的相关配置。
application.yml 是 Spring Boot 应用程序的主要配置文件,用于定义应用程序的所有配置属性。它可以包含一些关键配置,例如端口号,数据源配置,日志级别等等。通常情况下,application.yml 中的配置可以被其他配置文件所覆盖,例如 bootstrap.yml 和命令行参数。
总的来说,bootstrap.yml 适用于一些基础配置,例如配置中心地址,而 application.yml 用于定义应用程序的所有其他配置。但是需要注意的是,这并不是绝对的,具体如何组织配置文件取决于实际需求和场景。
Config客户端 Demo配置
新建模块cloud-config-client-3355
pom.xml
<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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
</dependencies>
bootstrap.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 #配置中心地址
# 暴露监控端点
management:
endpoints:
web:
exposure:
include: "*"
#服务注册到eureka地址
eureka:
instance:
# 配置eureka的状态显示
hostname: localhost
instance-id: ${eureka.instance.hostname}:${spring.application.name}:${server.port}
client: #服务提供者provider注册进eureka服务列表内
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
启动类ConfigClientMain3355
@EnableEurekaClient
@SpringBootApplication
public class ConfigClientMain3355 {
public static void main(String[] args) {
SpringApplication.run(ConfigClientMain3355.class, args);
}
}
业务类ConfigClientController
@RestController
@RefreshScope//Spring Cloud 提供的用于动态刷新配置的注解,会在调用 /actuator/refresh 接口时重新加载配置并更新 configInfo 的值。
public class ConfigClientController {
@Value("${spring.cloud.config.info}")
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo() {
return configInfo;
}
}
启动测试
启动Config配置中心3344微服务并自测:
加一个info内容作为一个改动标记: master branch,springcloud-config/config-dev.yml version=1
启动Config客户端3355微服务并自测:
gitee中修改version=2,并push
刷新3344的地址,发现修改内容已经同步更新
观察3355地址,仍然是version=1
向3355发送post请求 curl -X POST “http://localhost:3355/actuator/refresh”
再次刷新发现内容已经同步更新