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

通過之前文章的學習我們已經學會了使用Nacos完成服務的注冊與發(fā)現(xiàn)。同時也介紹了Spring Cloud中不同風格的服務消費方式。接下來,我們再來學習下Nacos的另一個重要功能:配置管理

簡介

Nacos除了可以實現(xiàn)服務的注冊與發(fā)現(xiàn)之外,還將配置中心的功能整合在一起。通過Nacos的配置管理功能,我們可以將整個架構體系能的所有配置都集中到Nacos中存儲。這樣做的好處主要有以下幾點:

  • 分離的多環(huán)境配置,可以靈活的管理權限,安全性更高
  • 應用程序的打包更為純粹,已實現(xiàn)一次打包,多處運行的特點

Nacos的配置管理模型與淘寶開源的配置中心Diamond類似,基礎層面通過DataIdGroup來定位配置內容,除此之外還增加了很多其他的管理功能。

快速入門

下面我們通過一個簡單的例子來介紹如何使用Nacos來創(chuàng)建配置內容以及如何在Spring Cloud應用中加載Nacos的配置信息。

創(chuàng)建配置

第一步: 進入Nacos的控制頁面,在配置列表功能頁面中,單擊右上角的+按鈕,進入新建配置頁面,如圖填寫配置信息:

其中:

  • Data ID: 填入 alibaba-nacos-config-client.properties
  • Group: 使用默認值 DEFAULT_GROUP
  • 描述:可不填
  • 配置格式: 選擇 Properties
  • 配置內容: 應用要加載的配置內容,這里僅作為實例,做簡單的配置,比如: username=wolf

創(chuàng)建應用

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

第二步:編輯pom.xml, 加入必要的依賴配置:

<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>

上述內容主要三部分:

  • parent:定義spring boot的版本
  • dependencyManagement:spring cloud的版本以及spring cloud alibaba的版本
  • dependencies:當前應用要使用的依賴內容。這里主要加入Nacos的配置客戶端依賴包:spring-cloud-stater-alibaba-nacos-config。由于 dependencyManagement已經指定過版本號,這里不需要指定具體版本號。

注意:這個例子中并沒有引入nacos的服務注冊與發(fā)現(xiàn)依賴,因為這兩個功能內容是完全可以獨立使用的。

第三步: 創(chuàng)建應用主類和測試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;
    }
}

內容非常簡單,唯一可能默認的注解 :@RefreshScope這個注解是spring cloud提供的一種特殊的scope實現(xiàn),用來實現(xiàn)配置、實例熱加載。

在類上添加該注解,用來讓這個類的配置內容支持動態(tài)刷新,也就是當我們啟動應用之后,修改Nacos的配置文件內容,這里就會馬上生效。

第四步: 創(chuàng)建配置文件bootstrap.properties,并配置服務名稱和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,不能寫在application.properties / application.yml不然啟動會報錯。
  • 同時,spring.application.name值必須和Nacos配置中 Data ID(除了.yml或者.properties)

為什么必須寫在bootstrap.properties 或 bootstrap.yml中?

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

第五步: 啟動應用

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'}]}

在啟動的時候,可以看到類似上面的日志信息,這里輸出應用程序要從Nacos中獲取配置的 dataidgroup。如果啟動之后,發(fā)現(xiàn)配置信息沒有獲取到的時候,可以檢測下這塊配置是否正確。

第六步:驗證配置獲取和動態(tài)刷新
使用postman工具,訪問接口:http://localhost:9004/test, 將返回Nacos配置中的 username 值。然后,再通過Nacos頁面,修改 username=admin,單擊發(fā)布,再訪問這個接口看結果是否實時更新。

修改前:



修改中:


發(fā)布完畢后,不要啟動應用,重新訪問接口,會發(fā)現(xiàn)結果實時更新。


同時會發(fā)現(xiàn)我們在修改Nacos配置信息,發(fā)布后,客戶端控制臺會發(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]

上面,我們已經學會了如何在Nacos中創(chuàng)建配置,以及如何使用Spring Cloud Alibaba的Nacos客戶端模塊來加載配置。我們的例子完成采用了默認配置完成。接下來我們詳細了解下Nacos配置的加載規(guī)則。

加載規(guī)則

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

${prefix}-${spring.profile.active}.${file-extension}
  • prefix:默認為 spring.application.name的值,也可以通過配置項 spring.cloud.nacos.config.prefix來配置。
  • spring.profile.active:即當前環(huán)境對應的profile,詳情開業(yè)參考 Spring Boot文檔

注意:當 spring.profile.active 為空時,對應的連接符 - 也將不存在,dataId的拼接格式變成:${prefix}.${file-extension}

  • file-extension: 為配置文件的數(shù)據格式,可以通過設置項spring.cloud.nacos.config.file-extension來配置,默認值:properties。目前只支持 properties 和 yaml 類型。

  • Group的值默認 DEFAULT_GROUP: 可以通過設置項 spring.cloud.nacos.config.group來配置,默認值: DEFAULT_GROUP

思考

上面,我們具體介紹了在Nacos中添加各種配置與SpringCloud應用中客戶端配置的對應關系。對于spring.cloud.nacos.config.prefixspring.cloud.nacos.config.file-extension來說,基本沒有太多的花樣,大部分都是采用默認配置。

但是對于 spring.cloud.nacos.config.group 的配置來說,還是可以派生出一些作用,比如:用來區(qū)分不同的產品組下的各個應用的配置內容(解決多個應用名稱沖突問題)或者用來區(qū)分不同用途的配置內容,再或者用來區(qū)分不同環(huán)境(dev、test、prod)的配置。
后面我們也會專門針對如何使用Group完成多環(huán)境配置進行專門講解。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,238評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,430評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,134評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,893評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,653評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,136評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,212評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,372評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 48,888評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,738評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,939評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,482評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,179評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,588評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,829評論 1 283
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,610評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,916評論 2 372