Spring Cloud Gateway 实现带路径保留的跨域重定向教程

本文详解如何在 spring cloud gateway 中配置路由,使请求不仅重定向到目标主机,还能完整保留原始路径与查询参数,避免仅跳转至根路径的问题。

在 Spring Cloud Gateway 中,RedirectToGatewayFilterFactory(即 f.redirect(statusCode, uri))默认仅接受一个静态目标 URI 字符串,它会忽略原始请求路径,直接跳转到该 URI 的根路径(如 "https://internal-api.com" → https://internal-api.com/),无法自动拼接原始路径 /site/rest/services/testservice/1。因此,单纯调用 .redirect(302, "https://internal-api.com") 会导致路径丢失。

要实现路径透传式重定向(即 http://localhost:8080/site/rest/services/testservice/1?x=1 → https://internal-api.com/site/rest/services/testservice/1?x=1),必须动态构造重定向 Location 头,而非依赖内置 redirect filter。推荐使用 changeRequestUri + 自定义 URI 重建的方式,配合手动设置 Location 响应头完成 302 重定向。

以下是完整、可运行的配置示例:

@Bean
public RouteLocator routes(RouteLocatorBuilder builder) {
    String auth = username + ":" + password;
    String encodedAuth = Base64.getEncoder().encodeToString(auth.getBytes());

    return builder.routes()
        .route("geoApi", r -> r
            .path("/site/rest/services/**")
            .filters(f -> f
                // 1. 动态构建重定向目标 URI:复用原请求路径 + 新 host/scheme
                .changeRequestUri(exchange -> {
                    URI originalUri = exchange.getRequest().getURI();
                    UriComponentsBuilder builder = UriComponentsBuilder.fromUri(originalUri)
                        .scheme("https")
                        .host("internal-api.com")
                        .port(-1); // -1 表示移除端口(若原请求无端口)
                    return Optional.of(builder.build(true).toUri());
                })
                // 2. 手动添加 302 重定向响应头(关键!)
                .setResponseHeader(HttpHeaders.LOCATION,
                    "{uri}") // SpEL 表达式,由 Gateway 自动解析为 changeRequestUri 构造后的 URI
                // 3. 设置状态码为 302(需配合 setResponseHeader 使用)
        

.setResponseStatus(HttpStatus.MOVED_TEMPORARILY) // 4. 可选:添加认证头(作用于重定向响应的 Location 不生效,但若后续请求需鉴权,建议在下游服务处理) .setRequestHeader(HttpHeaders.AUTHORIZATION, "Basic " + encodedAuth) ) .uri("https://dummy.com")) // 此 uri 仅作占位(因实际不转发,而是重定向),可设为任意合法 URI .build(); }

⚠️ 重要说明与注意事项

  • changeRequestUri 本身不会触发重定向,它只是修改 Gateway 内部对下游请求的 URI 解析;真正实现重定向的是 setResponseHeader("Location", "{uri}") + setResponseStatus(302) 组合;
  • {uri} 是 Spring Cloud Gateway 内置的 SpEL 表达式,会自动解析为 changeRequestUri 函数返回的 URI(已含完整路径和查询参数);
  • setRequestHeader(...) 在重定向场景下对客户端无效(重定向是响应行为,客户端收到 Location 后发起新请求),如需目标服务鉴权,请确保 internal-api.com 能校验 Basic Auth,或改用 OAuth2、JWT 等网关级统一认证方案;
  • 若需支持 HTTPS 证书信任(如 internal-api.com 使用自签名证书),需额外配置 HttpClient 并注入 WebClient.Builder,此处略;
  • 替代方案(不推荐):使用 RewritePath + SetPath 配合 uri("https://internal-api.com") 实现代理转发(非重定向),适用于无需暴露目标地址的场景。

总结:Spring Cloud Gateway 的“重定向”需区分「响应式重定向」(302 + Location)与「透明代理转发」。当明确需要客户端跳转且保留路径时,应放弃 redirect() 工厂方法,转而组合 changeRequestUri、setResponseHeader("Location", "{uri}") 和 setResponseStatus 三步完成精准控制。