SpringCloud使用Nacos保存和讀取變量的配置方法

Posted on by

在使用SpringCloud開發微服務時，經常會遇到一些比較小的後臺參數配置，這些配置不足以單獨開一張表去存儲，而且其他服務會讀取該參數。比如IP白名單。這時，使用Nacos去保存和讀取就比較方便。

前提條件

  • 使用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保存和讀取變量內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：