Spring Data Rest代理场景下HAL-JSON链接地址异常问题求助

这个问题我在生产环境碰过好多次，核心原因是Spring Data Rest默认会从当前请求的容器（Tomcat）上下文信息生成HAL链接，但经过代理转发后，应用拿到的是Tomcat内部的地址，而非外部用户访问的真实地址。下面是几个靠谱的解决方案，按推荐优先级排序：

1. 启用Spring Boot的转发头处理（最推荐，适用于Spring Boot 2.2+） #

Spring Boot提供了开箱即用的配置来处理代理转发头，只需要在application.properties或application.yml里添加以下配置：

# 告诉Spring Boot使用框架级别的转发头处理逻辑
server.forward-headers-strategy=FRAMEWORK
# 可选：如果需要强制固定外部基础URL，也可以直接指定
spring.data.rest.base-path=https://domainx.com/path/a/to/my/app

原理： #

当设置forward-headers-strategy=FRAMEWORK时，Spring会自动解析代理传递的X-Forwarded-Host、X-Forwarded-Proto、X-Forwarded-Port等请求头，用这些头里的信息生成外部可访问的HAL链接。

2. 配置Tomcat的Remote IP Valve（适用于独立Tomcat或需要细粒度控制） #

如果你的应用部署在独立Tomcat（非Spring Boot内嵌Tomcat），可以在conf/server.xml的<Engine>标签下添加RemoteIpValve，让Tomcat识别代理转发的真实地址：

<Valve className="org.apache.catalina.valves.RemoteIpValve"
       remoteIpHeader="X-Forwarded-For"
       protocolHeader="X-Forwarded-Proto"
       protocolHeaderHttpsValue="https"
       hostHeader="X-Forwarded-Host"
       portHeader="X-Forwarded-Port"/>

注意： #

• 确保你的代理服务器（比如Nginx、Apache）已经配置传递这些头，比如Nginx要加：

  proxy_set_header X-Forwarded-For $remote_addr;
  proxy_set_header X-Forwarded-Proto $scheme;
  proxy_set_header X-Forwarded-Host $host;
  proxy_set_header X-Forwarded-Port $server_port;
  

• 配置后，Tomcat会把这些头里的地址作为请求的真实地址，Spring Data Rest生成链接时就会用这个地址。

3. 自定义LinkGenerator（灵活度最高，适用于特殊场景） #

如果上面的方案都不满足需求（比如外部地址是固定的，不需要从请求头获取），可以自定义一个LinkGenerator覆盖默认的链接生成逻辑：

import org.springframework.data.rest.core.support.DefaultLinkGenerator;
import org.springframework.data.rest.core.support.EntityLookup;
import org.springframework.data.rest.webmvc.support.Projector;
import org.springframework.hateoas.server.LinkRelationProvider;
import org.springframework.stereotype.Component;

@Component
public class CustomLinkGenerator extends DefaultLinkGenerator {

    // 外部服务的基础URL，也可以从配置文件注入
    private static final String EXTERNAL_BASE_URL = "https://domainx.com/path/a/to/my/app";

    public CustomLinkGenerator(LinkRelationProvider relProvider, EntityLookup<?> entityLookup, Projector projector) {
        super(relProvider, entityLookup, projector);
    }

    @Override
    protected String getBaseUri() {
        return EXTERNAL_BASE_URL;
    }
}

原理： #

DefaultLinkGenerator的getBaseUri()方法默认从当前请求获取基础地址，我们重写这个方法直接返回外部服务的固定地址，这样生成的所有HAL链接都会用这个地址。

4. 网关层处理（如果用Spring Cloud Gateway/Zuul） #

如果你的代理是Spring Cloud生态的网关，需要确保网关正确传递转发头，并且可能需要配置响应头去重：

比如在Spring Cloud Gateway的配置里添加：

spring:
  cloud:
    gateway:
      default-filters:
        - DedupeResponseHeader=Access-Control-Allow-Origin Access-Control-Allow-Credentials, RETAIN_FIRST
        - ForwardHeadersFilter=X-Forwarded-For,X-Forwarded-Proto,X-Forwarded-Host,X-Forwarded-Port

这样网关会把这些头传递给后端Tomcat，Spring Data Rest就能正确识别外部地址了。

验证方法 #

修改配置后，发送请求到外部地址https://domainx.com/path/a/to/my/app/res/a_resource_001，检查返回的HAL响应里的self链接是否变成https://domainx.com/path/a/to/my/app/res/a_resource_001，如果是就说明配置生效了。

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