Spring Cloud（六）配置中心（Spring Cloud Config）

一、简介

随着业务的发展、微服务架构的升级，服务的数量、程序的配置日益增多（各种微服务、各种服务器地址、各种参数），传统的配置文件方式和数据库的方式已无法满足开发人员对配置管理的要求：

• 安全性：配置跟随源代码保存在代码库中，容易造成配置泄漏；
• 时效性：修改配置，需要重启服务才能生效；
• 局限性：无法支持动态调整：例如日志开关、功能开关；

因此，我们需要配置中心来统一管理配置！把业务开发者从复杂以及繁琐的配置中解脱出来，只需专注于业务代码本身，从而能够显著提升开发以及运维效率。同时将配置和发布包解藕也进一步提升发布的成功率，并为运维的细力度管控、应急处理等提供强有力的支持。

• 在分布式系统中，由于服务数量巨多，为了方便服务配置文件统一管理，实时更新，所以需要分布式配置中心组件。在Spring Cloud中，有分布式配置中心组件spring cloud config 。
• Spring Cloud Config就是我们通常意义上的配置中心。Spring Cloud Config-把应用原本放在本地文件的配置抽取出来放在中心服务器，本质是配置信息从本地迁移到云端。从而能够提供更好的管理、发布能力。
• Spring Cloud Config分服务端和客户端，服务端负责将git（svn）中存储的配置文件发布成REST接口，客户端可以从服务端REST接口获取配置。但客户端并不能主动感知到配置的变化，从而主动去获取新的配置，这需要每个客户端通过POST方法触发各自的/refresh。

二、简单实例

2.1 准备github仓库

创建github仓库，用来放置我们的配置文件：

config-dev.properties
config-prod.properties

config-dev.properties 中定义name=Payne，config-prod.properties中定义name=Payne Yu

所有spring的配置中心的配置文件 都有以下几种格式组成

• 1 配置文件属于哪个应用的（Application）
• 2 配置文件属于哪个阶段（profile） 开发阶段 测试阶段 产品阶段

2.2 创建config-server module

pom中添加spring-cloud-config-server组件，同样注册到Eureka服务中心中

<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>

资源文件中指定git相关信息

server.port=8086
spring.application.name=config-server
eureka.client.service-url.defaultZone = http://localhost:8080/eureka/

spring.cloud.config.server.git.uri=https://github.com/PayneYu/spring-cloud-config.git
spring.cloud.config.server.git.searchPaths=repository
spring.cloud.config.label=master
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.password=

启动类中加入EnableConfigServer注解

@SpringBootApplication
@EnableEurekaClient
@EnableConfigServer
public class ConfigServerApplication {

	public static void main(String[] args) {
		SpringApplication.run(ConfigServerApplication.class, args);
	}
}

2.3 验证效果

启动Eureka注册中心，然后启动config-server，浏览器访问
http://localhost:8086/config-dev.properties

name: Payne

http://localhost:8086/config-prod.properties

name: Payne Yu

证明配置服务中心可以从远程程序获取配置信息。
http请求地址和资源文件映射如下:

• /{application}/{profile}[/{label}]
• /{application}-{profile}.yml
• /{label}/{application}-{profile}.yml
• /{application}-{profile}.properties
• /{label}/{application}-{profile}.properties

2.4 创建config-client module

pom中添加spring-cloud-starter-config

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<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>

新建bootstrap.properties，必须是"bootstrap"命名的引导配置文件，原因是由于资源文件的加载顺序：
这里主要是说明application和bootstrap的加载顺序。

• bootstrap.yml（bootstrap.properties）先加载
• application.yml（application.properties）后加载bootstrap.yml 用于应用程序上下文的引导阶段。

bootstrap.yml 由父Spring ApplicationContext加载。父ApplicationContext 被加载到使用 application.yml 的之前。也就是说config配置中心必须先与程序加载，有兴趣可以看下
在springcloud-config的源码包spring-cloud-config-server.jar中的ConfigServerBootstrapConfiguration类

server.port=8087
spring.application.name=config-client
eureka.client.service-url.defaultZone = http://localhost:8080/eureka/
#开启配置服务发现
spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.service-id=config-server
#配置文件所在分支
spring.cloud.config.label=master
spring.cloud.config.profile=dev
#名称需要与远程库的配置文件名称一致 或者使用spring.cloud.config.name = xxx 来指定(多个使用逗号分割)
spring.cloud.config.name=config
#spring.cloud.config.uri=["http://localhost:8086/"]

注意：
config server 2 种读取方式：

1. spring.cloud.config.uri
2. Euraka 注册中心
   如果使用了Euraka 注册中心，在读取配置文件不再写ip地址，而是服务名，这时如果配置服务部署多份，通过负载均衡，从而高可用。

• spring.cloud.config.discovery.enabled 是从配置中心读取文件。
• spring.cloud.config.discovery.serviceId 配置中心的servieId，即服务名。

请注意必须添加spring.cloud.config.name,否则将会遇见：

Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'name' in value "${name}"

Application@Value("${name}") 获取资源文件的内容

@SpringBootApplication
@RestController
@EnableEurekaClient
public class ConfigClientApplication {

	public static void main(String[] args) {
		SpringApplication.run(ConfigClientApplication.class, args);
	}
	@Value("${name}")
	private String name;

	@RequestMapping(value = "/hi")
	public String hi(){
		return "I am "+env.getProperty("name");
	}
}

浏览器访问：http://localhost:8087/hi

I am Payne

当更改配置文件：

spring.cloud.config.profile=prod

浏览器再次访问：http://localhost:8087/hi

I am Payne Yu

GitHub项目地址：https://github.com/PayneYu/spring-cloud-study