[菜鸟SpringCloud实战入门]第六章:配置中心Spring Cloud Config初体验

前言

欢迎来到菜鸟SpringCloud实战入门系列(SpringCloudForNoob),该系列通过层层递进的实战视角,来一步步学习和理解SpringCloud。

本系列适合有一定Java以及SpringBoot基础的同学阅读。

每篇文章末尾都附有本文对应的Github源代码,方便同学调试。

实战版本

  • SpringBoot:2.0.3.RELEASE
  • SpringCloud:Finchley.RELEASE

-----正文开始-----

配置中心Spring Cloud Config初体验

使用Git存放配置文件

每个项目都会有很多的配置文件,如果采用分布式的开发模式,需要的配置文件随着服务增加而不断增多。配置中心便是解决此类问题的灵丹妙药。

Spring Cloud Config核心功能:

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

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

创建配置仓库文件夹

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

// 开发环境
spring-cloud-config-dev.properties
// 测试环境
spring-cloud-config-test.properties
// 生产环境
spring-cloud-config-prod.properties

目录为:

在这里插入图片描述

每个配置文件中都写一个属性config.hello,属性值分别是 hello Im dev/test/pro 。

配置server端

下面我们开始配置server端,我们新建一个模块名为config-server,创建模块请参考教程第一章。

pom中添加依赖:

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

然后修改配置文件:

这里需要配置你自己的github或者别的git仓库,并且需要填写自己的账户密码,你可以fork我的springcloud_for_noob项目,在项目基础上进行修改。

server:
  port: 8769
spring:
  application:
    name: spring-cloud-config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/xxxxx(你自己的账户名)/springcloud_for_noob.git # 配置git仓库的地址
          search-paths: config-repo                              # git仓库地址下的相对地址,可以配置多个,用,分割。
          username: xxxxxxxxx                               # git仓库的账号
          password: xxxxxxx                    

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:

@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

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

直接查看配置文件中的配置信息可访问:

http://localhost:8769/spring-cloud-config-dev.properties

在这里插入图片描述

这样服务端就建立好了,并且连接上了远程配置文件仓库。

配置client端

server搞起来之后,最终还是要在业务项目中去获取server端的配置信息

我们新建一个模块名为config-client,创建模块请参考教程第一章。

pom中添加依赖:

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <!--无法引入:spring-cloud-config-server-->
        <artifactId>spring-cloud-config-client</artifactId>
    </dependency>
</dependencies>

配置文件:

为了方便起见,我们回归使用properties文件

需要配置两个配置文件:

  • application.properties
  • bootstrap.properties

application.properties如下:

server.port = 8771
spring.application.name = spring-cloud-config-client

bootstrap.properties如下:

spring.cloud.config.name = spring-cloud-config
spring.cloud.config.profile = dev
spring.cloud.config.uri = http://localhost:8769/
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。

启动类:

启动类不用附加注解,直接可以开始了。

测试类HelloController:

为了测试客户端能否正确获取参数,我们创建一个测试类HelloController

最终测试:

启动项目后访问:http://localhost:8769/hello ,返回:

在这里插入图片描述

如图所示,拿到了配置参数,我们完成了客户端的测试。

但实际中,如更改了配置并将其push到了git服务器上,我们通过客户端访问,仍然会获取旧的参数。这是因为springboot项目只有在启动的时候才会获取配置文件的值,修改git信息后,client端并没有再次去获取。下一章我们的目标就是使client实现刷新机制。

本章代码:

https://github.com/qqxx6661/springcloud_for_noob/tree/master/06-config-server-config-client

参考

springcloud(六):配置中心git示例

http://www.ityouknow.com/springcloud/2017/05/22/springcloud-config-git.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,992评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,212评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,535评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,197评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,310评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,383评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,409评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,191评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,621评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,763评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,403评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2 351

推荐阅读更多精彩内容