Spring Cloud Gateway集成Kubernetes报错：需配置discovery-server-url

在minikube环境中探索Spring Cloud Gateway时，添加spring-cloud-starter-kubernetes依赖后出现报错：

org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'apiGatewayV2Application': Unsatisfied dependency expressed through field 'client': Error creating bean with name 'compositeDiscoveryClient' defined in class path resource [org/springframework/cloud/client/discovery/composite/CompositeDiscoveryClientAutoConfiguration.class]: Unsatisfied dependency expressed through method 'compositeDiscoveryClient' parameter 0: Error creating bean with name 'kubernetesDiscoveryClient' defined in class path resource [org/springframework/cloud/kubernetes/discovery/KubernetesDiscoveryClientBlockingAutoConfiguration.class]: Failed to instantiate [org/springframework/cloud/kubernetes/discovery/KubernetesDiscoveryClient]: Factory method 'kubernetesDiscoveryClient' threw exception with message: 'spring.cloud.kubernetes.discovery.discovery-server-url' must be specified and be a valid URL.

查阅相关文档未找到spring.cloud.kubernetes.discovery.discovery-server-url配置项的说明。

当前环境配置如下：

pom.xml #

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>api-gateway-v2</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <packaging>jar</packaging>

    <name>api-gateway-v2</name>
    <description>Demo project for Spring Boot</description>

    <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>3.2.2</version>
       <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
       <spring-cloud.version>2023.0.0</spring-cloud.version>
    </properties>

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

    <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-kubernetes</artifactId>
          <version>1.1.10.RELEASE</version>
       </dependency>

       <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
       </dependency>
       <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
       </dependency>
    </dependencies>
    <dependencyManagement>
       <dependencies>
          <dependency>
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-dependencies</artifactId>
             <version>${spring-cloud.version}</version>
             <type>pom</type>
             <scope>import</scope>
          </dependency>
       </dependencies>
    </dependencyManagement>

    <build>
       <plugins>
          <plugin>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-maven-plugin</artifactId>
          </plugin>
       </plugins>
    </build>

</project>

ApiGatewayV2Application.java #

@Slf4j
@EnableDiscoveryClient
@SpringBootApplication
public class ApiGatewayV2Application {

    public static void main(String[] args) {
       SpringApplication.run(ApiGatewayV2Application.class, args);
    }

    @Autowired
    DiscoveryClient client;

    @PostConstruct
    public void init() {
       log.info("Services: {}", client.getServices());
       Stream<ServiceInstance> s = client.getServices().stream().flatMap(service -> client.getInstances(service).stream());
       s.forEach(it -> log.info("Instance: url={}:{}, id={}, service={}", it.getHost(), it.getPort(), it.getInstanceId(), it.getServiceId()));
    }
}

application.yml #

server:
  port: 9762

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://foo-service:8080
          predicates:
            - Path=/football/**
        - id: after_route1
          uri: http://bar-service:8080
          predicates:
            - Path=/cricket/**

移除spring-cloud-starter-kubernetes依赖后，网关可正常启动并成功路由请求至后端Pod，疑问点：

1. 此场景下服务发现是如何实现的？
2. 在AWS EKS/minikube环境中使用Spring Cloud Gateway是否不需要该Kubernetes依赖？

一、报错核心原因 #

报错本质是依赖版本严重不兼容：

• 你使用的Spring Boot 3.2.2对应Spring Cloud 2023.0.0（Leyton系列），该系列要求Spring Cloud Kubernetes版本至少为3.1.x。
• 但你手动指定的spring-cloud-starter-kubernetes版本是1.1.10.RELEASE，这是适配Spring Boot 2.x的老旧版本，其中spring.cloud.kubernetes.discovery.discovery-server-url是旧版本的配置项，早已在新版本中废弃，因此文档中找不到相关说明。

二、移除K8s依赖后的服务发现逻辑 #

移除依赖后网关能正常路由，是因为直接用了Kubernetes原生DNS服务：

• 你配置的路由URI里的foo-service、bar-service是Kubernetes的Service名称，集群内部的CoreDNS服务会自动将这些名称解析为对应Service的ClusterIP。
• 网关作为集群内的普通Pod，发起HTTP请求时会默认使用集群DNS进行域名解析，无需额外的Spring Cloud服务发现组件参与，完全由Kubernetes网络层完成服务寻址。

三、是否需要Spring Cloud Kubernetes依赖？ #

分两种场景判断：

1. 仅基础路由需求：不需要
   如果你只是通过K8s Service名称配置固定路由，依赖K8s原生DNS就能满足需求，完全不需要引入Spring Cloud Kubernetes。
2. 需Spring Cloud生态集成能力：建议引入兼容版本依赖
   若需要以下能力，则必须添加对应版本的Spring Cloud Kubernetes：
   • 通过DiscoveryClient动态获取服务实例（比如你代码中注入的DiscoveryClient，移除依赖后会失效）
   • 基于服务发现的自动路由规则（无需手动配置每个Service的URI）
   • 集成Spring Cloud Config的K8s配置源
   • 服务实例健康感知与动态更新

正确引入依赖的方式 #

移除手动指定的版本号，让Spring Cloud的dependencyManagement自动管理兼容版本：

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

Spring Cloud 2023.0.0会自动引入适配的Spring Cloud Kubernetes 3.1.x版本，避免版本冲突。

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