七SpringCloud实用篇_Nacos配置管理

Posted 2021-12-28 上善若水

一、Nacos配置管理

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

1.1、统一配置管理

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

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

1.1.1、在nacos中添加配置文件

如何在nacos中管理配置呢？

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

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

1.1.2、从微服务拉取配置

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。
但如果尚未读取application.yml，又如何得知nacos地址呢？
因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml
之前被读取，流程如下：

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

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

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

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev # 开发环境，这里是dev
  cloud:
    nacos:
      server-addr: 192.168.184.110: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：

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

package com.xbmu.user.web;

import com.xbmu.user.pojo.User;
import com.xbmu.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

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

    @Autowired
    private UserService userService;
    @Value("$pattern.dateformat")
    private String dateformat;
    @GetMapping("now")
    public String now()
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
    
    // 略...

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

1.2、配置热更新

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

1.2.1、方式一

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

1.2.2、方式二（推荐）

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

package com.xbmu.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：

1.3、总结：

Nacos配置更改后，微服务可以实现热更新，方式：

• 通过@Value注解注入，结合@RefreshScope来刷新
• 通过@ConfigurationProperties注入，自动刷新

注意事项：

• 不是所有的配置都适合放到配置中心，维护起来比较麻烦
• 建议将一些关键参数，需要运行时调整的参数放到nacos配置中心，一般都是自定义配置。