Nacos系列【24】集成Nacos 2.x配置中心及动态刷新配置

梦里梦外; 2024-04-08 08:49 70阅读 0赞

> **有道无术，术尚可求，有术无道，止于术。**

#### 文章目录 ####

*   *  前言
     *  集成Nacos 2.x配置中心
     *   *  1. 环境搭建
         *  2. 解决Param 'serviceName' is illegal, serviceName is blank
         *  3. 读取远程配置
     *  动态刷新配置
     *   *  方式1：@RefreshScope
         *  方式2： @NacosValue

### 前言 ###

在很早之前我们使用`Nacos 1.3.2`[搭建了配置中心][Link 1]，自从发布2.0版本以来，以及`Spring Boot 、Cloud`持续发布，升级到`Nacos2.x`发现了一些升级需要注意的问题，所以写这篇文档闭坑，顺便讲解下如何实现动态刷新配置。

### 集成Nacos 2.x配置中心 ###

首先按照之前的文档安装`Nacos 2.x` 以及升级到最新客户端。

[Nacos系列(15)-Nacos2.0.3安装][Nacos_15_-Nacos2.0.3]

#### 1. 环境搭建 ####

添加配置中心依赖：

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>

添加`bootstrap.yml`文件，该文件会在应用启动时最先加载，并在文件中添加配置中心：

server:
      port: 9005
    spring:
      application:
        name: app-service001
      cloud:
        nacos:
          discovery:
            server-addr: 127.0.0.1:8848
          config:
            server-addr: 127.0.0.1:8848
            file-extension: yaml
            enabled: true

在`Nacos`控制台，添加一个`app-service001.yaml`配置文件，内容如下：  
![在这里插入图片描述][d3ad60f4564d4ed3b7e4868beff7763f.png]

#### 2. 解决Param ‘serviceName’ is illegal, serviceName is blank ####

首先启动的时候，控制台打印了以下错误信息：

java.lang.IllegalArgumentException: Param 'serviceName' is illegal, serviceName is blank
    	at com.alibaba.nacos.api.naming.utils.NamingUtils.getGroupedName(NamingUtils.java:47) ~[nacos-client-2.1.0.jar:na]
    	at com.alibaba.nacos.client.naming.event.InstancesChangeNotifier.registerListener(InstancesChangeNotifier.java:55) ~[nacos-client-2.1.0.jar:na]
    	at com.alibaba.nacos.client.naming.NacosNamingService.subscribe(NacosNamingService.java:392) ~[nacos-client-2.1.0.jar:na]
    	at com.alibaba.cloud.nacos.discovery.NacosWatch.start(NacosWatch.java:134) ~[spring-cloud-starter-alibaba-nacos-discovery-2.2.8.RELEASE.jar:2.2.8.RELEASE]
    	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) [spring-context-5.3.8.jar:5.3.8]
    	at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) [spring-context-5.3.8.jar:5.3.8]
    	at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) [spring-context-5.3.8.jar:5.3.8]
    	at java.lang.Iterable.forEach(Iterable.java:75) ~[na:1.8.0_201]
    	at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) [spring-context-5.3.8.jar:5.3.8]
    	at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) [spring-context-5.3.8.jar:5.3.8]
    	at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.8.jar:5.3.8]
    	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.8.jar:5.3.8]

大概意思就是没有配置服务名，也就是没有配置`spring.application.name`，而我们明明是在`bootstrap.yml`中添加了的：  
![在这里插入图片描述][2c2dfe2c3d044345846536c82b393656.png]  
而且在启动开始，并没有打印连接到配置中心的日志：  
![在这里插入图片描述][781db12194d942c48022fe1e90c30698.png]  
由此猜想，难道是`bootstrap.yml`没有被加载？

首先要知道`bootstrap.yml`优先于`application.yml`加载，其目的是为了在应用启动时，加载一些系统级的资源配置项，比如远程配置中心地址，该文件是由`引导上下文`在启动最开始的阶段去加载的。

