如何访问Swagger Codecen生成的JAXRS类上的请求标头

Question

我有一个带有Swagger API的项目，其服务器代码是由swagger-codegen-2.4.24为语言jaxrs生成的。

生成的代码有一个后缀为“*ApiService”的抽象类，它定义了一系列方法，每个方法对应于API的Swagger规范中定义的每个操作。

每个方法都有一个javax.ws.rs.core.SecurityContext接口局部变量。

现在，在扩展了"*ApiService"的自定义类上，显然javax.ws.rs.core.SecurityContext类局部变量，我需要获取请求标头"X-Forwarded-For"的值。

如果调试自定义类，我会看到SecurityContext接口是org.glassfish.jersey.server.internal.process的一个实例。SecurityContextInjectee，它有我需要的头。

既然我不能与SecurityContextInjectee一起工作，因为它是私有的，那么我如何获取这些信息？

我意识到，如果由swagger-codecen生成的类添加javax.servlet.http.HttpServlet请求类，除了SecurityContext之外，还可以访问请求参数，但我没有看到任何允许这样做的jaxrs参数。

期待您的评论。

Answer 1

在每个规范版本中，您可以定义一个＜code＞头＜/code＞，就像可能的参数位置之一。

因此，一个可能的解决方案是在请求＜code＞参数＜/code＞部分中所需的方法中定义头：

parameters:
    -
        name: X-Forwarded-For
        description: X-Formarwed-For header.
        schema:
            type: string
        in: header

或者，在 JSON 表示法中：

    "parameters": [
        {
            "name": "X-Forwarded-For",
            "description": "X-Formarwed-For header.",
            "schema": {
                "type": "string"
            },
            "in": "header"
        }
    ]

我知道这可能是一个不太容易维护的解决方案，因为您需要在每个请求中包含消息头，但是也许您可以在您的服务实现中使用继承来减轻这个问题。

有一个开放的Github问题要求您描述的行为，以一般方式处理头处理。

在这个相关的SO回答中也建议了一个合适的选项，就是修改API代码生成中使用的Mustache模板，并在其中包含所需的头处理。请注意，这将降低代码的可维护性，并且您将有执行一些改变的风险，这会破坏与官方Swagger Codegen库的兼容性。我不确定在Swagger Codegen中，但是在OpenAPI生成器中，有一个选项可以覆盖使用的模板，而不需要修改正式发行版中提供的实际模板。请看这个相关的SO问题。

尽管情况似乎不再如此，至少在旧版本的泽西中，类是公共，您也可以尝试通过反射访问org.glassfish.jersey.server.internal.process.SecurityContextIn的内部变量，尽管我认为这种解决方法使您的应用程序非常依赖于实现。在任何情况下，也许您可以定义这样一个实用程序方法，您可以在服务实现中重用它：

public static String getXForwardedForHeaderValue(final SecurityContext securityContext) {
  SecurityContextInjectee securityContextImpl = (SecurityContextInjectee) securityContext;
  Field requestContextField = SecurityContextInjectee.class.getDeclaredField("requestContext");
  requestContextField.setAccessible(true);
  ContainerRequestContext requestContext = requestContextField.get(securityContextImpl);
  String xForwardedForHeaderValue = requestContext.getHeaderString("X-Forwarded-For");
  return xForwardedForHeaderValue;
}

最后，另一种可能性是使用处理标头的过滤器。如果需要，您可以使用线程局部变量等方式将标头值传递给基础服务。这个想法将如下所示。

首先，定义一个方便的对象来包装您的< code>ThreadLocal值:

public class XForwardedForHeaderHolder{

    private static final ThreadLocal<String> value = new ThreadLocal<String>();

    public static void setXForwardedForHeader(String xForwardedFor) {
        value.set(xForwardedFor);
    }

    public static String getXForwardedForHeader() {
        return value.get();
    }

    public static void clean() {
        value.remove();
    }
}

接下来，创建一个 ContainerRequestFilter。此过滤器将从正在处理的 HTTP 请求中收到的信息中读取标头：

import java.io.IOException;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;
import javax.ws.rs.ext.Provider;
 
@Provider
public class XForwardedForHeaderRequestFilter implements ContainerRequestFilter {
 
    @Override
    public void filter(ContainerRequestContext requestContext)
        throws IOException {
 
        String xForwardedForHeaderValue = requestContext.getHeaderString("X-Forwarded-For");
        XForwardedForHeaderHolder.setXForwardedForHeader(
            xForwardedForHeaderValue
        );
    }
}

最后，使用服务实现中的价值：

String xForwardedForHeaderValue = XForwardedForHeaderHolder.getXForwardedForHeader();
// Clean up
XForwardedForHeaderHolder.clean();

一方面，过滤器注册应该可以正常工作，但是它可能依赖于您使用的JAXRS版本和Swagger本身；另一方面，该解决方案假设过滤器将在线程局部变量中为底层服务的每个请求提供正确的头，换句话说，不存在任何与线程相关的问题。我认为应该是这样，但这是需要测试的东西。