7、Nacos配置管理

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

一、统一配置管理

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

如上图，每个微服务可以向Nacos拉取配置信息，而Nacos在知道配置变更后，会通知微服务实例进行配置变更，实现配置的热更新。

（1）在Nacos中添加配置文件

1.首先进入配置列表，点击右上角 + 号，进行添加配置操作。

2.然后在弹出的表单信息中添加配置信息。

注意：

• Data ID（配置文件ID）：填写的格式为 服务名称.环境名称.文件后缀名；
• Group（分组）：填写格式一般默认；
• 描述：根据实际情况填写即可；
• 配置格式：建议选择yaml或properties；
• 配置内容：一般填写需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

（2）从微服务拉取配置

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

我们在配置好Nacos管理的配置文件后，服务在启动时会优先访问Nacos管理的配置信息，但此时我们的Nacos地址信息还配置在application.yaml中，此时无法知道Nacos的地址。如果尚未读取application.yml，又如何得知nacos地址呢？

Spring提供了一种解决方案，引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前（服务启动时）被读取，流程如下图所示：

这样，我们只需要将Nacos地址相关信息配置到bootstarp.yaml文件内部即可。

在启动服务后，优先访问bootstarp.yaml文件，然后获取到Nacos地址后加在Nacos管理的配置文件，最后再和服务内的application.yaml文件进行合并。

（3）具体实现方式

主要包含如下几步：

• 在服务内引入nacos-config客户端依赖；
• 添加bootstrap.yaml文件；
• 读取nacos配置；

在服务内引入Nacos依赖
首先，在userService服务中，引入nacos-config的客户端依赖：

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

添加bootstrap.yaml
然后，在userService中添加一个bootstrap.yaml文件，内容如下：

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境，这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名
1
2
3
4
5
6
7
8
9
10

这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据
${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}（服务名-环境名.文件后缀名）作为文件id，来读取配置。

本例中，就是去读取userservice-dev.yaml：

读取nacos配置
在userService中的UserController中添加业务逻辑，读取pattern.dateformat配置：

再页面访问，可以看到效果：

二、配置热更新

我们希望修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。要实现配置热更新，可以使用两种方式：

（1）方式一：

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

（2）方式二：

使用@ConfigurationProperties注解代替@Value注解。
在userService服务中，添加一个类，读取patterrn.dateformat属性：

package cn.itcast.user.config;

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

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}
1
2
3
4
5
6
7
8
9
10
11
12

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

三、配置共享

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

• [spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml
• [spring.application.name].yaml，例如：userservice.yaml
  而[spring.application.name].yaml不包含环境，因此可以被多个环境共享。

下面我们通过案例来测试配置共享

（1）添加一个环境共享配置

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

（2）在userService中读取共享配置

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

在userService服务中，修改UserController，添加一个方法：

（3）运行两个UserApplication，使用不同的profile

修改UserApplication2这个启动项，改变其profile值：


这样，UserApplication(8081)使用的profile是dev，UserApplication2(8082)使用的profile是test。
启动UserApplication和UserApplication2访问http://localhost:8081/user/prop，结果：

访问http://localhost:8082/user/prop，结果：

可以看出来，不管是dev，还是test环境，都读取到了envSharedValue这个属性的值。

（4）配置共享的优先级

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