Nacos配置管理

Nacos除了可以做注册中心，同样可以做配置管理来使用。

统一配置管理

当微服务部署的实例越来越多，达到数十、数百时，逐个修改微服务配置就会让人抓狂，而且很容易出错。我们需要一种统一配置管理方案，可以集中管理所有实例的配置。

Nacos一方面可以将配置集中管理，另一方可以在配置变更时，及时通知微服务，实现配置的热更新。

在nacos中添加配置文件

然后在弹出的表单中，填写配置信息：

注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

从微服务拉取配置

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

但如果尚未读取application.yml，又如何得知nacos地址呢？

因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取。

引入nacos-config依赖

<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

如果使用的版本是spring-cloud-dependencies 2020.0.0 及以上需要添加以下依赖

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>

spring-cloud-dependencies 2020.0.0 开始默认不再加载bootstrap 配置文件，如果项目中要用bootstrap 配置文件 需要手动添加spring-cloud-starter-bootstrap 依赖，不然启动项目会报错的。

添加bootstrap.yaml

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境，这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id，来读取配置。

可以看到项目启动时读取了userservice-dev.yaml

读取nacos配置

在user-service中的UserController中添加业务逻辑，读取pattern.dateformat配置：

    @Value("${pattern.dateformat}")
    private String dateformat;

    @GetMapping("now")
    public String newTime(){
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
    }

发送请求： 可以看到能够读取到配置文件

配置热更新

方式一

在@Value注入的变量所在类上添加注解@RefreshScope：

方式二

使用@ConfigurationProperties注解代替@Value注解。

在user-service服务中，添加一个类，读取patterrn.dateformat属性：

package com.hzy.user.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @title: PatternProperties
 * @Author zxwyhzy
 * @Date: 2023/4/27 22:21
 * @Version 1.0
 */
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}

在UserController中使用这个类代替@Value：

配置共享

其实微服务启动时，会去nacos读取多个配置文件，例如：

• [spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml

• [spring.application.name].yaml，例如：userservice.yaml

而[spring.application.name].yaml不包含环境，因此可以被多个环境共享。

添加一个环境共享配置

在nacos中添加一个userservice.yaml文件：

在user-service服务中，修改PatternProperties类，读取新添加的属性：

@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
    private String msg;
}

在user-service服务中，修改UserController，添加一个测试方法：

    @GetMapping("test")
    public PatternProperties test(){
        return patternProperties;
    }

修改一个服务配置： 环境改为测试环境

共享配置环境都能读到，环境为test的服务读不到dev的配置文件

配置共享的优先级

在本地配置文件和共享配置文件中加入一个testMsg属性:

  # 本地
  pattern:
    testMsg: 本地配置
  # 共享
  pattern:
    testMsg: 共享环境配置

读取到的是共享配置文件的testMsg

在当前环境配置userservice-dev.yaml中添加testMsg属性:

  pattern:
    testMsg: 当前环境配置

当nacos、服务本地同时出现相同属性时，优先级有高低之分：