在使用SpringCloud開(kāi)發(fā)微服務(wù)時(shí)，經(jīng)常會(huì)遇到一些比較小的后臺(tái)參數(shù)配置，這些配置不足以單獨(dú)開(kāi)一張表去存儲(chǔ)，而且其他服務(wù)會(huì)讀取該參數(shù)。比如IP白名單。這時(shí)，使用Nacos去保存和讀取就比較方便。

前提條件

• 使用SpringCloud的項(xiàng)目
• 啟動(dòng)Nacos

啟動(dòng)配置管理

添加依賴：

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

注意：版本 2.1.x.RELEASE 對(duì)應(yīng)的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 對(duì)應(yīng)的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 對(duì)應(yīng)的是 Spring Boot 1.5.x 版本。

參考：Nacos版本說(shuō)明Wiki

在微服務(wù)的配置中配置Nacos server的地址和應(yīng)用名

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

說(shuō)明：

之所以需要配置spring.application.name，是因?yàn)樗菢?gòu)成 Nacos 配置管理dataId字段的一部分。

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

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

• prefix 默認(rèn)為spring.application.name的值，也可以通過(guò)配置項(xiàng)spring.cloud.nacos.config.prefix來(lái)配置。
• spring.profiles.active即為當(dāng)前環(huán)境對(duì)應(yīng)的profile，詳情可以參考Spring Boot文檔。

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

• file-exetension為配置內(nèi)容的數(shù)據(jù)格式，可以通過(guò)配置項(xiàng)spring.cloud.nacos.config.file-extension來(lái)配置。目前只支持properties和yaml類型。

注入配置

按照上面配置好Nacos作為配置中心后，就可以通過(guò)在配置類上增加SpringCloud原生注解，開(kāi)啟自動(dòng)從Nacos取值，例如

• @Value 直接注入變量值
• @ConfigurationProperties 將若干變量整合到一個(gè)Properties類中

注意：

要啟用自動(dòng)同步Nacos變量的變化，需要在注入變量的類上增加@RefreshScope注解

Nacos也提供了與之對(duì)應(yīng)的自己特有的注解。

一般來(lái)說(shuō)，我們注入變量，都是把變量放在微服務(wù)的配置文件中，例如application.yaml，但是有時(shí)候，我們想單獨(dú)把某些配置保存為一個(gè)nacos的配置，即：有獨(dú)立的dataId，這時(shí)，我們需要用到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上創(chuàng)建一個(gè)test.properties的配置存放該P(yáng)roperties的值，那么就需要修改微服務(wù)的配置文件：

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]可以增加多個(gè)，每一個(gè)包含三個(gè)配置：

• data-id獨(dú)立的data-id，必須以properties或yaml結(jié)尾，不受spring.cloud.nacos.config.file-extension影響
• group該配置獨(dú)立的group
• refresh是否啟用自動(dòng)刷新，默認(rèn)false

這樣，就實(shí)現(xiàn)了獨(dú)立的配置文件的nacos配置和其值自動(dòng)更新。

同步配置

在上面的基礎(chǔ)上，我們?cè)僭黾右粋€(gè)功能：微服務(wù)從本地修改變量值，并上傳到nacos，其他相同微服務(wù)實(shí)例，取值時(shí)都會(huì)拿到相同值，那就需要調(diào)用nacos的原生APINacosConfigManager了

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

注意：

1.假設(shè)當(dāng)前微服務(wù)有兩個(gè)實(shí)例: A和B，我們?cè)贏上，通過(guò)publishConfig將TestProperties的值更新到了Nacos，那么另一個(gè)實(shí)例B，會(huì)收到Nacos的通知，從nacos獲取到最新的值，但是，這中間會(huì)有一個(gè)毫秒級(jí)的延遲。

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

到此這篇關(guān)于SpringCloud使用Nacos保存和讀取變量的文章就介紹到這了,更多相關(guān)SpringCloud使用Nacos保存和讀取變量?jī)?nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論