攻克SpringCloud Gateway网关多路由404难题：告别迷雾，走向光明

2023-11-03 03:02:24

解决 Spring Cloud Gateway 多路由配置中的恼人 404 错误

前言

在微服务架构中，Spring Cloud Gateway 作为统一的入口，负责承载多路由配置，为不同服务提供访问。然而，在实际应用中，时常会遭遇恼人的 404 错误，阻碍访问特定路由。本文将深入探讨导致 404 错误的根源，并逐一提供解决方案，帮助您彻底解决这一难题，让微服务架构平稳运行。

404 错误的幕后黑手

Spring Cloud Gateway 中的 404 错误往往源于以下罪魁祸首：

依赖冲突： 网关项目同时引入 spring-boot-starter-actuator 和 spring-boot-starter-web 依赖时，可能导致冲突，引发 404 错误。
启动类位置异常： 当启动类未放置在主包目录下，而是位于子包中时，可能会导致 404 错误。
路由配置有误： 路由配置不当，例如 URL 路径拼写错误或请求方法设置有误，会导致 404 错误。
过滤器配置不当： filters 配置不当，例如缺少 StripPrefix 过滤器或配置错误，也会导致 404 错误。

逐个击破，斩获胜利果实

针对上述 404 错误的根源，我们逐个击破，为您奉上妙计：

1. 依赖冲突退场

果断删除网关项目中的 spring-boot-starter-actuator 和 spring-boot-starter-web 依赖，彻底消除冲突的根源。

2. 启动类回归主位

将启动类移至主包目录下，让其安然回归原本的位置，从而杜绝 404 错误的发生。

3. 路由配置排查

仔细检查路由配置，确保 URL 路径拼写正确无误，请求方法设置得当，让路由配置万无一失。

4. 过滤器配置优化

在路由配置中添加 filters: - StripPrefix=1，与路由 id 同级，以便去除前缀，确保请求能够顺利到达目标服务。

代码示例：

spring:
  cloud:
    gateway:
      routes:
        - id: my-route
          uri: http://example.com
          predicates:
            - Path=/my-path
          filters:
            - StripPrefix=1

殊途同归，终见光明坦途

除了上述妙计，还有以下方法也可助您解决 404 错误问题：

删除 target，重新编译： 有时，删除 target 目录并重新编译项目，也能有效解决 404 错误。
合理使用 @ComponentScan： 当启动类未直接写在主包目录下时，需要在启动类中加上 @ComponentScan("xxx")，其中 xxx 是您项目的根包名，此举可确保启动类能够扫描到所有相关的组件。