Spring Cloud分布式配置

Spring Cloud Config为服务端和客户端提供了分布式系统的外部化配置支持。
配置服务器为各应用的所有环境提供了一个中心化的外部配置。它实现了对服务端和客户端对Spring Environment
和PropertySource抽象的映射，所以它除了适用于Spring构建的应用程序，也可以在任何其他语言运行的应用程序中使用。
作为一个应用可以通过部署管道来进行测试或者投入生产，我们可以分别为这些环境创建配置，
并且在需要迁移环境的时候获取对应环境的配置来运行。
配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的
管理和访问配置内容。当然他也提供本地化文件系统的存储方式，下面从这两方面介绍如何使用分布式配置来存储微服务
应用多环境的配置内容。

构建Config Server

场景Spring Boot初始项目，然后在pom.xml中添加如下依赖。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-config-server</artifactId>
     </dependency>
     <dependencyManagement>
     	<dependencies>
         	<dependency>
              <groupId>org.springframework.cloud</groupId>
              <artifactId>spring-cloud-dependencies</artifactId>
              <version>Brixton.RELEASE</version>
              <type>pom</type>
              <scope>import</scope>
         	</dependency>
    	 	</dependencies>
    </dependencyManagement>

在Spring Boot主类中添加@EnableConfigServer注解，开启config-server功能

1
2
3
4
5
6
7
8
9
@EnableConfigServer
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(true).run(args);
    }
}

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

1
2
3
4
5
6
7
8
9
10
11
spring.application.name=config-server
server.port=7001
# git管理配置
spring.cloud.config.server.git.uri=https://github.com/yangzhiw/Simple-Spring-Cloud
spring.cloud.config.server.git.searchPaths=config-repo
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password
# 开启本地配置
# spring.profiles.active=native

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也提供本地存储配置的方式。我们只需要设置属性spring.profiles.active=native，
Config Server会默认从应用的src/main/resource目录下检索配置文件。也可以通过
spring.cloud.config.server.native.searchLocations=file:D:/properties/属性来指定配置文件的位置。
虽然Spring Cloud Config提供了这样的功能，但是为了支持更好的管理内容和版本控制的功能，
还是推荐使用git的方式

服务端验证

在项目中创建一个config-repo文件夹，配置了四个配置文件
配置文件分别为：
juzi.properties
juzi-dev.properties
juzi-test.properties
juzi-prod.properties
可以在四个配置文件中设置属性

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。
然后我们就可访问我们的配置文件了。如：http://localhost:7001/juzi/prod/
这便是访问生成环境的配置文件。

服务端配置映射

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Brixton.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

创建bootstrap.properties配置，来指定config server，例如：

1
2
3
4
5
6
spring.application.name=didispace  
spring.cloud.config.profile=dev  
spring.cloud.config.label=master  
spring.cloud.config.uri=http://localhost:7001/
server.port=7002

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 @RefreshScope
@RestController
class TestController {
    @Value("${from}")
    private String from;
    @RequestMapping("/from")
    public String from() {
        return this.from;
    }
}

通过@Value(“${from}”)绑定配置服务中配置的from属性。

启动该应用，并访问：http://localhost:7002/from ，我们就可以根据配置内容输出对应环境的from内容了。