Spring Cloud构建微服务架构之八 分布式配置中心

Spring Cloud Config为服务端和客户端提供了分布式系统的外部化配置支持。配置服务器为各应用的所有环境提供了一个中心化的外部配置。
配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。

构建Config Server
通过Spring Cloud构建一个Config Server，第一步：
pom.xml中引入spring-cloud-config-server依赖，完整依赖配置如下：

<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.RELEASE</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>

在Spring Boot的程序主类添加@EnableConfigServer注解：

@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

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

在application.properties中配置服务信息以及git信息：

spring.application.name=config-server
server.port=7001
# git\u7BA1\u7406\u914D\u7F6E
spring.cloud.config.server.git.uri=https://git.coding.net/weimin/cloud.git/
spring.cloud.config.server.git.searchPaths=config-center/config-repo
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password

注意：
spring.cloud.config.server.git.uri：配置git仓库位置
spring.cloud.config.server.git.searchPaths：配置仓库路径下的相对搜索位置，可以配置多个
spring.cloud.config.server.git.username：访问git仓库的用户名
spring.cloud.config.server.git.password：访问git仓库的用户密码

一个通过Spring Cloud Config实现，并使用git管理内容的配置中心已经完成了，启动该应用，成功后开始下面的内容。

另注：
Spring Cloud Config也提供本地存储配置的方式。我们只需要设置属性spring.profiles.active=native
，Config Server会默认从应用的src/main/resource目录下检索配置文件。
也可以通过spring.cloud.config.server.native.searchLocations=file:E:/properties/
属性来指定配置文件的位置。

服务端验证
为了验证上面完成的配置服务器，在https://coding.net/u/weimin/p/cloud/git/tree/master/config-center/ 下创建了一个config-repo目录作为配置仓库，并根据不同环境新建了下面四个配置文件：
configsample.properties
configsample-dev.properties
configsample-test.properties
configsample-prod.properties

其中设置了一个from属性，为每个配置文件分别设置了不同的值，如：
from=git-default-1.0
from=git-dev-1.0
from=git-test-1.0
from=git-prod-1.0

为了测试版本控制，在master中，我们都加入1.0的后缀，同时创建一个config-test分支，并将各配置文件中的值用2.0作为后缀。
完成了这些准备工作之后，我们就可以通过浏览器或POSTMAN等工具直接来访问到我们的配置内容了。
URL与配置文件的映射关系如下：
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties

上面的url会映射{application}-{profile}.properties
对应的配置文件，{label}
对应git上不同的分支，默认为master。

可以尝试构造不同的url来访问不同的配置内容，比如：要访问config-test分支，configsample应用的prod环境，可以通过这个url：http://localhost:7001/weimin/prod/config-test

{
  "name": "weimin",
  "profiles": [
    "prod"
  ],
  "label": "config-test",
  "version": null,
  "state": null,
  "propertySources": []
}

微服务端映射配置

在完成并验证了配置服务中心之后，下面看看我们如何在微服务应用中获取配置信息。

创建一个Spring Boot应用，在pom.xml中引入spring-cloud-starter-config依赖，完整依赖关系如下：

<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.RELEASE</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</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-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>

创建最基本的Spring Boot启动主类:

@SpringBootApplication
public class ConfigClientApplication {

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

在bootstrap.properties中配置，来指定config server，例如：

spring.application.name=configsample
spring.cloud.config.profile=dev
spring.cloud.config.uri=http://localhost:7001/

server.port=7002

注意：
spring.application.name：对应前配置文件中的{application}部分
spring.cloud.config.profile：对应前配置文件中的{profile}部分
spring.cloud.config.label：对应前配置文件的git分支
spring.cloud.config.uri：配置中心的地址

需要格外注意：上面这些属性必须配置在bootstrap.properties中，config部分内容才能被正确加载。因为config的相关配置会先于application.properties，而bootstrap.properties的加载也是先于application.properties。

创建一个Rest Api来返回配置中心的from属性，具体如下：

@RefreshScope
@RestController
class TestController {

    @Value("${from}")
    private String from;

    @RequestMapping("/from")
    public String from() {

        return this.from;
    }

    public void setFrom(String from) {
        this.from = from;
    }

    public String getFrom() {
        return from;
    }

}

通过@Value("${from}") 绑定配置服务中配置的from属性。
启动该应用，并访问：http://localhost:7002/from ，我们就可以根据配置内容输出对应环境的from内容了。

完整示例：config-center
分布式配置中心的高可用性和刷新问题，我就不再写文了，请参考：http://blog.didispace.com/springcloud4-2/
我自己的例子：config-ext