Spring Cloud学习系列第五章：分布式系统外部配置Spring Cloud Config

一、简介

  不管任何系统，随着业务越来越多，可配置属性也会越来越多，修改的频率也会越来越大，而且从开发、测试、生产每个环境的配置都可能不一样，如果没有一个统一的地方去管理，后期的维护成本简直不可想象，相信经过长期项目的朋友应该会有这种痛点。所以，Spring Cloud又帮我们提供了统一的外部配置服务Spring Cloud Config。

  Spring Cloud Config为分布式系统中的外部配置提供服务器和客户端支持。使用Config Server，您可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment和PropertySource抽象相同，因此它们与Spring应用程序非常契合，但可以与任何以任何语言运行的应用程序一起使用。随着应用程序通过从开发人员到测试和生产的部署流程，您可以管理这些环境之间的配置，并确定应用程序具有迁移时需要运行的一切。服务器存储后端的默认实现使用git，因此它轻松支持标签版本的配置环境，以及可以访问用于管理内容的各种工具，很容易添加替代实现，并使用Spring配置将其插入。

二、创建Config Server项目

  废话不多说，按照套路我们应该建项目了，但是这次不按照套路了，因为首先我们要添加外部配置。因为config后端存储默认使用git，所以我在我的github上增加配置目录cloudconfig，里面增加4个配置文件：feigndemo-customer.yml、feigndemo-dev.yml、feigndemo-test.yml、feigndemo-pro.yml。feigndemo这个是不是很熟悉，没错，就是我们之前实验Feign的项目，后面这些dev、pro等表示环境，项目肯定都有开发、测试、生产环境，也可以自定义环境，之所以配置文件这样命名，是有原因的，用的时候我们再说。

  接下来就是创建config server项目了，依然很简单的套路，完整pom如下。

<?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"><modelVersion>4.0.0</modelVersion><groupId>com.nan</groupId><artifactId>configserver</artifactId><version>0.0.1-SNAPSHOT</version><packaging>jar</packaging><name>configserver</name><description>Demo project for Spring Boot</description><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>1.5.6.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version><spring-cloud.version>Dalston.SR2</spring-cloud.version></properties><dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-config-server</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies><dependencyManagement><dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

  主要就是要依赖spring-cloud-config-server包，然后入口文件也很简单，如下。

package com.nan.configserver;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.cloud.config.server.EnableConfigServer;@SpringBootApplication@EnableConfigServerpublic class ConfigserverApplication {    public static void main(String[] args) {        SpringApplication.run(ConfigserverApplication.class, args);    }}

  就是一个EnableConfigServer的注解，其他就不用编写代码了。又到了重要的配置文件，先看看内容吧。

spring:  application:    name: ConfigServer  cloud:    config:      server:        git:          uri: https://github.com/ArnoWang1/springcloud_study          search-paths: cloudconfig          username: <username>          password: <password>server:  port: 9300

  解释一下关于spring.cloud下面的配置，uri就是git仓库地址，search-paths表示配置文件的所在仓库目录，username和password就不说了，git用户都知道，各位朋友请使用自己账户密码。OK，config server项目就这么多，直接启动即可。

  Config Server提供的http服务有以下格式的资源

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

application表示我们的应用名称，也就是我们配置文件名称的前半部分，例如上面的feigndemo，profile表示环境，dev、pro等，这个也是可以自定义的，最后新出来的label表示我们git的分支或标签，默认就是master。现在我们在浏览器输入http://localhost:9300/feigndemo/test，表示访问master分支feigndemo项目的test环境配置，浏览器就会回显如下信息。

{"name":"feigndemo","profiles":["test"],"label":null,"version":"986663442e6157bba0b4f69013869f325c5dace5","state":null,"propertySources":[{"name":"https://github.com/ArnoWang1/springcloud_study/cloudconfig/feigndemo-test.yml","source":{"user.desc":"This is test config"}}]}

可以看到，已经拿到配置文件的user.desc属性了。

三、使用Config Client

  如果配置属性要自己编码用http去获取，估计也就没人用Spring Cloud Config了，所以Spring Cloud又为我们提供了config client。使用config client不需要新建项目了，改进我们的feigndemo项目就好了。首先新增一个controller，如下。

package com.nan.feigndemo.controller;import org.springframework.beans.factory.annotation.Value;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class ConfigClientController {    @Value("${user.desc}")    private String userDesc;    @RequestMapping("/userdesc")    public String getUserDesc() {        return userDesc;    }}

  这个大家应该很常见，其中注入的userDesc，以前都是配置在项目中的，这一次直接去Config Server中获取，和从项目配置中获取不同的是，我们要配置第一引导文件bootstrap.yml，为了方便，我就将原来的application.yml改一下名字，配置内容如下。

