Spring Cloud Config

之前的学习中，需要在每个项目模块中都写很多配置，维护起来很不方便。Spring Cloud Config的出现就解决了这一问题。

Spring Cloud Config项目是一个解决分布式系统的配置管理方案。它包含Client和Server两个部分，Server提供配置文件的储存（储存在本地、git、svn）、以接口的形式将配置文件的内容提供出去；Client通过接口获取数据、并依据此数据初始化自己的应用。

Server 端

创建模块:spring-cloud-config-server

导入依赖

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

本地储存

修改application.yml

server:
  port: 8080

spring:
  application:
    name: spring-cloud-config-server
  # 本地储存配置
  profiles:
    active: native
  cloud:
    config:
      server:
        # 本地储存配置
        native:
          search-locations: classpath:config/

spring.profiles.active: native使用本地储存方式，Config Server会默认从应用的src/main/resource目录下检索配置文件，通过spring.cloud-config.server.native.search-locations指定配置文件的相对地址。

在config/下创建配置文件

这里举例两个配置：config-dev.yml（开发环境）和config-pro.yml（生产环境）：

config-dev.yml:

config:
  hello: this is dev

config-pro.yml:

config:
  hello: this is pro

启动器类

@EnableConfigServer
@SpringBootApplication
public class SpringCloudConfigServerApplication {

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

测试

启动spring-cloud-config-server模块，浏览器访问http://localhost:8080/config/dev

访问http://localhost:8080/config-dev.yml，则会实现这个配置文件的数据

Spring Cloud Config会将配置文件转换成Web接口，访问依照以下原则：

• /{application}/{profile}/{label}
• /{application}-{profile}.yml
• /{label}/{application}-{profile}.yml
• /{application}-{profile}.yml
• /{label}/{application}-{profile}.yml

以resource/config/config-dev.yml文件为例，因为我们使用的本地储存的方式。那么config-dev.yml文件的config就是application，dev就是profile。Spring Cloud Config Client会根据配置文件的名称和你传入的参数读取对应的配置。

Git 储存

修改application.yml

server:
  port: 8080

spring:
  application:
    name: spring-cloud-config-server
  cloud:
    config:
      server:
        # git储存配置
        git:
          uri:            # git仓库地址
          search-paths:   # git仓库地址下的相对地址，可配置多个
          username:       # git仓库的账号
          password:       # git仓库的密码

Client 端

引入依赖

<dependencies>
    <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-config-client</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

修改配置文件application.yml

server:
  port: 8081
spring:
  application:
    name: spring-cloud-config-client
  profiles:
    active: native
  # 配置中心
  cloud:
    config:
      server:
        native:
          search-locations: classpath:/config/

新建配置文件：bootstrap.yml:

spring:
  cloud:
    config:
      name: config
      profile: dev
      uri: http://localhost:8080/
      label: master

模拟创建一个控制器类

@RestController
public class HelloController {

    @Value("${config.hello}")
    private String hello;

    @GetMapping("/hello")
    public String hello() {
        return this.hello;
    }
}

测试

访问localhost:8081/hello即可。

在Config Client端，并不需要再控制器类上添加任何注解，会自动注册此服务。在模拟演示的Controller中，${config.hello}得到的就是Config Server中储存的配置文件数据