SpringCloud使用Nacos儲存和讀取變數的設定方法

2022-07-09 14:01:25

前提條件

使用SpringCloud的專案
啟動Nacos

啟動設定管理

新增依賴：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>${latest.version}</version>
</dependency

注意：版本 2.1.x.RELEASE 對應的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 對應的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 對應的是 Spring Boot 1.5.x 版本。

參考：Nacos版本說明Wiki

在微服務的設定中設定Nacos server的地址和應用名

spring:
  application:
    name: service-xxx
  cloud:
    nacos:
      config:
        server-addr: ${spring.cloud.nacos.discovery.server-addr}
        file-extension: yaml

說明：

之所以需要設定spring.application.name，是因為它是構成 Nacos 設定管理dataId欄位的一部分。

在 Nacos Spring Cloud 中，dataId的完整格式如下：

${prefix}-${spring.profiles.active}.${file-extension}

prefix 預設為spring.application.name的值，也可以通過設定項spring.cloud.nacos.config.prefix來設定。
spring.profiles.active即為當前環境對應的profile，詳情可以參考Spring Boot檔案。
注意：當spring.profiles.active為空時，對應的連線符-也將不存在，dataId的拼接格式變成${prefix}.${file-extension}
file-exetension為設定內容的資料格式，可以通過設定項spring.cloud.nacos.config.file-extension來設定。目前只支援properties和yaml型別。

注入設定

按照上面設定好Nacos作為設定中心後，就可以通過在設定類上增加SpringCloud原生註解，開啟自動從Nacos取值，例如

@Value 直接注入變數值
@ConfigurationProperties 將若干變數整合到一個Properties類中

注意：

要啟用自動同步Nacos變數的變化，需要在注入變數的類上增加@RefreshScope註解

Nacos也提供了與之對應的自己特有的註解。

Spring Cloud註解	Nacos Spring 註解	備註
@Value	@NacosValue	auto-refreshed
@ConfigurationProperties	@NacosConfigurationProperties	auto-refreshed, @NacosProperty 對某一個屬性進行設定, @NacosIgnore Nacos忽略該值

一般來說，我們注入變數，都是把變數放在微服務的組態檔中，例如application.yaml，但是有時候，我們想單獨把某些設定儲存為一個nacos的設定，即：有獨立的dataId，這時，我們需要用到extension-configs例如，有如下設定：

@Component
@RefreshScope
@ConfigurationProperties(prefix = "test")
public class TestProperties {
    private List<String> whiteList;

    public List<String> getWhiteList() {
        return whiteList;
    }

    public void setWhiteList(List<String> whiteList) {
        this.whiteList = whiteList;
    }

}

我們想在nacos上建立一個test.properties的設定存放該Properties的值，那麼就需要修改微服務的組態檔：

spring:
  application:
    name: service-xxx
  cloud:
    nacos:
      config:
        server-addr: ${spring.cloud.nacos.discovery.server-addr}
        file-extension: yaml
        extension-configs[0]:
          data-id: test.properties
          refresh: true

extension-configs[n]可以增加多個，每一個包含三個設定：

data-id獨立的data-id，必須以properties或yaml結尾，不受spring.cloud.nacos.config.file-extension影響
group該設定獨立的group
refresh是否啟用自動重新整理，預設false

這樣，就實現了獨立的組態檔的nacos設定和其值自動更新。

同步設定

在上面的基礎上，我們再增加一個功能：微服務從本地修改變數值，並上傳到nacos，其他相同微服務範例，取值時都會拿到相同值，那就需要呼叫nacos的原生APINacosConfigManager了

//將本地設定推播到Nacos
configManager.getConfigService().publishConfig("test.properties", "DEFAULT_GROUP", contentToString(ConfigType.PROPERTIES));
//從Nacos拉取設定
configManager.getConfigService().getConfig("test.properties", "DEFAULT_GROUP", 100l)

注意：

1.假設當前微服務有兩個範例: A和B，我們在A上，通過publishConfig將TestProperties的值更新到了Nacos，那麼另一個範例B，會收到Nacos的通知，從nacos獲取到最新的值，但是，這中間會有一個毫秒級的延遲。

2.Nacos也提供了例如@NacosInject、ConfigService等API，但是這些API只能在SpringBoot中使用，在SpringCloud中是無法直接使用的。

到此這篇關於SpringCloud使用Nacos儲存和讀取變數的文章就介紹到這了,更多相關SpringCloud使用Nacos儲存和讀取變數內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

SpringCloud使用Nacos儲存和讀取變數的設定方法

目錄

前提條件

啟動設定管理

注入設定

同步設定

注意：

熱門文章