Spring Boot 3整合Zuul网关与Eureka启动失败问题求助

问题背景 #

尝试搭建集成Eureka Discovery Client的Zuul API网关，使用Spring Boot 3.0.2和Zuul 1.x starter，启动应用时出现Bean缺失错误。

相关代码配置 #

ZuulGatewayApplication.java #

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;


@EnableDiscoveryClient
@EnableZuulProxy
@SpringBootApplication
public class ZuulGatewayApplication {

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

}

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.0.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.manager.poc</groupId>
    <artifactId>zuul-gateway</artifactId>
    <version>1.0</version>
    <name>zuul-gateway</name>
    <description>Zuul gateway</description>
    <properties>
        <java.version>17</java.version>
        <spring-cloud.version>2022.0.1</spring-cloud.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
            <version>2.2.10.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </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>
    <repositories>
        <repository>
            <id>netflix-candidates</id>
            <name>Netflix Candidates</name>
            <url>https://artifactory-oss.prod.netflix.net/artifactory/maven-oss-candidates</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

</project>

启动报错信息 #

****************************
APPLICATION FAILED TO START
***************************

Description:

Field optionalArgs in org.springframework.cloud.netflix.eureka.EurekaClientAutoConfiguration$RefreshableEurekaClientConfiguration required a bean of type 'com.netflix.discovery.AbstractDiscoveryClientOptionalArgs' that could not be found.

The injection point has the following annotations:
    - @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'com.netflix.discovery.AbstractDiscoveryClientOptionalArgs' in your configuration.


Process finished with exit code 1

解决方案 #

核心原因 #

Zuul 1.x已停止维护，不支持Spring Boot 3及对应的Spring Cloud 2022.0.x（Kilburn）版本，两者依赖版本存在兼容性冲突，导致Eureka Client相关Bean无法正常初始化。

方案一：降级版本到兼容组合 #

将Spring Boot和Spring Cloud降级到支持Zuul 1.x的版本，推荐组合：

• Spring Boot 2.7.x
• Spring Cloud 2021.0.x（Jubilee）

修改后的pom.xml关键配置：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.12</version>
    <relativePath/>
</parent>
<properties>
    <java.version>17</java.version>
    <spring-cloud.version>2021.0.8</spring-cloud.version>
</properties>
<dependencies>
    <!-- 移除Zuul的硬编码版本，由Spring Cloud依赖管理自动匹配 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
    </dependency>
    <!-- 其他依赖保持不变 -->
</dependencies>

方案二：替换为Spring Cloud Gateway（推荐） #

Spring Cloud Gateway是官方推荐的Zuul替代方案，完全支持Spring Boot 3和最新Spring Cloud版本。

1. 修改pom.xml，替换Zuul依赖为Spring Cloud Gateway：

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!-- 其他依赖保持不变 -->
</dependencies>

2. 修改启动类，移除@EnableZuulProxy，保留@EnableDiscoveryClient和@SpringBootApplication：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class ZuulGatewayApplication {

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

}

3. 添加路由配置（application.yml或application.properties）示例：

spring:
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true # 开启从Eureka自动发现服务路由
          lower-case-service-id: true # 服务ID转为小写
      routes:
        - id: service-example
          uri: lb://service-example # 指向Eureka中的服务实例
          predicates:
            - Path=/example/** # 路由路径匹配

内容的提问来源于stack exchange，提问作者Muhammad Ahmed