Spring Cloud配置中心git示例

随着线上项目变的日益庞大,每个项目都散落着各种配置文件,如果采用分布式的开发模式,需要的配置文件随着服务增加而不断增多。某一个基础服务信息变更,都会引起一系列的更新和重启,运维苦不堪言也容易出错。配置中心便是解决此类问题的灵丹妙药。

市面上开源的配置中心有很多,BAT每家都出过,360的QConf、淘宝的diamond、百度的disconf都是解决这类问题。国外也有很多开源的配置中心Apache Commons Configuration、owner、cfg4j等等。这些开源的软件以及解决方案都很优秀,但是Spring Cloud Config功能全面强大,可以无缝的和Spring体系相结合。

Spring Cloud Config

在了解Spring Cloud Config之前,可以想想一个配置中心提供的核心功能应该有什么

  • 提供服务端和客户端支持
  • 集中管理各环境的配置文件
  • 配置文件修改之后,可以快速的生效
  • 可以进行版本管理
  • 支持大的并发查询
  • 支持各种语言

Spring Cloud Config可以完美的支持以上所有的需求。

Spring Cloud Config项目是一个解决分布式系统的配置管理方案。它包含了Client和Server两个部分,Server提供配置文件的存储、以接口的形式将配置文件的内容提供出去,Client通过接口获取数据、并依据此数据初始化自己的应用。Spring Cloud使用git或svn存放配置文件,默认情况下使用git,我们先以git为例做一套示例。

首先在Github上面创建了一个文件夹config-repo用来存放配置文件,为了模拟生产环境,我们创建以下三个配置文件:

1
2
3
4
5
6
// 开发环境
appblog-config-dev.properties
// 测试环境
appblog-config-test.properties
// 生产环境
appblog-config-pro.properties

每个配置文件中都写一个属性appblog.hello,属性值分别是Hello, I'm dev。下面我们开始配置server端

Server端

添加依赖

1
2
3
4
5
6
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
</dependencies>

只需要加入spring-cloud-config-server包引用既可

配置文件

1
2
3
4
5
6
7
8
9
10
11
12
13
server:
port: 8001
spring:
application:
name: spring-cloud-config-server
cloud:
config:
server:
git:
uri: https://github.com/ityouknow/spring-cloud-starter/ # 配置git仓库的地址
search-paths: config-repo # git仓库地址下的相对地址,可以配置多个,用`,`分割。
username: # git仓库的账号
password: # git仓库的密码

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

启动类

启动类添加@EnableConfigServer,激活对配置中心的支持

1
2
3
4
5
6
7
8
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

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

到此Server端相关配置已经完成

测试

首先我们先要测试Server端是否可以读取到github上面的配置信息,直接访问:http://localhost:8001/appblog-config/dev

返回信息如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"name": "appblog-config",
"profiles": [
"dev"
],
"label": null,
"version": null,
"state": null,
"propertySources": [
{
"name": "https://github.com/iyezhou/spring-cloud-starter/config-repo/appblog-config-dev.properties",
"source": {
"appblog.hello": "Hello, I'm dev"
}
}
]
}

上述的返回的信息包含了配置文件的位置、版本、配置文件的名称以及配置文件中的具体内容,说明Server端已经成功获取了git仓库的配置信息。

如果直接查看配置文件中的配置信息可访问:http://localhost:8001/appblog-config-dev.properties ,返回:appblog.hello: Hello, I'm dev

修改配置文件appblog-config-dev.properties中配置信息为:appblog.hello=Hello, I'm dev update,再次在浏览器访问http://localhost:8001/appblog-config-dev.properties ,返回:appblog.hello: Hello, I'm dev update。说明server端会自动读取最新提交的内容

仓库中的配置文件会被转换成web接口,访问可以参照以下的规则:

  • /{application}/{profile}[/{label}]
  • /{application}-{profile}.yml
  • /{label}/{application}-{profile}.yml
  • /{application}-{profile}.properties
  • /{label}/{application}-{profile}.properties

appblog-config-dev.properties为例子,它的applicationappblog-configprofiledev。Client会根据填写的参数来选择读取对应的配置。

Client端

主要展示如何在业务项目中去获取server端的配置信息

添加依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

引入spring-boot-starter-web包方便web测试

配置文件

需要配置两个配置文件:application.propertiesbootstrap.properties

application.properties如下:

1
2
spring.application.name=spring-cloud-config-client
server.port=8002

bootstrap.properties如下:

1
2
3
4
spring.cloud.config.name=appblog-config
spring.cloud.config.profile=dev
spring.cloud.config.uri=http://localhost:8001/
spring.cloud.config.label=master
  • spring.application.name:对应{application}部分
  • spring.cloud.config.profile:对应{profile}部分
  • spring.cloud.config.label:对应git的分支。如果配置中心使用的是本地存储,则该参数无用
  • spring.cloud.config.uri:配置中心的具体地址
  • spring.cloud.config.discovery.service-id:指定配置中心的service-id,便于扩展为高可用配置集群。

特别注意:上面这些与spring-cloud相关的属性必须配置在bootstrap.properties中,config部分内容才能被正确加载。因为config的相关配置会先于application.properties,而bootstrap.properties的加载也是先于application.properties

启动类

启动类只需要@SpringBootApplication注解就可以

1
2
3
4
5
6
7
@SpringBootApplication
public class ConfigClientApplication {

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

web测试

使用@Value注解来获取Server端参数的值

1
2
3
4
5
6
7
8
9
10
@RestController
class HelloController {
@Value("${appblog.hello}")
private String hello;

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

启动项目后访问:http://localhost:8002/hello ,返回:Hello, I'm dev update,说明已经正确的从Server端获取到了参数。到此一个完整的服务端提供配置服务,客户端获取配置参数的例子就完成了。

我们再进行一些小实验,手动修改appblog-config-dev.properties中配置信息为:appblog.hello=Hello, I'm dev update more,提交到Github,再次在浏览器访问http://localhost:8002/hello ,返回:appblog.hello: Hello, I'm dev update,说明获取的信息还是旧的参数,这是为什么呢?因为Spring Boot项目只有在启动的时候才会获取配置文件的值,修改Github信息后,Client端并没有再次去获取,所以导致这个问题。

Powered by AppBlog.CN     浙ICP备14037229号

Copyright © 2012 - 2020 APP开发技术博客 All Rights Reserved.

访客数 : | 访问量 :