而该机制是`spring-cloud-starter-bootstrap` 提供的，Spring Boot 默认是不支持，在`Spring Boot 2.4`之后的版本，提供了`spring.config.import`通过属性导入配置数据的方法，所以`Spring Cloud`也就移除了`spring-cloud-starter-bootstrap` ，改用`spring.config.import`作为默认集成配置中心的方式。[官网说明][Link 2]

在[Spring Cloud Alibaba 2021.0.1.0 升级指南][Spring Cloud Alibaba 2021.0.1.0]中，也对此进行了详细说明。  
![在这里插入图片描述][b1edc5ffb3d44ceaa09ce473ff5a6ebe.png]

所以怎么解决这个问题呢？

*  方案1：自己引入`spring-cloud-starter-bootstrap`
 *  方案2：使用 `spring.config.import`方式引入配置

既然都Spring Cloud 都推荐使用 `spring.config.import`，那么我们就用这个吧~

首先删除`bootstrap.yml`，在`application.yml`使用import 的方式导入Nacos 的配置：

spring:
      application:
        name: app-service001
      cloud:
        nacos:
          config:
            group: DEFAULT_GROUP
            server-addr: 127.0.0.1:8848
      config:
        import:
          #- optional:nacos:test.yml  # 监听 DEFAULT_GROUP:test.yml
          #- optional:nacos:test01.yml?group=group_01 # 覆盖默认 group，监听 group_01:test01.yml
          #- optional:nacos:test02.yml?group=group_02&refreshEnabled=false # 不开启动态刷新
          - nacos:app-service001.yaml # 在拉取nacos配置异常时会快速失败，会导致 spring 容器启动失败

启动程序，可以看到连接到了Nacos 远程配置中心：  
![在这里插入图片描述][de4be1b918fa43a79c56bdaf9bb9712e.png]

#### 3. 读取远程配置 ####

首先写一个测试配置类，通过`@Value`读取配置：

