Spring Cloud Config：外部集中化配置管理

时间 2019-11-06

标签 spring cloud config 外部集中化配置管理栏目 Spring 繁體版

原文原文链接

SpringBoot实战电商项目mall（20k+star）地址：github.com/macrozheng/…java

摘要

Spring Cloud Config 能够为微服务架构中的应用提供集中化的外部配置支持，它分为服务端和客户端两个部分，本文将对其用法进行详细介绍。git

Spring Cloud Config 简介

Spring Cloud Config 分为服务端和客户端两个部分。服务端被称为分布式配置中心，它是个独立的应用，能够从配置仓库获取配置信息并提供给客户端使用。客户端能够经过配置中心来获取配置信息，在启动时加载配置。Spring Cloud Config 的配置中心默认采用Git来存储配置信息，因此自然就支持配置信息的版本管理，而且可使用Git客户端来方便地管理和访问配置信息。github

在Git仓库中准备配置信息

因为Spring Cloud Config 须要一个存储配置信息的Git仓库，这里咱们先在Git仓库中添加好配置文件再演示其功能，Git仓库地址为：gitee.com/macrozheng/…。web

配置仓库目录结构

master分支下的配置信息

config-dev.yml:

config:
 info: "config info for dev(master)"
复制代码

config-test.yml:

config:
 info: "config info for test(master)"
复制代码

config-prod.yml:

config:
 info: "config info for prod(master)"
复制代码

dev分支下的配置信息

config-dev.yml:

config:
 info: "config info for dev(dev)"
复制代码

config-test.yml:

config:
 info: "config info for test(dev)"
复制代码

config-prod.yml:

config:
 info: "config info for prod(dev)"
复制代码

建立config-server模块

这里咱们建立一个config-server模块来演示Spring Cloud Config 做为配置中心的功能。spring

在pom.xml中添加相关依赖

<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>
复制代码

在application.yml中进行配置

server:
 port: 8901
spring:
 application:
 name: config-server
 cloud:
 config:
 server:
 git: #配置存储配置信息的Git仓库
 uri: https://gitee.com/macrozheng/springcloud-config.git
 username: macro
 password: 123456
 clone-on-start: true #开启启动时直接从git获取配置
eureka:
 client:
 service-url:
 defaultZone: http://localhost:8001/eureka/
复制代码

在启动类上添加@EnableConfigServer注解来启用配置中心功能

@EnableConfigServer
@EnableDiscoveryClient
@SpringBootApplication
public class ConfigServerApplication {

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

}
复制代码

经过config-server获取配置信息

这里咱们经过config-server来演示下如何获取配置信息。bootstrap

获取配置文件信息的访问格式

# 获取配置信息
/{label}/{application}-{profile}
# 获取配置文件信息
/{label}/{application}-{profile}.yml
复制代码

占位符相关解释

application：表明应用名称，默认为配置文件中的spring.application.name，若是配置了spring.cloud.config.name，则为该名称；
label：表明分支名称，对应配置文件中的spring.cloud.config.label；
profile：表明环境名称，对应配置文件中的spring.cloud.config.profile。

获取配置信息演示

启动eureka-server、config-server服务；安全
访问http://localhost:8901/master/config-dev来获取master分支上dev环境的配置信息；bash

访问http://localhost:8901/master/config-dev.yml来获取master分支上dev环境的配置文件信息，对比上面信息，能够看出配置信息和配置文件信息并非同一个概念；

访问http://localhost:8901/master/config-test.yml来获取master分支上test环境的配置文件信息:

访问http://localhost:8901/dev/config-dev.yml来获取dev分支上dev环境的配置文件信息:

建立config-client模块

咱们建立一个config-client模块来从config-server获取配置。架构

在pom.xml中添加相关依赖

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

在bootstrap.yml中进行配置

server:
 port: 9001
spring:
 application:
 name: config-client
 cloud:
 config: #Config客户端配置
 profile: dev #启用配置后缀名称
 label: dev #分支名称
 uri: http://localhost:8901 #配置中心地址
 name: config #配置文件名称
eureka:
 client:
 service-url:
 defaultZone: http://localhost:8001/eureka/
复制代码

添加ConfigClientController类用于获取配置

