CXF 请求 HTTP 上下文未在 2 个请求之间刷新

Question

TL;DR : 我尝试创建一个测试，该测试在 2 个不同的 SOAP 操作（saveUser 和 getUser）上执行 2 个 CXF 调用，但第二个失败，因为设置了 http 请求中的 SOAPAction作为“保存用户”而不是“获取用户”。 我找到了 2 个解决方案来解决这个问题，但我对它们并不完全满意。

配置

这是我的端点配置：

    final JaxWsProxyFactoryBean jaxWsProxyFactory = new JaxWsProxyFactoryBean();
    jaxWsProxyFactory.setServiceClass(Internal.class);
    jaxWsProxyFactory.setAddress(backendUrl + "INTERNAL");
    jaxWsProxyFactory.setFeatures(getFeatures());
    final Internal portType = (Internal) jaxWsProxyFactory.create();
    ((BindingProvider) portType).getRequestContext().put("thread.local.request.context", "true");
    ((BindingProvider) portType).getRequestContext().put("schema-validation-enabled", "false");

这是我的用法：

internalBackendG5.saveUser(getRequest);
internalBackendG5.getUser(saveRequest);

这两个操作被定义为（感谢 wsdl2java）：

（为了更简洁，我重写了一些包，下面的代码可能包含错字）

    @WebMethod(action = "http://www.test.org/internal/saveUser")
@WebResult(name = "saveUserResponse", targetNamespace = "urn:test.com:xsd:internal:userpreferences", partName = "parameters")
public com.test.internal.type.SaveUserResponseType saveUser(
    @WebParam(partName = "parameters", name = "saveUser", targetNamespace = "urn:test.com:xsd:internal:userpreferences")
    com.test.internal.type.SaveUserRequestType parameters
);

和

@WebMethod(action = "http://www.test.org/internal/getUser")
@WebResult(name = "getUserResponse", targetNamespace = "urn:test.com:xsd:internal:userpreferences", partName = "parameters")
public com.test.internal.type.GetUserResponseType getUser(
    @WebParam(partName = "parameters", name = "getUser", targetNamespace = "urn:test.com:xsd:internal:userpreferences")
    com.test.internal.type.GetUserRequestType parameters
);

运行时

当我运行我的测试时，我在第二次调用时收到一个错误，该错误是作为 Soap 异常从后端抛出的：

javax.xml.ws.soap.SOAPFaultException: Unexpected element {urn:test.com:xsd:internal:userpreferences}getUser found.   Expected {urn:test.com:xsd:internal:userpreferences}saveUser.

当我查看服务器收到的 Soap 请求时，我得到：

对于第一个请求（saveUser）：

Headers: {[...] SOAPAction=["http://www.test.org/internal/saveUser"], user-agent=[Apache CXF 2.7.12]}
Payload: <soap:Envelope><soap:Body><saveUser>[...]</ns5:saveUser></soap:Body></soap:Envelope>

对于第二个请求（getUser）：

Headers: {[...] SOAPAction=["http://www.test.org/internal/saveUser"], user-agent=[Apache CXF 2.7.12]}
Payload: <soap:Envelope><soap:Body><getUser>[...]</getUser></soap:Body></soap:Envelope>

当我只启动两个请求中的一个时，它们都可以工作。

我找到的解决方案

经过一番研究，我发现 Apache Cxf 拦截器 SoapPreProtocolOutInterceptor 是负责任的。

当请求中已经存在 SoapAction 字符串时，它不会覆盖它。我的第二次调用（由于某些原因我无法解释）重用了在处理第一次调用时计算的 Cxf 请求上下文！

我做了什么来克服这个问题： - 在 SoapPreProtocolOutInterceptor 之前编写一个拦截器，强制在标头中删除 SoapAction，以强制此拦截器重新计算操作。 - 或者，我可以重置 2 个请求之间的请求上下文：

((BindingProvider) portType).getRequestContext().put(Header.HEADER_LIST, emptyList);

问题

所以我的问题是：是否存在 CXF 错误？（requestContext 不应在 2 个请求之间共享）或 我错过了一些 Cxf 配置？

PS：我使用了这个依赖项：

group:'org.apache.cxf', name:'cxf-rt-transports-http-jetty', version:'2.7.5'
group: 'org.apache.cxf', name: 'cxf-rt-features-clustering', version:'2.7.12'
group:'org.apache.cxf', name:'cxf-rt-frontend-jaxws', version:'2.7.12'
group: 'org.apache.cxf', name: 'cxf-api', version: '2.7.12'
group: 'org.apache.cxf', name: 'cxf-rt-bindings-soap', version: '2.7.12'

提前致谢！

Answer 1

我遇到了同样的问题，经过一些调试，我想我找到了原因。

在调用这样的任何操作之前，我在 PROTOCOL_HEADERS 映射上设置了我自己的自定义 http 标头：

Map<String, List<String>> headers = new HashMap<>();
headers.put("header-name", Arrays.asList("value"));
proxy.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);

