如何为JAX-WS的SOAP调用添加GET参数

针对你用wsimport生成的标准JAX-WS客户端（基于javax.xml.ws.Service），有两种实用方法可以给SOAP调用添加GET参数：

方法1：直接修改端点URL（简单场景） #

如果参数是固定的，直接拼接GET参数到服务端点URL即可：

// 实例化你的Service类（替换为实际生成的Service类）
YourGeneratedService service = new YourGeneratedService();
// 获取对应的端口代理
YourPortType port = service.getYourPort();

// 将端口转换为BindingProvider，用于修改请求上下文
BindingProvider bindingProvider = (BindingProvider) port;

// 获取当前的端点地址
String originalEndpoint = (String) bindingProvider.getRequestContext()
        .get(BindingProvider.ENDPOINT_ADDRESS_PROPERTY);

// 拼接GET参数（示例：添加apiKey=12345）
String updatedEndpoint = originalEndpoint + "?apiKey=12345";

// 更新端点地址
bindingProvider.getRequestContext()
        .put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, updatedEndpoint);

// 现在调用SOAP方法，请求会发送到带GET参数的URL
port.yourSoapOperation();

方法2：自定义Handler（灵活场景） #

如果需要动态添加参数、处理URL已有查询参数的情况，可以通过自定义SOAP Handler来控制HTTP请求：

步骤1：实现自定义Handler #

import javax.xml.ws.handler.Handler;
import javax.xml.ws.handler.HandlerResolver;
import javax.xml.ws.handlers.MessageContext;
import javax.xml.ws.handlers.soap.SOAPHandler;
import javax.xml.ws.handlers.soap.SOAPMessageContext;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

public class GetParamInjectHandler implements SOAPHandler<SOAPMessageContext> {
    private final String queryParams;

    public GetParamInjectHandler(String queryParams) {
        this.queryParams = queryParams;
    }

    @Override
    public Set<String> getHeaders() {
        return null;
    }

    @Override
    public boolean handleMessage(SOAPMessageContext context) {
        // 仅处理出站请求（客户端发送到服务端的请求）
        Boolean isOutbound = (Boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
        if (isOutbound) {
            try {
                String originalUrl = (String) context.get(MessageContext.ENDPOINT_ADDRESS);
                URI uri = new URI(originalUrl);
                
                // 处理已有查询参数的情况，避免重复?
                String newQuery = uri.getQuery() == null 
                        ? queryParams 
                        : uri.getQuery() + "&" + queryParams;
                
                // 构建新的URI
                URI updatedUri = new URI(
                        uri.getScheme(),
                        uri.getUserInfo(),
                        uri.getHost(),
                        uri.getPort(),
                        uri.getPath(),
                        newQuery,
                        uri.getFragment()
                );
                
                // 更新请求的端点地址
                context.put(MessageContext.ENDPOINT_ADDRESS, updatedUri.toString());
            } catch (URISyntaxException e) {
                throw new RuntimeException("Failed to inject GET parameters into endpoint URL", e);
            }
        }
        return true;
    }

    @Override
    public boolean handleFault(SOAPMessageContext context) {
        return true;
    }

    @Override
    public void close(MessageContext context) {
        // 无需额外清理
    }
}

步骤2：注册Handler到Service #

YourGeneratedService service = new YourGeneratedService();

// 设置HandlerResolver，注入自定义Handler
service.setHandlerResolver(portInfo -> {
    List<Handler> handlerChain = new ArrayList<>();
    // 传入需要添加的GET参数，支持多个参数用&分隔
    handlerChain.add(new GetParamInjectHandler("apiKey=12345&timestamp=1699999999"));
    return handlerChain;
});

// 获取端口并调用SOAP方法
YourPortType port = service.getYourPort();
port.yourSoapOperation();

注意事项 #

• SOAP协议默认基于POST请求，但GET参数是附加在URL中的，需要确保服务端能够同时处理URL中的GET参数和POST体中的SOAP消息。
• 由于该参数未定义在WSDL中，属于客户端自定义扩展，需提前确认服务端能够识别并处理这些参数。

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