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

163 阅读3分钟

如何构建一个基于Git存储的分布式配置中心,并对客户端进行改造,并让其能够从配置中心获取配置信息并绑定到代码中的整个过程。

准备配置仓库

准备一个git仓库,可以在码云或Github上创建都可以。

假设我们读取配置中心的应用名为config-client,那么我们可以在git仓库中该项目的默认配置文件config-client.yml:

info:

profile: default

为了演示加载不同环境的配置,我们可以在git仓库中再创建一个针对dev环境的配置文件config-client-dev.yml:

info:

profile: dev

构建配置中心

通过Spring Cloud Config来构建一个分布式配置中心非常简单,只需要三步:

创建一个基础的Spring Boot工程,命名为:config-server-git,并在pom.xml中引入下面的依赖(省略了parent和dependencyManagement部分):

org.springframework.cloud

spring-cloud-config-server

创建Spring Boot的程序主类,并添加@EnableConfigServer注解,开启Spring Cloud Config的服务端功能。

@EnableConfigServer

@SpringBootApplication

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

}

在application.yml中添加配置服务的基本信息以及Git仓库的相关信息,例如: spring

application:

name: config-server

cloud:

config:

server:

git:

uri:

server:

port: 1201

到这里,使用一个通过Spring Cloud Config实现,并使用Git管理配置内容的分布式配置中心就已经完成了。我们可以将该应用先启动起来,确保没有错误产生,然后再尝试下面的内容。

如果我们的Git仓库需要权限访问,那么可以通过配置下面的两个属性来实现;

spring.cloud.config.server.git.username:访问Git仓库的用户名

spring.cloud.config.server.git.password:访问Git仓库的用户密码

完成了这些准备工作之后,我们就可以通过浏览器、POSTMAN或CURL等工具直接来访问到我们的配置内容了。访问配置信息的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来访问不同的配置内容,比如,要访问master分支,config-client应用的dev环境,就可以访问这个url:

{

"name": "config-client",

"profiles": [

"dev"

],

"label": "master",

"version": null,

"state": null,

"propertySources": [

{

"name": "",

"source": {

"info.profile": "dev"

}

},

{

"name": "",

"source": {

"info.profile": "default"

}

}

]

}

我们可以看到该Json中返回了应用名:config-client,环境名:dev,分支名:master,以及default环境和dev环境的配置内容。

构建客户端

在完成了上述验证之后,确定配置服务中心已经正常运作,下面我们尝试如何在微服务应用中获取上述的配置信息。

创建一个Spring Boot应用,命名为config-client,并在pom.xml中引入下述依赖:

org.springframework.boot

spring-boot-starter-web

org.springframework.cloud

spring-cloud-starter-config

创建Spring Boot的应用主类,具体如下:

@SpringBootApplication

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

}

创建bootstrap.yml配置,来指定获取配置文件的config-server-git位置,例如:

spring:

application:

name: config-client

cloud:

config:

uri:

profile: default

label: master

server:

port: 2001

上述配置参数与Git中存储的配置文件中各个部分的对应关系如下:

spring.application.name:对应配置文件规则中的{application}部分

spring.cloud.config.profile:对应配置文件规则中的{profile}部分

spring.cloud.config.label:对应配置文件规则中的{label}部分

spring.cloud.config.uri:配置中心config-server的地址

这里需要格外注意:上面这些属性必须配置在bootstrap.properties中,这样config-server中的配置信息才能被正确加载。

在完成了上面你的代码编写之后,读者可以将config-server-git、config-client都启动起来

{

"profile": "default"

}

另外,我们也可以修改config-client的profile为dev来观察加载配置的变化。