Spring Boot 3.2.1+Spring Cloud 2023.0.0下服务无法注册为Eureka Client

问题现象 #

使用Spring Boot 3.2.1和Spring Cloud 2023.0.0版本，服务启动后可正常运行，但无法连接Eureka Server，核心报错如下：

2024-01-03 07:52:39,081 ERROR com.netflix.discovery.DiscoveryClient : DiscoveryClient_ACCOUNT-SERVICE/dev-2.internal.cloudapp.net:account-service:8092 - was unable to send heartbeat!
com.netflix.discovery.shared.transport.TransportException: Cannot execute request on any known server
        at com.netflix.discovery.shared.transport.decorator.RetryableEurekaHttpClient.execute(RetryableEurekaHttpClient.java:112)
        at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator.sendHeartBeat(EurekaHttpClientDecorator.java:89)
        at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator$3.execute(EurekaHttpClientDecorator.java:92)
        at com.netflix.discovery.shared.transport.decorator.SessionedEurekaHttpClient.execute(SessionedEurekaHttpClient.java:77)
        at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator.sendHeartBeat(EurekaHttpClientDecorator.java:89)
        at com.netflix.discovery.DiscoveryClient.renew(DiscoveryClient.java:837)
        at com.netflix.discovery.DiscoveryClient$HeartbeatThread.run(DiscoveryClient.java:1401)
        at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:572)
        at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:317)
        at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1144)
        at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:642)
        at java.base/java.lang.Thread.run(Thread.java:1583)

尝试通过@ImportAutoConfiguration({FeignAutoConfiguration.class, EurekaClientAutoConfiguration.class})手动导入配置后，服务注册状态不稳定：有时全部服务可连接，有时全部失败，且该问题多发生在执行git pull操作后。

当前使用的服务启动脚本：

nohup mvn -f discovery-service spring-boot:run > /dev/null 2>&1&
mvn -f ncaish-core/account-service/account-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 &
nohup mvn -f ncaish-core/account-agg-service/account-agg-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/detax-service/detax-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
#nohup mvn -f ncaish-core/kyc-service/kyc-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/notification-service spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/fx-service/fx-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/retirement-service/nps-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/ffs-service/ffs-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/wealth-service/wealth-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-gateway spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-auth-server spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&
nohup mvn -f ncaish-core/report-service/report-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > /dev/null 2>&1&

排查与解决步骤 #

1. 修正Eureka客户端配置，移除手动导入的AutoConfiguration #

• Spring Cloud 2023.0.0（Leyton版本）与Spring Boot 3.2.x兼容，spring-cloud-starter-netflix-eureka-client依赖已包含完整的自动配置逻辑，无需手动通过@ImportAutoConfiguration导入EurekaClientAutoConfiguration。手动导入会导致配置冲突，是注册不稳定的核心原因之一。
• 确保客户端服务的pom.xml中引入正确依赖：

  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  </dependency>
  

• 检查application-dev-2.yml中的Eureka配置，确保地址、端口正确，同时开启IP优先注册避免hostname解析问题：

  eureka:
    client:
      service-url:
        defaultZone: http://{eureka-server-ip}:8761/eureka/ # 替换为实际Eureka Server地址
    instance:
      prefer-ip-address: true # 用IP注册，避免hostname无法解析的问题
  

2. 调整服务启动顺序，确保Eureka Server就绪后再启动客户端 #

当前启动脚本中，Eureka Server（discovery-service）后台启动后立即启动所有客户端服务，此时Eureka Server可能尚未完成初始化，导致客户端注册失败。

• 修改启动脚本，增加等待逻辑，确保Eureka Server完全就绪：

  # 启动Eureka Server
  nohup mvn -f discovery-service spring-boot:run > /dev/null 2>&1&
  # 等待Eureka Server启动完成，可根据实际情况调整等待时间
  sleep 40
  # 启动客户端服务，建议保留日志文件便于排查
  nohup mvn -f ncaish-core/account-service/account-service-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > account-service.log 2>&1&
  nohup mvn -f ncaish-core/account-agg-service/account-agg-core spring-boot:run -Dspring-boot.run.profiles=dev-2 > account-agg-service.log 2>&1&
  # 其他服务启动命令同理
  

• 更严谨的方式是通过curl检查Eureka Server的健康端点（需开启actuator）：

  until curl -s http://{eureka-server-ip}:8761/actuator/health | grep -q "UP"; do
      sleep 5
  done
  

3. 排查git pull后的配置文件冲突 #

问题多发生在git pull后，大概率是配置文件被远程分支覆盖：

• 检查.gitignore，确保本地环境配置文件（如application-dev-2-local.yml）被忽略，避免本地修改被覆盖。
• 使用Spring Boot的多配置文件优先级，通过spring.config.import引入本地配置，覆盖默认配置：

  # application-dev-2.yml
  spring:
    config:
      import: optional:file:./application-dev-2-local.yml
  

• 每次git pull后，执行git diff查看配置文件的变更，确认Eureka相关配置未被修改。

4. 增加日志排查细节 #

开启Eureka Client的DEBUG日志，查看注册过程中的详细错误：

logging:
  level:
    com.netflix.discovery: DEBUG
    org.springframework.cloud.netflix.eureka: DEBUG

通过日志可排查：

• 客户端是否正确读取到Eureka Server地址
• 注册请求是否发送成功，是否收到错误响应码
• 网络连接是否存在问题

5. 检查网络与Eureka Server配置 #

• 验证客户端服务器与Eureka Server之间的网络连通性：执行ping {eureka-server-ip}和telnet {eureka-server-ip} 8761，确保端口可访问。
• 检查Eureka Server的配置，确保允许客户端注册：

  eureka:
    client:
      register-with-eureka: false
      fetch-registry: false
  

内容的提问来源于stack exchange，提问作者Hari Babu Bandaru