微服务系列（6）- Nacos配置管理

1.Nacos配置管理

1.1 统一配置管理

当微服务部署的实例逐渐增多的时候(几十上百台), 假如我们要修改配置时, 逐一修改就非常的麻烦!

所以Nacos提供了统一的统一配置管理方案，可以集中管理所有实例的配置。

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

1.2 Nacos配置管理

1.2.1 添加配置

在配置列表中添加配置 :

点击加号以后添加如下配置 : Data ID: [服务名]-[profile].[后缀]

注意 :

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

点击发布即可,如下图所示 :

说明配置文件添加成功!

1.2.2 微服务拉取配置

我们在nacos添加过配置以后, 需要让微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。spring引入了一种新的配置文件：bootstrap.yaml文件，会在 application.yml之前被读取，流程如下：

接下来是引入依赖, 首先: 在user-service服务中，引入nacos-config的客户端依赖

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

引入以后, 我们需要在user-service项目下的resource目录下创建一个 bootstrap.yaml 文件

bootstrap.yaml 文件主要是存放项目的核心配置 :

spring:
  application:
    name: user-service # 服务名称
  profiles:
    active: 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，来读取配置, 上面的配置读取的是nacos user-service-dev.yaml 文件配置

再次注意的是项目读取配置文件的顺序是 :

1. bootstrap.yaml
2. nacos 上的配置文件
3. 本地的 applicationyaml 文件

1.2.3 读取Nacos配置

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

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

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

编写完成以后, 我们可以访问 http://localhost:8082/user/now

如上图可以看到, 正确响应了对应的配置数据

1.3 配置热更新

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

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

1.3.1 热更新方式一

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

@Slf4j
@RestController
@RequestMapping("/user")
@RefreshScope
public class UserController {

    @Autowired
    private UserService userService;


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

修改完成以后重启微服务, 然后在 Web界面使用Nacos修改配置

修改以后不需要重启微服务, 即可直接访问 http://localhost:8082/user/now

可以看到, 微服务配置进行了热更新

1.3.2 热更新方式二

使用@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 中将 private String dateformat; 替换掉即可

    @Resource
    private PatternProperties patternProperties;

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

1.4 配置共享

1.4.1 环境共享配置

点击发布后, 新的配置就添加完成了, 然后我们需要在 之前创建的 PatternProperties 类添加属性

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

添加完成以后, 我们只需要在 UserController 中添加一个请求来获取这个属性即可

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

然后我们需要去模拟不同的实例读取不同的环境, 比如 user-service8081 读取的是 dev 环境 ,

user-service8082 和 user-service8083 读取的是 test 环境, 这样可以测试是否是共享变量

修改完成以后启动微服务, 然后访问 localhost:8081/user/share

如上图, 可以那看到访问 localhost:8081/user/share 返回的信息, 8081 端口实例使用的是dev的环境变量, 可以读到 dateformat 的变量值

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KdHxMBMH-1650596341147)(C:/Users/wangtianci/AppData/Roaming/Typora/typora-user-images/image-20220422104520201.png)]

而 localhost:8082/user/share 使用的是test的环境变量, 自然是读取不到dev的环境变量, 所以只能读取到共享变量

1.4.2 配置共享的优先级

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

优先级 : user-service-dev.yaml > user-service.yaml > user-service.yaml (本地配置)