Nacos 配置管理

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

统一配置管理

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

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

在 Nacos 中添加配置文件

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

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

从微服务拉取配置

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

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

因此 Spring 引入了一种新的配置文件：bootstrap.yaml 文件，会在 application.yml 之前被读取，流程如下：

① 引入 nacos-config 依赖

首先，在 user-service 服务中，引入 nacos-config 的客户端依赖：

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

② 添加 bootstrap.yaml

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

spring:
  application:
    name: user-service # 服务名称
  profiles:
    active: dev # 开发环境，这里是 dev 
  cloud:
    nacos:
      server-addr: halo: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，来读取配置。

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

③ 读取 Nacos 配置

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

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

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

配置热更新

我们最终的目的，是修改 Nacos 中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。

要实现配置热更新，可以使用两种方式：

方式一

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

@Slf4j
@RestController
@RequestMapping("/user")
@RefreshScope
public class UserController {
    @Value("${pattern.dateformat}")
    private String dateformat;

    // 略
}

方式二

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

在 user-service 服务中，添加一个类，读取 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;
}

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

@Autowired
private PatternProperties properties;

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

配置共享

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

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

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

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

添加一个环境共享配置

在 Nacos 中添加一个 user-service.yaml 文件：

在 user-service 中读取共享配置

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

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

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

@Autowired
private PatternProperties properties;

@GetMapping("prop")
public PatternProperties prop(){
    return properties;
}

不同的 profile 下测试

运行两个 UserApplication，使用不同的 profile。修改 UserApplication2 这个启动项，改变其 profile 值：

这样，UserApplication（8081） 使用的 profile 是 dev，UserApplication2（8082） 使用的 profile 是 test。

启动 UserApplication 和 UserApplication2

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

配置共享的优先级

当 Nacos、服务本地同时出现相同属性时，优先级有高低之分，优先级从高到低依次是：

• 服务名-[profile].yaml
• 服务名.yaml
• 本地配置