Spring Cloud Alibaba之服務(wù)發(fā)現(xiàn)組件 - Nacos作為配置中心+配置屬性動(dòng)態(tài)刷新(五)

通過(guò)之前文章的學(xué)習(xí)我們已經(jīng)學(xué)會(huì)了使用Nacos完成服務(wù)的注冊(cè)與發(fā)現(xiàn)。同時(shí)也介紹了Spring Cloud中不同風(fēng)格的服務(wù)消費(fèi)方式氓侧。接下來(lái),我們?cè)賮?lái)學(xué)習(xí)下Nacos的另一個(gè)重要功能:配置管理

簡(jiǎn)介

Nacos除了可以實(shí)現(xiàn)服務(wù)的注冊(cè)與發(fā)現(xiàn)之外,還將配置中心的功能整合在一起蜂奸。通過(guò)Nacos的配置管理功能箫爷,我們可以將整個(gè)架構(gòu)體系能的所有配置都集中到Nacos中存儲(chǔ)嚷节。這樣做的好處主要有以下幾點(diǎn):

  • 分離的多環(huán)境配置,可以靈活的管理權(quán)限虎锚,安全性更高
  • 應(yīng)用程序的打包更為純粹硫痰,已實(shí)現(xiàn)一次打包,多處運(yùn)行的特點(diǎn)

Nacos的配置管理模型與淘寶開(kāi)源的配置中心Diamond類(lèi)似窜护,基礎(chǔ)層面通過(guò)DataIdGroup來(lái)定位配置內(nèi)容效斑,除此之外還增加了很多其他的管理功能。

快速入門(mén)

下面我們通過(guò)一個(gè)簡(jiǎn)單的例子來(lái)介紹如何使用Nacos來(lái)創(chuàng)建配置內(nèi)容以及如何在Spring Cloud應(yīng)用中加載Nacos的配置信息柱徙。

創(chuàng)建配置

第一步: 進(jìn)入Nacos的控制頁(yè)面缓屠,在配置列表功能頁(yè)面中奇昙,單擊右上角的+按鈕,進(jìn)入新建配置頁(yè)面敌完,如圖填寫(xiě)配置信息:

其中:

  • Data ID: 填入 alibaba-nacos-config-client.properties
  • Group: 使用默認(rèn)值 DEFAULT_GROUP
  • 描述:可不填
  • 配置格式: 選擇 Properties
  • 配置內(nèi)容: 應(yīng)用要加載的配置內(nèi)容储耐,這里僅作為實(shí)例,做簡(jiǎn)單的配置滨溉,比如: username=wolf

創(chuàng)建應(yīng)用

第一步:創(chuàng)建一個(gè)Spring Boot應(yīng)用,命名為:alibaba-nacos-config-client

第二步:編輯pom.xml, 加入必要的依賴(lài)配置:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>0.2.2.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.2</version>
        <optional>true</optional>
    </dependency>
</dependencies>

上述內(nèi)容主要三部分:

  • parent:定義spring boot的版本
  • dependencyManagement:spring cloud的版本以及spring cloud alibaba的版本
  • dependencies:當(dāng)前應(yīng)用要使用的依賴(lài)內(nèi)容什湘。這里主要加入Nacos的配置客戶(hù)端依賴(lài)包:spring-cloud-stater-alibaba-nacos-config。由于 dependencyManagement已經(jīng)指定過(guò)版本號(hào)晦攒,這里不需要指定具體版本號(hào)禽炬。

注意:這個(gè)例子中并沒(méi)有引入nacos的服務(wù)注冊(cè)與發(fā)現(xiàn)依賴(lài),因?yàn)檫@兩個(gè)功能內(nèi)容是完全可以獨(dú)立使用的勤家。

第三步: 創(chuàng)建應(yīng)用主類(lèi)和測(cè)試Controller接口

@SpringBootApplication
public class NacosConfigClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigClientApplication.class, args);
    }
}
@Slf4j
@RestController
@RefreshScope
public class TestController {

    @Value("${username}")
    private String username;

    @GetMapping("/test")
    public String hello() {
        return username;
    }
}

內(nèi)容非常簡(jiǎn)單腹尖,唯一可能默認(rèn)的注解 :@RefreshScope這個(gè)注解是spring cloud提供的一種特殊的scope實(shí)現(xiàn),用來(lái)實(shí)現(xiàn)配置伐脖、實(shí)例熱加載热幔。

在類(lèi)上添加該注解,用來(lái)讓這個(gè)類(lèi)的配置內(nèi)容支持動(dòng)態(tài)刷新讼庇,也就是當(dāng)我們啟動(dòng)應(yīng)用之后绎巨,修改Nacos的配置文件內(nèi)容,這里就會(huì)馬上生效蠕啄。

