提示:本文为SpringCloud Config基本使用教程。
SpringCloud Config是什么
-
分布式系统面临的配置问题:
微服务意味着要将单体应用中的业务拆分成一个个子服务,每个服务的粒度相对较小,因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行,所以—套集中式的、动态的配置管理设施是必不可少的。
我们每一个微服务自己带着一个application.yml,上百个配置文件的管理,很麻烦,不易管理,SpringCloud提供了ConfigServer来解决这个问题。 -
SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持,配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。
-
SpringCloud Config分为服务端和客户端两部分。
- 服务端也称为分布式配置中心,它是一个独立的微服务应用,用来连接配置服务器并为客户端提供获取配置信息,加密/解密信息等访问接口
- 客户端则是通过指定的配置中心来管理应用资源,以及与业务相关的配置内容,并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息,这样就有助于对环境配置进行版本管理,并且可以通过git客户端工具来方便的管理和访问配置内容。
- SpringCloud Config的作用:
- 集中管理配置文件
- 不同环境不同配置,动态化的配置更新,分环境部署比如dev/test/prod/beta/release
- 运行期间动态调整配置,不再需要在每个服务部署的机器上编写配置文件,服务会向配置中心统一拉取配置自己的信息
- 当配置发生变动时,服务不需要重启即可感知到配置的变化并应用新的配置
- 将配置信息以REST接口的形式暴露
- 可以与Github整合配置,由于SpringCloud Config默认使用Git来存储配置文件(也有其它方式,比如支持svn和本地文件,但最推荐的还是Git,而且使用的是http/https访问的形式)
- 官网:https://spring.io/projects/spring-cloud-config
Config服务端配置与测试
- 在Github上新建一个名为sprincloud-config的新Repository:
- 在这个仓库下创建3个文件:
config-dev.yml
config:
info: "master branch, springcloud-config/config-dev.yml version=1"
config-prod.yml
config:
info: "master branch, springcloud-config/config-prod.yml version=1"
config-test.yml
config:
info: "master branch, springcloud-config/config-test.yml version=1"
、
- 新建Module模块cloud-config-center-3344它既为Cloud的配置中心模块cloudConfig Center
- 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">
<parent>
<artifactId>SpringcloudTest</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-config-center-3344</artifactId>
<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.example</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>1.0-SNAPSHOT</version>
</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.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>
</project>
- 配置文件application.yml
server:
port: 3344
spring:
application:
name: cloud-config-center
cloud:
config:
server:
git:
uri: https://github.com/hezhegit/sprincloud-config.git # 填写你自己的github路径
search-paths:
- springcloud-config
label: master
eureka:
client:
service-url:
defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
- 主启动类:
@SpringBootApplication
@EnableConfigServer
public class ConfigCenterMain3344 {
public static void main(String[] args) {
SpringApplication.run(ConfigCenterMain3344 .class,args);
}
}
- 测试通过Config微服务是否可以从Github上获取配置内容
访问:http://localhost:3344/master/config-dev.yml
配置读取规则
官网上有5种:
我们上面测试用的是第3种:/{label}/{application}-{profile}.yml
【lable:分支,application:服务名,profile:环境{dev/test/prod}】
例如读取master分支:
- http://localhost:3344/master/config-dev.yml
- http://localhost:3344/master/config-test.yml
- http://localhost:3344/master/config-prod.yml
其他4种方式也都是可以读取配置内容的。
Config客户端配置与测试
继续看到下面这张图,Confing客戶端是直接从服务端获得内容
- 新建一个Module,cloud-config-client-3355
- 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">
<parent>
<artifactId>SpringcloudTest</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-config-client-3355</artifactId>
<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.example</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>1.0-SNAPSHOT</version>
</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.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>
</project>
- 新建配置文件bootstrap.yml
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://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
application.yml和bootstrap.yml的区别,以及为什么要使用bootstrap.yml:
(1)applicaiton.yml是用户级的资源配置项,bootstrap.yml是系统级的,优先级更加高
(2)Spring Cloud会创建一个“Bootstrap Context”,作为Spring应用的’Application Context的父上下文。初始化的时候,BootstrapContext负责从外部源加载配置属性并解析配置。这两个上下文共享一个从外部获取的Environment。
(3)'Bootstrap’属性有高优先级,默认情况下,它们不会被本地配置覆盖。‘Bootstrap context和Application Context有着不同的约定,所以新增了一个’bootstrap.yml’文件,保证Bootstrap Context
和'Application Context
配置的分离。
(4)要将Client模块下的application.yml文件改为bootstrap.yml,这是很关键的,因为bootstrap.yml是比application.yml先加载的。bootstrap.yml优先级高于application.yml
- 主启动类:
@SpringBootApplication
@EnableEurekaClient
public class ConfigClientMain3355 {
public static void main(String[] args) {
SpringApplication.run( ConfigClientMain3355.class,args);
}
}
- 业务类:
@RestController
public class ConfigClientController {
@Value("${config.info}")
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo(){
return configInfo;
}
}
- 测试:
启动注册中心集群、3344、3355.
(1)测试服务端3344无错误:http://localhost:3344/master/config-dev.yml
(2)测试客服端3355:http://localhost:3355/configInfo
(3)遇到的问题:我将GitHub上的config-dev.yml 的version由1修改成2,再次测试上面的网址
修改:
访问服务端:http://localhost:3344/master/config-dev.yml
访问客服端:http://localhost:3355/configInfo
可以配置内容改变时,服务端马上可以同步,而客服端保持原来的,怎样解决这个问题:
- 重启3355客服端
- 修改一次,重启一次,较为麻烦,可以采用Config客户端之动态刷新
Config客户端之动态刷新
- 修改YML,暴露监控端口
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://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
management:
endpoints:
web:
exposure:
include: "*"
-
业务类Controller修改:添加注解:
@RefreshScope
-
测试:重新开启服务测试:
(1)修改GitHub上的config-dev.yml 的version由2修改成3,并访问:http://localhost:3355/configInfo
(2)版本号并没有更新,这个时候我们并不需要重启服务,只运维人员发送Post请求刷新3355,必须Post,curl -X POST "http://localhost:3355/actuator/refresh"
然后访问http://localhost:3355/configInfo【version已更新】 -
这样也会有一个问题:我们不可能只有一个客服端,多个客服端微服务,每个微服务都要执行一次post请求,这样也比较麻烦,那么是否有广播,一次通知,处处生效,答案是有的,参考博客:【SpringCloud】SpringCloud Bus 消息总线