spring cloud集成nacos的配置管理

本文记录了在spring cloud中集成nacos时已出现的某些问题的解答。

前期准备

需要提前安装nacos，可单机也可以集群部署，具体可参考官网：Nacos Server 下载 | Nacos 官网，可直接下载最新版本，并本地启动。
本文使用的spring boot的版本是较为新的3.3.1，spring cloud的版本为：2023.0.2，jdk为17

版本对关系

由于spring boot 的版本在3.0与2.7及2.4之下的差异比较大，因此在集成nacos的过程中，涉及到的版本也不一致，因此，这一点需要大家格外的关注，最新的版本对应关系参考以下文章：版本说明 · alibaba/spring-cloud-alibaba Wiki · GitHub；此片文章很重要，在集成前结合自己使用的版本，一定要仔细阅读，本人在此耗费了好长时间，才注意到该文章。

本文使用的nacos的版本是最新的，依赖如下所示：

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

报错及解决方案

spring:
  application:
    name: container_service
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848

刚开始我的配置如上所示，并且有一个端点的试下如下所示：

nacos中的配置如下所示：

里面的配置如下所示：

name: z

 以上是我接入时的基本的设置，但是启动spring boot程序时，启动过程会报错，错误如下所示：

Description:

No spring.config.import property has been defined

Action:

Add a spring.config.import=nacos: property to your configuration.
    If configuration is not required add spring.config.import=optional:nacos: instead.
    To disable this check, set spring.cloud.nacos.config.import-check.enabled=false.

如上所示，提示没有配置spring.config.import，并给出了解决的办法，该问题时由于Spring Boot 2.4 引入了一种通过 spring.config.import 属性导入配置数据的新方法。这是现在绑定到配置服务器的默认方式。

解决方案如下：

方案1（不推荐）

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

在pom中添加以下依赖，便可解决，但不推荐

方案2（推荐）

spring:
  application:
    name: container_service
  config:
    import:
      - nacos:${spring.application.name}.yaml
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848

如上所示，添加spring.config.import的配置，并将其值设置为在nacos中添加的DataId，即以下截图中圈起来的值：

根据之前修改后，便可正常启动，并且对端点进行请求，可以获取到nacos中设置的值。

此外，如果我们的服务需要集成多个nacos的配置文件，可以继续添加，如以上配置文件所示，config.import属性是一个数组，支持多个配置文件，这样可以很方便我们的扩展。

自动刷新

默认情况，集成nacos的配置中心后，是不会自动更新的，但可以在使用的类中，添加refreshScope注解，可以实现自动更新的功能，代码如下图所示：

设置完之后，再次测试，可以发现已经可以自动刷新配置的值了。