第四步: 創(chuàng)建配置文件bootstrap.properties场勤,并配置服務(wù)名稱(chēng)和Nacos地址

server.port=9004
spring.application.name=alibaba-nacos-config-client
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

注意:

  • 這里的配置必須使用bootstrap.properties 或 bootstrap.yml,不能寫(xiě)在application.properties / application.yml不然啟動(dòng)會(huì)報(bào)錯(cuò)。
  • 同時(shí)歼跟,spring.application.name值必須和Nacos配置中 Data ID(除了.yml或者.properties)

為什么必須寫(xiě)在bootstrap.properties 或 bootstrap.yml中和媳?

SpringCloudConfigNacosConfig這種統(tǒng)一配置服務(wù)在springboot項(xiàng)目中初始化時(shí),都是加載bootstrap.properties 或 bootstrap.yml配置文件去初始化上下文哈街。
這是由spring boot的加載屬性文件的優(yōu)先級(jí)決定的留瞳,想要在加載屬性之前去config server上取配置文件,那NacosConfig或SpringCloudConfig相關(guān)配置就是需要最先加載的骚秦,而bootstrap.properties的加載是先于application.properties的她倘,所以config client要配置config的相關(guān)配置就只能寫(xiě)到bootstrap.properties里了

第五步: 啟動(dòng)應(yīng)用

2019-07-10 15:57:19.003  INFO 5240 --- [           main] o.s.c.a.n.c.NacosPropertySourceBuilder   : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEFAULT_GROUP'
2019-07-10 15:57:19.004  INFO 5240 --- [           main] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}

在啟動(dòng)的時(shí)候,可以看到類(lèi)似上面的日志信息作箍,這里輸出應(yīng)用程序要從Nacos中獲取配置的 dataidgroup硬梁。如果啟動(dòng)之后,發(fā)現(xiàn)配置信息沒(méi)有獲取到的時(shí)候胞得,可以檢測(cè)下這塊配置是否正確荧止。

第六步:驗(yàn)證配置獲取和動(dòng)態(tài)刷新
使用postman工具,訪(fǎng)問(wèn)接口:http://localhost:9004/test, 將返回Nacos配置中的 username 值。然后罩息,再通過(guò)Nacos頁(yè)面,修改 username=admin嗤详,單擊發(fā)布个扰,再訪(fǎng)問(wèn)這個(gè)接口看結(jié)果是否實(shí)時(shí)更新瓷炮。

修改前:



修改中:


發(fā)布完畢后,不要啟動(dòng)應(yīng)用递宅,重新訪(fǎng)問(wèn)接口娘香,會(huì)發(fā)現(xiàn)結(jié)果實(shí)時(shí)更新。


同時(shí)會(huì)發(fā)現(xiàn)我們?cè)谛薷腘acos配置信息办龄,發(fā)布后烘绽,客戶(hù)端控制臺(tái)會(huì)發(fā)現(xiàn)如下日志:

2019-07-10 16:11:09.369  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03: startup date [Wed Jul 10 16:11:09 CST 2019]; root of context hierarchy
2019-07-10 16:11:09.406  INFO 5240 --- [-127.0.0.1_8848] trationDelegate$BeanPostProcessorChecker : Bean 'configurationPropertiesRebinderAutoConfiguration' of type [org.springframework.cloud.autoconfigure.ConfigurationPropertiesRebinderAutoConfiguration$$EnhancerBySpringCGLIB$$1bdb25d3] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)
2019-07-10 16:11:09.506  INFO 5240 --- [-127.0.0.1_8848] o.s.c.a.n.c.NacosPropertySourceBuilder   : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEFAULT_GROUP'
2019-07-10 16:11:09.506  INFO 5240 --- [-127.0.0.1_8848] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}
2019-07-10 16:11:09.507  INFO 5240 --- [-127.0.0.1_8848] o.s.boot.SpringApplication               : No active profile set, falling back to default profiles: default
2019-07-10 16:11:09.508  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@5d68f73a: startup date [Wed Jul 10 16:11:09 CST 2019]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03
2019-07-10 16:11:09.525  INFO 5240 --- [-127.0.0.1_8848] o.s.boot.SpringApplication               : Started application in 0.234 seconds (JVM running for 831.73)
2019-07-10 16:11:09.525  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@5d68f73a: startup date [Wed Jul 10 16:11:09 CST 2019]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03
2019-07-10 16:11:09.525  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03: startup date [Wed Jul 10 16:11:09 CST 2019]; root of context hierarchy
2019-07-10 16:11:09.528  INFO 5240 --- [-127.0.0.1_8848] o.s.c.e.event.RefreshEventListener       : Refresh keys changed: [username]