@Configuration
    public class Person {
        
    
        @Value("${person.name}")
        String name;
    
        @Value("${person.age}")
        Integer age;
    
     // getter setter

在写一个测试访问接口，返回配置内容：

@Autowired
        Person person;
    
        @GetMapping("/test")
        public String test() {
        
            return person.toString();
        }

访问接口，可以看到读取到了Nacos 中的配置：  
![在这里插入图片描述][c56ce3f75d9c4106a18e6d3ab8eb46be.png]  
接着修改以下配置内容，再次访问，发现并没有返回更新后的数据，所以这就牵扯出配置动态刷新的问题。  
![在这里插入图片描述][097e0bc202f347148cf201dc9feff498.png]

### 动态刷新配置 ###

#### 方式1：@RefreshScope ####

`@RefreshScope`是Spring Cloud 提供的注解，可以看到它就是通过`Spring` 的作用域来实现的。  
![在这里插入图片描述][4f9bce8bb2054d7583f432545a1b0f11.png]  
在之前的配置类上添加注解：

@Configuration
    @RefreshScope
    public class Person {
         }

重新启动应用，修改Nacos 中的配置，再通过接口查看数据，可以看到是最新修改后的数据~~

#### 方式2： @NacosValue ####

`@NacosValue`在看到这个注解的时候，去看了源码，上面注释写的是`Annotation which extends value to support auto-refresh.`，说它是`@Value`注解的扩展，并支持动态刷新。

然后直接在上面的测试案例中使用`@NacosValue`，发现连配置中心的配置都获取不到，更不用说动态刷新了。

@NacosValue(value = "${person.name}", autoRefreshed = true)
        String name;

接着咨询了一下开发大佬：  
![在这里插入图片描述][e15b975307034cb0a6d31f9c1ab09b9d.png]  
又在[官网][Link 3]中发现了相关说明：  
![在这里插入图片描述][d7bdaf727e31494c8c513af0a0704b2b.png]  
**由上总结**：`@NacosValue`在`Spring Cloud`并不能直接使用，只是为了在纯`Spring`环境中方便集成配置中心，`Spring Cloud`环境下使用其本身推荐的方式。

要想使用`@NacosValue`需要添加以下依赖：

<dependency>
                <groupId>com.alibaba.nacos</groupId>
                <artifactId>nacos-spring-context</artifactId>
                <version>1.1.1</version>
            </dependency>

然后在启动类或者配置类上添加`@EnableNacosConfig`和`@NacosPropertySource`注解：

@EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
    @NacosPropertySource(dataId = "app-service001.yaml", autoRefreshed = true)

使用`@NacosConfigurationProperties`获取配置：

@NacosConfigurationProperties(prefix = "person",
            dataId = "app-service001.yaml",
            autoRefreshed = true,
            type = ConfigType.YAML
    )
    @Data
    @Component
    public class NacosValueConfig {
        
    
        private String name;
    
        private Integer age;
    }

或者`@NacosValue`获取配置：

@NacosValue(value = "${person.name}", autoRefreshed = true)
        String name;
    
        @GetMapping("/value")
        public String value() {
        
            System.out.println(nacosValueConfig.toString());
            System.out.println(person.toString());
            System.out.println(name);
            return "@NacosConfigurationProperties ";
        }

启动项目，访问获取配置接口：  
![在这里插入图片描述][8712a20895d0410ea6a62cda85472f98.png]  
修改配置，再次访问，可以看到打印了配置刷新的日志，并且获取到了最新配置：  
![在这里插入图片描述][f2f3db4c8bfa475bae45638459d60494.png]  
**当然方式2 并不推荐使用**

[Link 1]: https://yunyanchengyu.blog.csdn.net/article/details/108267895
[Nacos_15_-Nacos2.0.3]: https://yunyanchengyu.blog.csdn.net/article/details/120067094
[d3ad60f4564d4ed3b7e4868beff7763f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/178f3fdb2c614cf1bbaef01d539a3e27.png
[2c2dfe2c3d044345846536c82b393656.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/1476eb1289e94806b24f3da90cb6db24.png
[781db12194d942c48022fe1e90c30698.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/81ecb514515241a0a8d2252f8686f9ea.png
[Link 2]: https://docs.spring.io/spring-cloud-config/docs/current/reference/html/#_spring_cloud_config_client
[Spring Cloud Alibaba 2021.0.1.0]: https://github.com/alibaba/spring-cloud-alibaba/blob/2021.x/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sca-upgrade-guide.adoc#spring-cloud-alibaba-2021010-%E5%8D%87%E7%BA%A7%E6%8C%87%E5%8D%97
[b1edc5ffb3d44ceaa09ce473ff5a6ebe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a378ab7044464ead9e8f12bae0b644bf.png
[de4be1b918fa43a79c56bdaf9bb9712e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/087592894cd24023a752a14ec29943fd.png
[c56ce3f75d9c4106a18e6d3ab8eb46be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/aeb6255951724684be40d9f66b577307.png
[097e0bc202f347148cf201dc9feff498.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/b3a135b425914012a5bfbf5f535b4b03.png
[4f9bce8bb2054d7583f432545a1b0f11.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/f87415676a4245a8b0c450f520df31f3.png
[e15b975307034cb0a6d31f9c1ab09b9d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6545a7d342a6456abdaae3bffee08242.png
[Link 3]: https://nacos.io/zh-cn/docs/quick-start-spring.html
[d7bdaf727e31494c8c513af0a0704b2b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/84cfd127ea5c43a0aec35292435381a7.png
[8712a20895d0410ea6a62cda85472f98.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/f9acce3a738d4d9b9b29103ebc95011e.png
[f2f3db4c8bfa475bae45638459d60494.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/deb3c3c009c045cc86298667169b2c2e.png