Published on

Nacos Client 获取不到 Nacos 服务端配置的常见原因与解决方案

Authors
  • avatar
    Name
    Jason Yang
    Twitter

在微服务架构中，Nacos 作为一款强大的服务发现与配置管理工具，被广泛应用。然而，在实际开发和部署过程中，可能会遇到 Nacos Client 获取不到 Nacos 服务端配置的问题。当出现这一情况时，首先要检查 Nacos 客户端配置的 Nacos Server 用户名、密码、namespace、group 是否正确。错误的认证信息会导致客户端无法通过服务端的身份验证，进而无法获取配置；而错误的 namespace 或 group 则会使客户端请求的配置路径错误，找不到对应的配置文件。完成这些基础检查后，可进一步围绕以下常见原因展开分析，并通过相应的解决方案，快速定位和解决问题。

注：本文问题基于Nacos client 2.3.0， Nacos Server 2.3.2

一、spring.profiles.active 环境变量配置错误

问题现象

服务启动日志里会发现几条warning log

Ignore the empty nacos configuration and get it based on dataId[serviceName.yaml] & group[0.1.0-SNAPSHOT]

这说明没有从nacos server获取到配置，客户端本地缓存的nacos目录下也没有对应的配置。

当通过环境变量传入spring.profiles.active且存在多个值时，如果将其配置成包含空格的字符串，而未正确拆分成数组形式，Nacos Client 就无法读取到正确的 profiles，进而导致无法获取对应的配置。例如，通过export spring.profiles.active=" dev, test"这样的方式设置环境变量，表面上看似传入了两个 profiles，但实际上因为格式问题，无法识别成多个profile。

原因分析

Nacos Client 在读取spring.profiles.active时，期望获取的是一个明确的、可解析的 profiles 列表。在 Nacos 的配置管理逻辑中，不同的 profiles 对应着不同的配置集合，如果以错误的字符串格式传入，客户端无法将其正确解析为多个独立的 profiles，也就无法匹配到服务端相应的配置文件，导致客户端请求的配置路径错误，自然无法获取到有效的配置。

Nacos客户端配置过程：

  1. 获取 profiles 信息

在应用启动时，nacos-client 首先获取 spring.profiles.active 的值，该值可通过多种方式设置，如配置文件、环境变量或命令行参数。例如，在 bootstrap.properties 中配置 spring.profiles.active=dev，或通过环境变量 export spring.profiles.active=dev 传入。

  1. 构建配置文件名称

在springboot应用中，我们使用spring.application.name 配置进行自定义应用名。根据获取到的 profiles 信息和应用名称，nacos-client 构建出对应的配置文件名称。具体规则为：应用名-profiles.yaml。例如，当应用名为 my-service，profiles 为 dev 时，最终构建的配置文件名称为 my-service-dev.yaml。

解决方案

将环境变量中的spring.profiles.active以正确的数组形式传入。使用逗号分隔多个值，例如spring.profiles.active=dev,test 。确保配置的 profiles 在 Nacos 服务端存在对应的配置文件，并且配置文件的命名符合规范，如dataId中包含对应的 profiles 标识。

二、Nacos Server 9848 端口网络策略问题

问题现象

Nacos Server 默认采用双端口设计，8848 端口用于 HTTP 协议通信，9848 端口用于 gRPC 协议通信。当 Nacos Server 的 9848 端口没有开通相应的网络策略时，Nacos Client 在建立连接过程中，尝试创建 gRPC 连接就会失败，从而影响配置的获取。

原因分析

从 Nacos 2.x 版本开始引入的 gRPC 协议，用于实现配置变更推送、服务注册发现的增量更新等功能，提升了通信的效率和实时性。Nacos Client 在与服务端交互时，会根据协议需求尝试与 9848 端口建立 gRPC 连接。如果该端口被防火墙拦截，或者网络策略限制了访问，客户端就无法完成连接的建立，导致配置获取流程受阻。因为部分配置的获取和更新依赖于 gRPC 连接的正常通信，所以连接失败会直接导致配置获取不到。

解决方案

检查服务器的防火墙设置，确保 9848 端口已开放。在 Linux 系统中，使用iptables命令添加规则开放端口，例如iptables -A INPUT -p tcp --dport 9848 -j ACCEPT ；如果使用的是云服务器，如阿里云、腾讯云等，需要在控制台的安全组规则中添加允许 9848 端口访问的规则。同时，确认 Nacos Server 的配置文件中关于端口的配置是否正确，可检查application.properties中是否有关于端口的自定义配置，确保与实际网络环境一致。

三、Nacos Client 依赖包缺失

问题现象

查看 Nacos Client 的异常日志时，若发现存在依赖包缺失的提示，如缺少 jackson 依赖，就会导致 Nacos Client 无法正常解析服务端返回的配置数据，从而获取不到配置。在日志中可能会出现类似于ClassNotFoundException: com.fasterxml.jackson.databind.ObjectMapper这样的错误信息。

原因分析

在 Nacos 进行配置的传输和解析过程中，依赖于众多的第三方库。Jackson 作为常用的 JSON 处理库，在 Nacos 中用于对配置数据进行序列化和反序列化操作。如果缺少 Jackson 依赖，Nacos Client 在接收到服务端返回的 JSON 格式配置数据时，无法将其正确解析为 Java 对象，也就无法获取配置内容。此外，依赖包缺失还可能导致其他功能模块无法正常工作，进一步影响配置的获取流程。

解决方案

根据项目所使用的构建工具（如 Maven 或 Gradle），在项目的依赖管理文件中添加缺失的依赖包。对于 Maven 项目，在pom.xml文件中添加如下依赖：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.15.2</version>
</dependency>

添加依赖后，重新构建项目，确保依赖包被正确下载和引入。同时，检查是否还有其他相关依赖缺失，可通过 IDE 的依赖分析工具或构建工具的依赖树查看功能进行排查。

View on GitHub