轉載請注明作者及出處:
作者:銀河架構師
Nacos Config
官網介紹
Nacos 提供用於存儲配置和其他元數據的 key/value 存儲,為分布式系統中的外部化配置提供服務器端和客戶端支持。使用 Spring Cloud Alibaba Nacos Config,您可以在 Nacos Server 集中管理你 Spring Cloud 應用的外部屬性配置。
Spring Cloud Alibaba Nacos Config 是 Config Server 和 Client 的替代方案,客戶端和服務器上的概念與 Spring Environment 和 PropertySource 有着一致的抽象,在特殊的 bootstrap 階段,配置被加載到 Spring 環境中。當應用程序通過部署管道從開發到測試再到生產時,您可以管理這些環境之間的配置,並確保應用程序具有遷移時需要運行的所有內容。
更詳細的說明,請參看:
Nacos Config Wiki:https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config
啟動Nacos Server
由於本系列微服務框架服務注冊與發現使用的是Nacos,所以,在啟動微服務之前,均需啟動Nacos Server,后續不在贅述。具體啟動方式,可參考Spring Cloud進階之路 | 一:服務注冊與發現(nacos)。
創建配置客戶端
使用前一篇文章的商品工程xmall-product作為配置客戶端。
新建ApplicationProperties
package com.luas.xmall.configuration; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @Component @ConfigurationProperties(prefix = "system.application") public class ApplicationProperties { private String name; private String version; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getVersion() { return version; } public void setVersion(String version) { this.version = version; } }
新建ApplicationController,注入ApplicationProperties,並展示。
package com.luas.xmall.controller; import com.luas.xmall.configuration.ApplicationProperties; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/application") public class ApplicationController { @Autowired private ApplicationProperties applicationProperties; @RequestMapping public ApplicationProperties info() { return applicationProperties; } }
啟動xmall-product工程,端口為8080。
系統已正常啟動。
訪問http://localhost:8080/application,結果為空。
添加配置文件
打開nacos控制台,依次點擊:配置管理->配置列表,進入配置列表界面。
新增配置
點擊右側+,新建配置。
關於DataId,官網的解釋如下:
Nacos 中的某個配置集的 ID。配置集 ID 是組織划分配置的維度之一。Data ID 通常用於組織划分系統的配置集。一個系統或者應用可以包含多個配置集,每個配置集都可以被一個有意義的名稱標識。Data ID 通常采用類 Java 包(如 com.taobao.tc.refund.log.level)的命名規則保證全局唯一性。此命名規則非強制。
在 Nacos Spring Cloud 中,DataId的完整格式如下:
- prefix 默認為 spring.application.name 的值,也可以通過配置項 spring.cloud.nacos.config.prefix來配置。
- spring.profile.active 即為當前環境對應的 profile,詳情可以參考 Spring Boot文檔。注意:當 spring.profile.active 為空時,對應的連接符 - 也將不存在,dataId 的拼接格式變成 ${prefix}.${file-extension}
- file-exetension 為配置內容的數據格式,可以通過配置項 spring.cloud.nacos.config.file-extension 來配置。目前只支持 properties 和 yaml 類型。
關於配置格式,通俗的講,即為file-exetension。如配置格式選擇yaml格式,則DataId后綴必須為yaml(注意,也可寫為yml,與yaml同義,但與bootstrap配置中的file-extension必須一致),配置內容也必須按照yml格式編寫。
本文以yml為例,后續會花專門的篇幅,來詳細介紹Nacos Config用法。
編寫完成后,點擊發布,此時,已啟動服務的控制台已經接收到了Nacos Server的配置。
訪問http://localhost:8080/application,結果即為剛才配置的內容。
動態刷新
編輯xmall-product.yml配置,修改version為1.1,然后發布。
查看xmall-product控制台,已然接收到配置更改。
訪問http://localhost:8080/application,結果已為適才修改的內容。
RefreshScope
也可以通過 Spring Cloud 原生注解 @RefreshScope 實現配置自動更新。
新建ApplicationRefreshScopeController,通過原生注解實現配置自動刷新。
package com.luas.xmall.controller; import cn.hutool.core.map.MapUtil; import org.springframework.beans.factory.annotation.Value; import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/application/refreshScope") @RefreshScope public class ApplicationRefreshScopeController { @Value("${system.application.name}") private String name; @Value("${system.application.version}") private String version; @RequestMapping public Object info() { return MapUtil.builder().put("name", name).put("version", version).build(); } }
訪問http://localhost:8080/application,結果依然是適才修改的內容。
源碼
github
https://github.com/liuminglei/SpringCloudLearning/tree/master/05/
gitee
https://gitee.com/xbd521/SpringCloudLearning/tree/master/05/
正文完!
微信搜索【銀河架構師】,發現更多精彩。
技術資料領取方法:關注公眾號,回復微服務,領取微服務相關電子書;回復MK精講,領取MK精講系列電子書;回復JAVA 進階,領取JAVA進階知識相關電子書;回復JAVA面試,領取JAVA面試相關電子書,回復JAVA WEB領取JAVA WEB相關電子書。