从您的示例中，我没有看到您正在设置 PROTOCOL_HEADERS，但这是我的情况的根本原因，因为这是包含 SOAPAction 标头的映射。也许你的代码的其他部分可能会被篡改。

首先，我们知道客户端代理请求上下文不是线程安全的

• http://cxf.apache.org/faq.html

官方 JAX-WS 回答：不。根据 JAX-WS 规范，客户端代理不是线程安全的。要编写可移植代码，您应该将它们视为非线程安全并同步访问或使用实例池或类似的。

CXF 回答：CXF 代理对于许多用例来说都是线程安全的。例外情况是：

使用 ((BindingProvider)proxy).getRequestContext() - 根据 JAX-WS 规范，请求上下文是 PER INSTANCE。因此，在那里设置的任何内容都会影响其他线程上的请求。

这对我提出了一些关于使用此上下文的危险信号，但这似乎不是问题的原因，我只是向它添加了一个简单的协议标头，这不是用户特定的。

上下文在 ClientImpl 类中声明，并用作每个服务调用的基本上下文：

protected Map<String, Object> currentRequestContext = new ConcurrentHashMap<String, Object>(8, 0.75f, 4);

每次请求上下文时，都会执行以下方法：

public Map<String, Object> getRequestContext() {
    if (isThreadLocalRequestContext()) {
        if (!requestContext.containsKey(Thread.currentThread())) {
            requestContext.put(Thread.currentThread(), new EchoContext(currentRequestContext));
        }
        return requestContext.get(Thread.currentThread());
    }
    return currentRequestContext;
}

假设我们没有设置线程本地属性，所以我们总是返回当前请求上下文，它现在有我们的 PROTOCOL_HEADERS 映射，其中仍然没有 SOAPAction 标头。

然后是 SoapPreProtocolOutInterceptor 类，（我只提取了 setSoapAction(...) 方法的相关部分：

        Map<String, List<String>> reqHeaders 
            = CastUtils.cast((Map<?, ?>)message.get(Message.PROTOCOL_HEADERS));
        if (reqHeaders == null) {
            reqHeaders = new TreeMap<String, List<String>>(String.CASE_INSENSITIVE_ORDER);
        }

        if (reqHeaders.size() == 0) {
            message.put(Message.PROTOCOL_HEADERS, reqHeaders);
        }

        if (!reqHeaders.containsKey(SoapBindingConstants.SOAP_ACTION)) {            
            reqHeaders.put(SoapBindingConstants.SOAP_ACTION, Collections.singletonList(action));
        }

在这里，我们将在最后一个 if 语句中结束，在此客户端上执行我们的 first 调用，从而在 SAME 协议标头上设置 SOAP_ACTION 标头map，它是当前请求上下文的一部分，在 ClientImpl 类中声明。

此客户端的任何后续请求都将以已填充的映射为基础，其中包含协议标头和上下文中的 SOAP_ACTION 标头，从而导致观察到的行为。我们永远不会输入为我们的服务调用上下文创建带有 PROTOCOL_HEADERS 的新映射的 if 语句。

解决方案：

在我看来，最干净的解决方案是只使用拦截器来设置协议标头映射中的值，请注意，我们根本没有在基本请求上下文上进行操作：

public class HttpHeaderExampleInterceptor extends AbstractPhaseInterceptor
{
private static final String HEADER_NAME = "header_name";
private String value;

public HttpHeaderExampleInterceptor(String value)
{
    super(Phase.MARSHAL);
    this.value = value;
}

/**
 * @see org.apache.cxf.binding.soap.interceptor.SoapPreProtocolOutInterceptor#setSoapAction(SoapMessage)
 */
@Override
public void handleMessage(Message message) throws Fault
{
    Map<String, List<String>> protocolHeaders = CastUtils.cast((Map<?, ?>) message.get(Message.PROTOCOL_HEADERS));

    if (protocolHeaders == null)
    {
        protocolHeaders = new TreeMap<String, List<String>>(String.CASE_INSENSITIVE_ORDER);
        message.put(Message.PROTOCOL_HEADERS, protocolHeaders);
    }

    protocolHeaders.put(HEADER_NAME, Collections.singletonList(value));
}
}

希望这会有所帮助，如果有人在我的调试中发现错误，请分享，因为这个问题确实很有趣。

Answer 2

所以@DDV 的回答是正确的，我想补充两点：

• 我在3.2.5 版本中看到了同样的问题，但PhaseInterceptor 发生了一些变化，因此@DDV 的答案中的代码不能完全翻译。
• 我在 WS-Addressing 中遇到问题，所以我希望这个答案可以帮助人们搜索 WS-Addressing

---

class MessageIdResetInterceptor extends AbstractPhaseInterceptor[SoapMessage](Phase.SETUP_ENDING) {
  override def handleMessage(message: SoapMessage): Unit = {
    val addressing = message
      .getContextualProperty("javax.xml.ws.addressing.context.outbound")
      .asInstanceOf[AddressingProperties]

    addressing.setMessageID(null)
    addressing.setAction(null)
  }
}