SpringCloud Config
分布式系统面临的问题——配置问题
微服务意味着要将单体应用中的业务拆分成一个个子服务,每个服务的粒度相对较小,因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行,所以一套集中式的,动态的配置管理设施是必不可少的。
SpringCloud提供了ConfigServer来解决这个问题,我们每一个微服务自己带着一个application.yml,上百个配置文件的管理,必将对运维带来巨大的工作量。
分布式配置中心是什么?
SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持,配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。
SpringCloud Config分为服务端和客户端两部分。服务端也称为分布式配置中心,它是一个独立的微服务应用,用来连接配置服务器并为客户端提供获取配置信息,加密/解密信息等访问接口。
客户端则是指通过指定的配置中心来管理应用资源,以及与业务相关的配置内容,并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息,这样就有助于对环境配置进行版本管理,并且可以通过git客户端工具来方便的管理和访问配置内容。
分布式配置中心能干什么?
①集中管理配置文件;
②不同环境不同配置,动态化的配置更新,分环境部署,比如dev/test/prod/beta/release
③运行期间动态调整配置,不再需要在每个服务部署的机器上编写配置文件,服务会向配置中心统一拉取配置自己的信息;
④当配置发生变动时,服务不需要重启即可感知到配置的变化并应用新的配置;
⑤将配置信息以REST接口的形式暴露
操作步骤(配置中心服务端)
1、在自己的github账号下,创建一个新的springcloud-config仓库,在仓库中编写相关配置,并拉取到自己的工作空间;
config-dev.yml
config:
info: "master branch,springcloud-config/config-dev.yml version=1"
config-prod.yml
2、服务中心
2.1 建moudle
创建名为cloud-config-center3344的模块
2.2 改pom
<dependencies>
<!--configServer-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<!--Eureka依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--引入公共模块坐标-->
<dependency>
<groupId>cn.yz.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</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.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>
2.3 写yml
server:
port: 3344
spring:
application:
name: cloud-config-center #注册进eureka服务器的微服务名
cloud:
config:
server:
git:
uri: https://github.com/maize-j/springcloud-config.git #github上面的git仓库名字
search-paths:
- springcloud-config #搜索目录
label: master #读取分支
#服务注册到eureka地址
eureka:
client:
service-url:
defaultZone: http://eureka7001.com:7001/eureka
2.4 主启动类
@SpringBootApplication
@EnableEurekaClient
@EnableConfigServer
public class MainAppConfigCenter3344 {
public static void main(String[] args) {
SpringApplication.run(MainAppConfigCenter3344.class,args);
}
}
2.5 修改hosts文件
在hosts文件中添加127.0.0.1 config-3344.com
,host文件地址C:\Windows\System32\drivers\etc
2.6 启动
启动eureka7001,启动config3344,访问http://config-3344.com:3344/master/config-dev.yml,可以成功读取到仓库中相关路径下的内容
仓库:
访问:
配置文件读取规则
一共有五种读取规则,下面介绍常用的三种(label表示分支,name表示服务名称,profiles表示环境)
-
/{label}/{application}-{profile}.yml
分为master分支和dev分支。
master分支访问示例:http://config-3344.com:3344/master/config-dev.yml
dev分支访问示例:http://config-3344.com:3344/dev/config-dev.yml
-
/{application}-{profile}.yml
省略了{label},访问http://config-3344.com:3344/config-dev.yml时,默认访问的是master分支,因为在cloud-config-center3344模块的application.yml中配置的label是master,当要默认访问dev时,可将yml中的label改为dev
-
/{application}/{profile}[/{label}]
将分支写在路径的后面,例如:http://config-3344.com:3344/config/dev/master,访问的是master下的config-dev.yml。这种方式下访问出来的是json数据。
配置中心客户端
1、建moudle
创建名为cloud-config-center3355的模块
2、改pom
<dependencies>
<!--configClient-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<!--Eureka依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--引入公共模块坐标-->
<dependency>
<groupId>cn.yz.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</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.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>
3、写yml
application.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(先从服务端拿到统一的bootstrap.yml,再加载自己的application.yml配置,形成客户端完整的配置。)
bootstrap.yml
server:
port: 3355
spring:
application:
name: config-client
cloud:
#Config客户端配置
config:
label: master #分支名称
name: config #配置文件名称
profile: dev #读取后缀名称 上述三个综述,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
4、主启动
@EnableEurekaClient
@SpringBootApplication
public class ConfigClientMain3355 {
public static void main(String[] args) {
SpringApplication.run(ConfigClientMain3355.class,args);
}
}
5、业务类
@RestController
public class ConfigClientController {
@Value("${config.info}") //从GitHub上的http://config-3344.com:3344/master/config-dev.yml读取config.info的内容
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo(){
return configInfo;
}
}
6、启动
启动eureka7001,config3344,config3355
首先访问config3344http://config-3344.com:3344/master/config-dev.yml,自测通过得到数据,再访问http://localhost:3355/configInfo,该uri得到的数据和3344得到的数据一致,均为github中master分支下config-dev.yml文件中的内容。
分布式配置的动态刷新问题
Linux运维修改github上的配置文件内容做调整(修改了github中存放的配置内容),刷新config3344,发现configServer配置中心能立刻做出响应,但是刷新3355后,发现ConfigClient客户端没有更新内容,这种情况下,要使3355的内容也做出更新,需要重新启动3355端口。这种操作对运维来说几乎是不可行的。
动态刷新解决办法
1、引入acturtor监控,在之前的模块中也都已经添加(acturtor是监控系统健康情况的工具)
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
2、修改yml,以暴露监控的端口
#暴露监控端点
management:
endpoints:
web:
exposure:
include: "*"
3、在controller上加上@RefreshScope的注解
在以上工作完成后,configClient3355仍不能直接读取到更新之后的内容,要想3355也得到更新之后的内容仍需要重启。那就相当于前面做了无用功吗?
要使前面的配置生效,需要运维人员发送Post请求刷新3355,使用下面命令模拟刷新
curl -X POST "http://localhost:3355/actuator/refresh"
在3355经post请求刷新后,能够从配置中心读取更新之后的数据。