排查一次nacos动态配置不生效

一、问题描述

新需求需要使用到nacos动态配置,但是开发完成之后联调过程中发现动态配置没有生效。

二、问题排查

  1. 首先在本地测试,发现启动服务后修改nacos配置确实不生效,在查看启动日志时发现服务启动时打印了下面这样的日志。这里是在配置nacos的监听,在A服务的启动日志中只看到了对dubbo的监听配置,没有看到对配置文件的监听, 因此怀疑是对配置文件的监听没有注册成功。
  2. 因为B也有动态配置,为了验证判断,在本地启动了B服务然后查看日志,发现启动时打印了下面的日志

这段日志是注册对nacos配置文件的监听,因此可以确定是A服务启动时没有注册成功或没有注册对naocs配置文件的监听。

3. 通过查看nacos的代码,发现在NacosContextRefresher类中注册的监听,监听的dataId和group是从NacosPropertySourceRepository类中的NACOS_PROPERTY_SOURCE_REPOSITORY取的。此时怀疑可能是nacos配置错误导致监听注册失败。

4.开始第一次调试,发现NACOS_PROPERTY_SOURCE_REPOSITORY中包含了配置文件的dataId和group,不是之前怀疑的原因。此时怀疑是springboot的配置有问题或者代码的问题。

5.首先重新启动A服务,开始多次debug,发现在注册监听时会从AbstractApplicationEventMulticaster类中的成员变量defaultRetriever(ListenerRetriever类的对象)的applicationListeners属性中没有NacosContextRefresher,导致对nacos配置文件的监听没有注册成功。

6.此时对A重新debug,发现容器在注册监听之后才注册的NacosContextRefresher,此时判断对nacos配置文件的监听可能是在这之后。为了验证这种想法,debug了一次B的启动流程,发现spring确实是在服务启动之后注册的对nacos配置文件的监听,因此可以确定a在启动之后由于某些原因没有注册nacos配置文件的监听。

在下面一段代码的红框部分发布ApplicationReadyEvent事件,执行了这里,对nacos配置文件的监听才真正开启

7.重新debug A服务,发现springboot的run()中有一行callRunners(context, applicationArguments); 这个方法内部代码如下,这里使用主线程执行实现ApplicationRunner和CommandLineRunner的类中的代码,如果这些类中有阻塞,spring就不会执行listeners.running(context);。

8.经过上面的分析和debug,可以确定问题出现在A代码的SQSListener类中,这个类实现了ApplicationRunner,同时这里有while(true)的代码,从而导致主线程阻塞在这里,而且在这个时候A已经启动成功,所以A仍然可以提供服务。