Azure APIM托管SOAP服务：C# HttpClient调用及解析优化问询

绝对有比手动拼接XML字符串高效得多的方法，既能大幅减少出错概率，又能提升开发效率。下面是几个我在项目中常用的方案，按实用性排序：

1. 基于WSDL生成强类型代理类（首推） #

这是处理SOAP服务最经典的方式，相当于把SOAP服务的接口转换成C#的强类型类，你可以像调用本地方法一样发起请求，完全不用管XML的结构。

操作步骤： #

• 通过Visual Studio生成：右键项目 → 添加 → 服务引用 → 输入你的Azure APIM托管的SOAP服务WSDL地址（比如https://your-apim-instance.azure-api.net/soap-service?wsdl），设置命名空间后点击确定，Visual Studio会自动生成代理类和配置。
• 通过命令行工具生成：如果习惯用命令行，可使用svcutil.exe（Windows SDK自带）：

  svcutil.exe https://your-apim-instance.azure-api.net/soap-service?wsdl /out:SoapServiceClient.cs /config:App.config
  

代码示例： #

生成代理类后，调用代码会非常简洁：

// 实例化代理客户端
var client = new SoapServiceClient(SoapServiceClient.EndpointConfiguration.BasicHttpBinding_ISoapService);

// 配置APIM的订阅密钥（如果需要）
client.Endpoint.EndpointBehaviors.Add(new CustomHeaderBehavior("Ocp-Apim-Subscription-Key", "your-key"));

// 调用服务方法
var request = new YourRequestType
{
    Property1 = "value1",
    Property2 = 123
};
var response = await client.YourServiceMethodAsync(request);

// 直接使用响应的强类型属性
Console.WriteLine(response.ResultProperty);

这种方式的好处是：自动处理SOAP信封、序列化/反序列化，还能自动处理SOAP Fault（抛出FaultException），调试也更方便。

2. 使用HttpClient结合XML序列化 #

如果不想生成代理类（比如WSDL频繁变动，或者只需要调用少数几个接口），可以定义与SOAP请求/响应对应的C#实体类，通过序列化/反序列化来处理XML，避免手动拼接。

操作步骤： #

1. 定义实体类：根据SOAP请求的XML结构，定义对应的C#类：

[XmlRoot("Envelope", Namespace = "http://schemas.xmlsoap.org/soap/envelope/")]
public class SoapEnvelope<T>
{
    [XmlElement("Header")]
    public SoapHeader Header { get; set; }
    [XmlElement("Body")]
    public SoapBody<T> Body { get; set; }
}

public class SoapBody<T>
{
    [XmlElement(typeof(T))]
    public T Content { get; set; }
}

// 你的具体请求类
[XmlRoot("YourRequest", Namespace = "http://your-service-namespace/")]
public class YourRequest
{
    [XmlElement("Property1")]
    public string Property1 { get; set; }
    [XmlElement("Property2")]
    public int Property2 { get; set; }
}

2. 序列化请求并发送：

var httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "your-subscription-key");

// 构建请求对象
var requestObj = new SoapEnvelope<YourRequest>
{
    Body = new SoapBody<YourRequest>
    {
        Content = new YourRequest
        {
            Property1 = "value1",
            Property2 = 123
        }
    }
};

// 序列化为XML字符串
var serializer = new XmlSerializer(typeof(SoapEnvelope<YourRequest>));
using var stringWriter = new StringWriter();
serializer.Serialize(stringWriter, requestObj);
var xmlContent = stringWriter.ToString();

// 发送请求
var content = new StringContent(xmlContent, Encoding.UTF8, "text/xml");
var response = await httpClient.PostAsync("https://your-apim-instance.azure-api.net/soap-service", content);

// 反序列化响应
var responseXml = await response.Content.ReadAsStringAsync();
using var stringReader = new StringReader(responseXml);
var responseEnvelope = (SoapEnvelope<YourResponse>)serializer.Deserialize(stringReader);
var result = responseEnvelope.Body.Content;

3. 借助第三方库简化操作 #

如果觉得上面的方法还是有点繁琐，可以试试专门处理SOAP的第三方库，比如：

• RestSharp：支持SOAP请求的序列化和发送，只需要定义实体类，就能自动处理XML包装。
• SoapHttpClient：轻量级的SOAP客户端库，简化SOAP请求的构建和响应解析。

不过个人更推荐前两种官方/原生方案，避免引入额外的依赖。

额外注意点 #

• 确保配置正确的SOAP命名空间，这是序列化/反序列化成功的关键；
• Azure APIM通常需要订阅密钥，记得在请求头或者代理客户端中配置；
• 如果服务有自定义的SOAP Header，需要在代理类或者实体类中对应配置。

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