上面,我們已經(jīng)學(xué)會(huì)了如何在Nacos中創(chuàng)建配置俐填,以及如何使用Spring Cloud Alibaba的Nacos客戶(hù)端模塊來(lái)加載配置安接。我們的例子完成采用了默認(rèn)配置完成。接下來(lái)我們?cè)敿?xì)了解下Nacos配置的加載規(guī)則英融。

加載規(guī)則

在Nacos Spring Cloud 中盏檐, dataID的完成格式如下:

${prefix}-${spring.profile.active}.${file-extension}
  • prefix:默認(rèn)為 spring.application.name的值,也可以通過(guò)配置項(xiàng) spring.cloud.nacos.config.prefix來(lái)配置驶悟。
  • spring.profile.active:即當(dāng)前環(huán)境對(duì)應(yīng)的profile胡野,詳情開(kāi)業(yè)參考 Spring Boot文檔

注意:當(dāng) spring.profile.active 為空時(shí)痕鳍,對(duì)應(yīng)的連接符 - 也將不存在硫豆,dataId的拼接格式變成:${prefix}.${file-extension}

  • file-extension: 為配置文件的數(shù)據(jù)格式,可以通過(guò)設(shè)置項(xiàng)spring.cloud.nacos.config.file-extension來(lái)配置笼呆,默認(rèn)值:properties熊响。目前只支持 properties 和 yaml 類(lèi)型。

  • Group的值默認(rèn) DEFAULT_GROUP: 可以通過(guò)設(shè)置項(xiàng) spring.cloud.nacos.config.group來(lái)配置诗赌,默認(rèn)值: DEFAULT_GROUP

思考

上面耘眨,我們具體介紹了在Nacos中添加各種配置與SpringCloud應(yīng)用中客戶(hù)端配置的對(duì)應(yīng)關(guān)系。對(duì)于spring.cloud.nacos.config.prefixspring.cloud.nacos.config.file-extension來(lái)說(shuō)境肾,基本沒(méi)有太多的花樣剔难,大部分都是采用默認(rèn)配置。

但是對(duì)于 spring.cloud.nacos.config.group 的配置來(lái)說(shuō)奥喻,還是可以派生出一些作用偶宫,比如:用來(lái)區(qū)分不同的產(chǎn)品組下的各個(gè)應(yīng)用的配置內(nèi)容(解決多個(gè)應(yīng)用名稱(chēng)沖突問(wèn)題)或者用來(lái)區(qū)分不同用途的配置內(nèi)容,再或者用來(lái)區(qū)分不同環(huán)境(dev环鲤、test纯趋、prod)的配置。
后面我們也會(huì)專(zhuān)門(mén)針對(duì)如何使用Group完成多環(huán)境配置進(jìn)行專(zhuān)門(mén)講解。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末吵冒,一起剝皮案震驚了整個(gè)濱河市纯命,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌痹栖,老刑警劉巖亿汞,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異揪阿,居然都是意外死亡疗我,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)南捂,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)吴裤,“玉大人,你說(shuō)我怎么就攤上這事溺健÷笪” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵鞭缭,是天一觀(guān)的道長(zhǎng)剖膳。 經(jīng)常有香客問(wèn)我,道長(zhǎng)缚去,這世上最難降的妖魔是什么潮秘? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮易结,結(jié)果婚禮上枕荞,老公的妹妹穿的比我還像新娘。我一直安慰自己搞动,他們只是感情好躏精,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著鹦肿,像睡著了一般矗烛。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上箩溃,一...
    開(kāi)封第一講書(shū)人閱讀 51,146評(píng)論 1 297
  • 那天瞭吃,我揣著相機(jī)與錄音,去河邊找鬼涣旨。 笑死歪架,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的霹陡。 我是一名探鬼主播和蚪,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼止状,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了攒霹?” 一聲冷哼從身側(cè)響起怯疤,我...
    開(kāi)封第一講書(shū)人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎催束,沒(méi)想到半個(gè)月后集峦,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡泣崩,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年少梁,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了洛口。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片矫付。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖第焰,靈堂內(nèi)的尸體忽然破棺而出买优,到底是詐尸還是另有隱情,我是刑警寧澤挺举,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布杀赢,位于F島的核電站,受9級(jí)特大地震影響湘纵,放射性物質(zhì)發(fā)生泄漏脂崔。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一梧喷、第九天 我趴在偏房一處隱蔽的房頂上張望砌左。 院中可真熱鬧,春花似錦铺敌、人聲如沸汇歹。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)产弹。三九已至,卻和暖如春弯囊,著一層夾襖步出監(jiān)牢的瞬間痰哨,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工匾嘱, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留斤斧,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓奄毡,卻偏偏與公主長(zhǎng)得像折欠,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353