Spring Gateway 配置 Actuator 端点后访问出现 404 错误如何解决？

Question

在Spring Gateway中配置Actuator端点后访问出现404错误，通常是因为网关的路由规则拦截了Actuator的请求。解决方法如下：首先确保`spring-boot-starter-actuator`已加入依赖。其次，在`application.yml`中设置`management.endpoints.web.exposure.include=*`以暴露所有端点。由于Spring Gateway默认会将所有请求视为路由请求，需添加特定路径匹配规则跳过Actuator请求。例如，添加`spring.cloud.gateway.routes`配置时，排除`/actuator/**`路径，或使用Predicate工厂定义精确匹配逻辑。最后，确认`management.server.port`是否单独设置，若设置则需在指定管理端口访问Actuator端点。通过以上步骤可有效避免404问题，确保Actuator功能正常运行。

Answer 1

1. 问题概述

在Spring Gateway中配置Actuator端点后访问出现404错误，通常是因为网关的路由规则拦截了Actuator的请求。这种问题在实际开发中较为常见，尤其是在微服务架构下使用Spring Cloud Gateway作为API网关时。以下是对此问题的深入分析和解决方案。

关键词：

• Spring Boot Actuator
• Spring Cloud Gateway
• 路由规则
• Predicate工厂
• 管理端口

2. 问题分析

当我们在Spring Gateway中启用Actuator时，可能会遇到访问Actuator端点返回404的问题。这主要是因为Spring Gateway默认将所有请求视为路由请求，而未对特定路径（如`/actuator/**`）进行特殊处理。

具体来说，Spring Cloud Gateway会拦截所有进入的HTTP请求，并根据预定义的路由规则将其转发到后端服务。如果未正确配置排除规则，Actuator端点的请求也会被误认为是需要路由的请求，从而导致404错误。

3. 解决方案

为了解决上述问题，我们需要从以下几个方面入手：

3.1 确保依赖引入

首先，确保项目中已引入`spring-boot-starter-actuator`依赖。如果没有引入，可以在`pom.xml`中添加以下内容：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

3.2 配置文件调整

其次，在`application.yml`中设置以下内容以暴露所有Actuator端点：

management:
  endpoints:
    web:
      exposure:
        include: "*" 

3.3 路由规则配置

由于Spring Gateway默认会将所有请求视为路由请求，因此需要添加特定路径匹配规则跳过Actuator请求。可以通过以下方式实现：

方法	描述
排除路径	在`spring.cloud.gateway.routes`配置中，添加规则排除`/actuator/**`路径。
Predicate工厂	使用Predicate工厂定义精确匹配逻辑，例如`PathRoutePredicateFactory`。

3.4 检查管理端口

最后，确认是否设置了单独的管理端口。如果`management.server.port`被单独设置，则需要通过指定的管理端口访问Actuator端点。例如：

management:
  server:
    port: 8081

4. 流程图

以下是解决Spring Gateway中Actuator 404问题的流程图：

graph TD
            A[开始] --> B[检查依赖]
            B --> C{依赖是否引入？}
            C --否--> D[引入`spring-boot-starter-actuator`]
            C --是--> E[检查配置文件]
            E --> F{端点是否暴露？}
            F --否--> G[设置`management.endpoints.web.exposure.include=*`]
            F --是--> H[检查路由规则]
            H --> I{是否拦截Actuator路径？}
            I --是--> J[排除`/actuator/**`路径或使用Predicate工厂]
            I --否--> K[检查管理端口]
            K --> L{是否单独设置？}
            L --是--> M[通过指定端口访问Actuator]
            L --否--> N[完成]