分布式配置中心

Posted 2020-08-27 技术改变生活

Spring Cloud Config为服务端和客户端提供了分布式系统的外部化配置支持。配置服务器为各应用的所有环境提供了一个中心化的外部配置。它实现了对服务端和客户端对Spring Environment和PropertySource抽象的映射，所以它除了适用于Spring构建的应用程序，也可以在任何其他语言运行的应用程序中使用。作为一个应用可以通过部署管道来进行测试或者投入生产，我们可以分别为这些环境创建配置，并且在需要迁移环境的时候获取对应环境的配置来运行。

 

置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。当然他也提供本地化文件系统的存储方式。

使用 spring Cloud 进行集中式配置管理，将以往的配置文件从项目中摘除后放到Git 或svn中集中管理，并在需要变更的时候，可以通知到各应用程序，应用程序刷新配置不需要重启。

 

基本原理

git 上存放我们的远程配置文件 
config-server 连接到 git 
config-client 连接到config-server 
当我们启动config-client 服务的时候，client 会通过连接的 config-server 拿到远程git 上面的配置文件，然后通过 Spring 加载到对象中。 

构建Config Server

pom.xml依赖

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
</dependency>

 

创建Spring Boot的程序主类，并添加@EnableConfigServer注解，开启Config Server

@EnableConfigServer
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(true).run(args);
    }
}

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

spring.application.name=config-server
#spring boot port
server.port=7001

# git管理配置
spring.cloud.config.server.git.uri=http://git.oschina.net/zjb_china/SpringCloud-Learning
spring.cloud.config.server.git.searchPaths=Chapter9-1-4/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:F:/properties/属性来指定配置文件的位置。

服务端验证

Chapter9-1-4/ 下创建了一个config-repo目录作为配置仓库，并根据不同环境新建了下面四个配置文件：

• didispace.properties
• didispace-dev.properties
• didispace-test.properties
• didispace-prod.properties

其中设置了一个from属性，为每个配置文件分别设置了不同的值，如：

• from=git-default-1.0
• from=git-dev-1.0
• from=git-test-1.0
• from=git-prod-1.0

同时创建一个config-label-test分支，并将各配置文件中的值用2.0作为后缀

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。

要访问config-label-test分支，didispace应用的prod环境，可以通过这个url：http://localhost:7001/didispace/prod/config-label-test

 

如何在微服务应用中获取配置信息

pom.xml依赖

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

 

 

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

#bootstrap.properties的加载也是先于application.properties

#bootstrap.properties配置，来指定config server

#对应前配置文件中的{application}部分
spring.application.name=didispace
#对应前配置文件中的{profile}部分
spring.cloud.config.profile=test
#对应前配置文件的git分支
spring.cloud.config.label=config-label-test
#配置中心的地址
spring.cloud.config.uri=http://localhost:7001/
#spring boot port
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。

 

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

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(true).run(args);
    }
}

创建一个Rest Api来返回配置中心的from属性

@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内容了。

 

 

如何在不重启 config-client 服务的情况下让项目中引用的配置信息更新呢？ 

 

config-client 工程中添加依赖监控模块，其中包含了/refresh刷新API

 

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <optional>true</optional>
</dependency>

 

在需要自动更新配置变量的Java类上，使用注解 @RefreshScope 修饰　　

 

 以后当我们再更新git上面的配置文件后，在 config-client 端执行POST 请求 http://localhost:8080/refresh 就可以更新刷新配置变量到内存中了。

 

如果我们 config-client 做的是分布式部署，岂不是要每一个机器都POST一下 /refresh 请求，这样显然不是最好的方法。 
Spring Cloud Bus 为我们解决了这样的问题。

 

 通过Spring Cloud Bus来实现以消息总线的方式进行通知配置信息的变化，完成集群上的自动化更新。

Cloud Bus 需要依赖AMQP、Redis、Kafka 这样的组件做为代理才可以使用。