java - CXF 请求 HTTP 上下文不会在 2 个请求之间刷新

Question

TL;DR : 我尝试创建一个测试，该测试对 2 个不同的 SOAP 操作(saveUser 和 getUser)执行 2 个 CXF 调用，但第二个失败，因为设置了 http 请求中的 SOAPAction作为“saveUser”而不是“getUser”。我找到了 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 之前调用的拦截器，强制删除 header 中的 SoapAction，以强制此拦截器重新计算操作。- 或者我可以重置两个请求之间的请求上下文:

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

问题

所以我的问题是:是否存在 CXF 错误？(不应在 2 个请求之间共享 requestContext)或我错过了一些 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 header :

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

从您的示例中，我看不到您正在设置 PROTOCOL_HEADERS，但这是我的根本原因，因为这是包含 SOAPAction header 的映射。也许您的代码的其他部分可能正在篡改它。

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

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

Official JAX-WS answer: No. According to the JAX-WS spec, the client proxies are NOT thread safe. To write portable code, you should treat them as non-thread safe and synchronize access or use a pool of instances or similar.

CXF answer: CXF proxies are thread safe for MANY use cases. The exceptions are:

Use of ((BindingProvider)proxy).getRequestContext() - per JAX-WS spec, the request context is PER INSTANCE. Thus, anything set there will affect requests on other threads.

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

上下文在 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 header 。

然后是 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 协议(protocol) header 上设置 SOAP_ACTION header map，它是当前请求上下文的一部分，在 ClientImpl 类中声明。

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

解决方案:

我认为最干净的解决方案是只使用拦截器在协议(protocol) header 映射中设置值，请注意我们根本不在基本请求上下文上操作:

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));
}
}

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