如何为WSDL或远程SOAP服务生成的SOAP客户端添加UserAgent

Hey there! Let's tackle your two SOAP client User-Agent questions—whether you're working with a WSDL-generated client or a remote SOAP proxy, I've got you covered with examples for the most common tech stacks:

Depending on the framework you're using, the approach varies a bit, but the core goal is to inject the User-Agent header into outgoing HTTP requests. Here are the most common scenarios:

Java (JAX-WS, generated via wsimport) #

If you used wsimport to generate your client classes, a SOAP Handler is the cleanest way to add the header:

• First, create a handler class that intercepts outbound messages:

  import javax.xml.namespace.QName;
  import javax.xml.ws.handler.MessageContext;
  import javax.xml.ws.handler.soap.SOAPHandler;
  import javax.xml.ws.handler.soap.SOAPMessageContext;
  import java.util.Collections;
  import java.util.Set;
  
  public class UserAgentInjector implements SOAPHandler<SOAPMessageContext> {
      private static final String CUSTOM_USER_AGENT = "MyApp-SOAP-Client/2.1";
  
      @Override
      public Set<QName> getHeaders() {
          return Collections.emptySet();
      }
  
      @Override
      public boolean handleMessage(SOAPMessageContext context) {
          // Only modify outbound requests
          Boolean isOutbound = (Boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
          if (isOutbound) {
              context.put(MessageContext.HTTP_REQUEST_HEADERS,
                      Collections.singletonMap("User-Agent", Collections.singletonList(CUSTOM_USER_AGENT)));
          }
          return true;
      }
  
      @Override
      public boolean handleFault(SOAPMessageContext context) {
          return true;
      }
  
      @Override
      public void close(MessageContext context) {}
  }
  

• Then attach this handler to your client port:

  MySoapService service = new MySoapService();
  MySoapPort port = service.getMySoapPort();
  
  BindingProvider bindingProvider = (BindingProvider) port;
  List<Handler> handlerChain = bindingProvider.getBinding().getHandlerChain();
  handlerChain.add(new UserAgentInjector());
  bindingProvider.getBinding().setHandlerChain(handlerChain);
  
  // Now your SOAP calls will include the custom User-Agent
  port.doSomething();
  

.NET (WCF, generated via svcutil or Add Service Reference) #

For WCF proxies, use a client message inspector to modify the request headers:

• Create an inspector and behavior class:

  using System.ServiceModel;
  using System.ServiceModel.Channels;
  using System.ServiceModel.Dispatcher;
  
  public class UserAgentMessageInspector : IClientMessageInspector
  {
      private readonly string _userAgentValue;
  
      public UserAgentMessageInspector(string userAgent)
      {
          _userAgentValue = userAgent;
      }
  
      public void AfterReceiveReply(ref Message reply, object correlationState) {}
  
      public object BeforeSendRequest(ref Message request, IClientChannel channel)
      {
          var httpRequestProp = new HttpRequestMessageProperty();
          httpRequestProp.Headers["User-Agent"] = _userAgentValue;
          request.Properties[HttpRequestMessageProperty.Name] = httpRequestProp;
          return null;
      }
  }
  
  public class UserAgentEndpointBehavior : IEndpointBehavior
  {
      private readonly string _userAgent;
  
      public UserAgentEndpointBehavior(string userAgent)
      {
          _userAgent = userAgent;
      }
  
      public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters) {}
  
      public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
      {
          clientRuntime.ClientMessageInspectors.Add(new UserAgentMessageInspector(_userAgent));
      }
  
      public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher) {}
  
      public void Validate(ServiceEndpoint endpoint) {}
  }
  

• Attach the behavior to your client instance:

  var soapClient = new MySoapServiceClient();
  soapClient.Endpoint.Behaviors.Add(new UserAgentEndpointBehavior("MyDotNet-SOAP-Client/1.0"));
  
  // Make your SOAP calls as usual
  soapClient.PerformAction();
  

Remote SOAP proxies are typically generated from a remote WSDL, so many of the above methods apply. But here are a few framework-specific shortcuts:

Python (Zeep) #

Zeep makes this super straightforward by letting you use a custom requests session:

from zeep import Client
from zeep.transports import Transport
import requests

# Create a session with your custom User-Agent
session = requests.Session()
session.headers.update({"User-Agent": "MyPython-Zeep-Client/3.0"})

# Initialize the Zeep client with the custom transport
client = Client("http://remote-service.com/soap/wsdl", transport=Transport(session=session))

# All requests will include the User-Agent
client.service.remoteMethod()

PHP (Built-in SoapClient) #

For PHP's native SoapClient, pass the User-Agent in the stream context options:

$wsdlUrl = "http://remote-service.com/soap/wsdl";
$options = [
    'stream_context' => stream_context_create([
        'http' => [
            'header' => 'User-Agent: MyPHP-SOAP-Client/1.5'
        ]
    ])
];

$soapClient = new SoapClient($wsdlUrl, $options);
// Your SOAP calls will now have the custom User-Agent
$soapClient->remoteFunction();

Quick Note #

No matter which framework you're using, the core principle is the same: intercept the outgoing HTTP request before it's sent to the SOAP service, and add or modify the User-Agent header. If you're working with a less common tool, look for hooks related to HTTP request modification or message interception.

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