server:  port: 8080spring:  application:    name: FeignDemo  cloud:    config:      label: master      profile: customer      uri: http://localhost:9300eureka:  client:    serviceUrl:      defaultZone: http://node01:8081/eureka/,http://node02:8082/eureka/feign:  hystrix:    enabled: true

  新增的就是spring.cloud.config的配置，label和profile前面已经说过，uri这里指的是Config Server的服务地址。然后启动项目，访问http://localhost:8080/userdesc，就可以看到已经正确拿到属性了。这里有2点需要特殊强调一下：1、config client项目中关于spring cloud的配置，一定要放在bootstrap配置文件中；2、git仓库配置文件名称的application部分和要config client项目的application.name一致，并且不区分大小写。

四、Config Server集群

  上面我们的Config Server只是一个服务，这样是做不到高可用和负载均衡的，所以下面我们来创建一个Config Server集群，客户端从集群中拿到需要的配置。首先改进上面的configserver项目，增加Eureka依赖，完整pom如下。

<?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">    <modelVersion>4.0.0</modelVersion>    <groupId>com.nan</groupId>    <artifactId>configserver</artifactId>    <version>0.0.1-SNAPSHOT</version>    <packaging>jar</packaging>    <name>configserver</name>    <description>Demo project for Spring Boot</description>    <parent>        <groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-starter-parent</artifactId>        <version>1.5.6.RELEASE</version>        <relativePath/> <!-- lookup parent from repository -->    </parent>    <properties>        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>        <java.version>1.8</java.version>        <spring-cloud.version>Dalston.SR2</spring-cloud.version>    </properties>    <dependencies>        <dependency>            <groupId>org.springframework.cloud</groupId>            <artifactId>spring-cloud-config-server</artifactId>        </dependency>        <dependency>            <groupId>org.springframework.cloud</groupId>            <artifactId>spring-cloud-starter-eureka</artifactId>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-test</artifactId>            <scope>test</scope>        </dependency>    </dependencies>    <dependencyManagement>        <dependencies>            <dependency>                <groupId>org.springframework.cloud</groupId>                <artifactId>spring-cloud-dependencies</artifactId>                <version>${spring-cloud.version}</version>                <type>pom</type>                <scope>import</scope>            </dependency>        </dependencies>    </dependencyManagement>    <build>        <plugins>            <plugin>                <groupId>org.springframework.boot</groupId>                <artifactId>spring-boot-maven-plugin</artifactId>            </plugin>        </plugins>    </build></project>

  然后项目入口文件要加上EurekaClient注解，如下。

package com.nan.configserver;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.cloud.config.server.EnableConfigServer;import org.springframework.cloud.netflix.eureka.EnableEurekaClient;@SpringBootApplication@EnableConfigServer@EnableEurekaClientpublic class ConfigserverApplication {    public static void main(String[] args) {        SpringApplication.run(ConfigserverApplication.class, args);    }}

  最后在配置文件中，增加Eureka server地址的配置，修改后配置文件如下。

eureka:  client:    serviceUrl:      defaultZone: http://node01:8081/eureka/,http://node02:8082/eureka/spring:  profiles:    active: node01  application:    name: ConfigServer  cloud:    config:      server:        git:          uri: https://github.com/ArnoWang1/springcloud_study          search-paths: cloudconfig          username: <>          password: <>---server:  port: 9300spring:  profiles: node01---server:  port: 9301spring:  profiles: node02

  然后改进feigndemo项目，把以前配置config server地址拿掉，换上discovery.enable和discovery.service-id，enable表示是否启用从注册中心读取config server，service-id表示Config Server在注册中心的应用名称，完整配置如下。

server:  port: 8080spring:  application:    name: FeignDemo  cloud:    config:      label: master      profile: customer      discovery:        enabled: true        service-id: ConfigServereureka:  client:    serviceUrl:      defaultZone: http://node01:8081/eureka/,http://node02:8082/eureka/feign:  hystrix:    enabled: true

  先启动2个Eureka server，然后再启动2个Config Server，然后启动feigndemo项目，可以发现一样能拿到配置，随便停掉一个config server，再重启feigndemo项目，也是可以拿到配置属性，证明已经实现的Config Server的高可用配置。

  以上就是笔者目前所学，还是很初级的内容，如果有什么错误和遗漏，还请见谅并指正，不胜感激。