SpringCloud使用Nacos保存和读取变量

前言

在使用SpringCloud开发微服务时,经常会遇到一些比较小的后台参数配置,这些配置不足以单独开一张表去存储,而且其他服务会读取该参数。比如IP白名单。这时,使用Nacos去保存和读取就比较方便。

前提条件

  • 使用SpringCloud的项目
  • 启动Nacos

启动配置管理

  1. 添加依赖:
    1
    2
    3
    4
    5
    <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

  1. 在微服务的配置中配置Nacos server的地址和应用名
    1
    2
    3
    4
    5
    6
    7
    8
    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的完整格式如下:

1
${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来配置。目前只支持 propertiesyaml 类型。

注入配置

按照上面配置好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
例如,有如下配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@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的值,那么就需要修改微服务的配置文件:

1
2
3
4
5
6
7
8
9
10
11
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,必须以propertiesyaml结尾,不受spring.cloud.nacos.config.file-extension影响
  • group 该配置独立的group
  • refresh 是否启用自动刷新,默认false

这样,就实现了独立的配置文件的nacos配置和其值自动更新。

同步配置

在上面的基础上,我们再增加一个功能:微服务从本地修改变量值,并上传到nacos,其他相同微服务实例,取值时都会拿到相同值,那就需要调用nacos的原生API NacosConfigManager

1
2
3
4
//将本地配置推送到Nacos
configManager.getConfigService().publishConfig("test.properties", "DEFAULT_GROUP", contentToString(ConfigType.PROPERTIES));
//从Nacos拉取配置
configManager.getConfigService().getConfig("test.properties", "DEFAULT_GROUP", 100l)

注意

1.假设当前微服务有两个实例: A和B,我们在A上,通过publishConfigTestProperties 的值更新到了Nacos,那么另一个实例B,会收到Nacos的通知,从nacos获取到最新的值,但是,这中间会有一个毫秒级的延迟。
2.Nacos也提供了例如@NacosInjectConfigService 等API,但是这些API只能在SpringBoot中使用,在SpringCloud中是无法直接使用的。

本文由 EdisonXu - 徐焱飞 创作,采用 CC BY 4.0 CN协议 进行许可。 可自由转载、引用,但需署名作者且注明文章出处。
本文链接为http://edisonxu.com/2022/07/08/spring-cloud-nacos-variable.html
如果您觉得文章不错,可以请我喝一杯咖啡!
Spring