/** * Created by macro on 2019/9/11. */
@RestController
public class ConfigClientController {

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

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}
复制代码

演示从配置中心获取配置

启动config-client服务；app
访问http://localhost:9001/configInfo，能够获取到dev分支下dev环境的配置；

config info for dev(dev)
复制代码

获取子目录下的配置

咱们不只能够把每一个项目的配置放在不一样的Git仓库存储，也能够在一个Git仓库中存储多个项目的配置，此时就会用到在子目录中搜索配置信息的配置。

首先咱们须要在config-server中添加相关配置，用于搜索子目录中的配置，这里咱们用到了application占位符，表示对于不一样的应用，咱们从对应应用名称的子目录中搜索配置，好比config子目录中的配置对应config应用；

spring:
 cloud:
 config:
 server:
 git: 
 search-paths: '{application}'
复制代码

访问http://localhost:9001/configInfo进行测试，能够发现获取的是config子目录下的配置信息。

config info for config dir dev(dev)
复制代码

刷新配置

当Git仓库中的配置信息更改后，咱们能够经过SpringBoot Actuator的refresh端点来刷新客户端配置信息，如下更改都须要在config-client中进行。

在pom.xml中添加Actuator的依赖：

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
复制代码

在bootstrap.yml中开启refresh端点：

management:
 endpoints:
 web:
 exposure:
 include: 'refresh'
复制代码

在ConfigClientController类添加@RefreshScope注解用于刷新配置：

/** * Created by macro on 2019/9/11. */
@RestController
@RefreshScope
public class ConfigClientController {

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

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}
复制代码

从新启动config-client后，调用refresh端点进行配置刷新：

访问http://localhost:9001/configInfo进行测试，能够发现配置信息已经刷新。

update config info for config dir dev(dev)
复制代码

配置中心添加安全认证

咱们能够经过整合SpringSecurity来为配置中心添加安全认证。

建立config-security-server模块

在pom.xml中添加相关依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>
复制代码

在application.yml中进行配置：

server:
 port: 8905
spring:
 application:
 name: config-security-server
 cloud:
 config:
 server:
 git:
 uri: https://gitee.com/macrozheng/springcloud-config.git
 username: macro
 password: 123456
 clone-on-start: true #开启启动时直接从git获取配置
 security: #配置用户名和密码
 user:
 name: macro
 password: 123456
复制代码

启动config-security-server服务。

修改config-client的配置

添加bootstrap-security.yml配置文件，主要是配置了配置中心的用户名和密码：

server:
 port: 9002
spring:
 application:
 name: config-client
 cloud:
 config:
 profile: dev #启用配置后缀名称
 label: dev #分支名称
 uri: http://localhost:8905 #配置中心地址
 name: config #配置文件名称
 username: macro
 password: 123456
复制代码

使用bootstrap-security.yml启动config-client服务；
访问http://localhost:9002/configInfo进行测试，发现能够获取到配置信息。

config info for dev(dev)
复制代码

config-sever集群搭建

在微服务架构中，全部服务都从配置中心获取配置，配置中心一旦宕机，会发生很严重的问题，下面咱们搭建一个双节点的配置中心集群来解决该问题。

启动两个config-server分别运行在8902和8903端口上；
添加config-client的配置文件bootstrap-cluster.yml，主要是添加了从注册中心获取配置中心地址的配置并去除了配置中心uri的配置：

spring:
 cloud:
 config:
 profile: dev #启用环境名称
 label: dev #分支名称
 name: config #配置文件名称
 discovery:
 enabled: true
 service-id: config-server
eureka:
 client:
 service-url:
 defaultZone: http://localhost:8001/eureka/
复制代码

以bootstrap-cluster.yml启动config-client服务，注册中心显示信息以下：

访问http://localhost:9003/configInfo，发现config-client能够获取到配置信息。

config info for config dir dev(dev)
复制代码

使用到的模块

springcloud-learning
├── eureka-server -- eureka注册中心
├── config-server -- 配置中心服务
├── config-security-server -- 带安全认证的配置中心服务
└── config-client -- 获取配置的客户端服务
复制代码

项目源码地址

github.com/macrozheng/…

公众号

mall项目全套学习教程连载中，关注公众号第一时间获取。