使用 Web 服务或 Web 服务参考

Question

这与 .NET 相关。而且我决定使用 Web 服务参考而不是 Web 服务...我认为虽然我下面的问题确实适用于任何一种情况，但我想尝试了解这一点。

这就是我的问题。让我先解释一下我来自哪里。在过去的一个项目中，我之前通过创建手动类（例如 GetPicturesRequest.cs 和 GetPicturesResponse.cs）与几个 API 进行了交谈，这些类将为我保存状态。我有一个名为 Request.cs 的基类，它实际发送了 api 调用：

Stream requestStream;
Stream responseStream;
XmlDocument doc = new XmlDocument();
doc = CreateRequestXML();

// Determins if API call needs to use a session based URI
string requestURI = UseAuthURI == true ? _requestURIAuthBased + JSessionID : _requestURI;

byte[] data = XmlUtil.DocumentToBytes(doc);

// Create the atual Request instance
HttpWebRequest request = CreateWebRequest(requestURI, data.Length);
request.ContentLength = data.Length;
request.KeepAlive = false;
request.Timeout = 30000;

// Send the Request
requestStream = request.GetRequestStream();
requestStream.Write(data, 0, data.Length);
requestStream.Close();

现在我想使用 Web 服务参考。所以我在 VS 2008 中指出并创建了一个对 https://www.sandbox.paypal.com/wsdl/PayPalSvc.wsdl 的新引用。我现在有了一个 Web 引用。

作为第一次使用 Web 服务的用户，我现在有这些问题，而不是像使用 3rd 方 API 那样手动操作：

1) 如何指定标头参数？例如，某些 API 要求您发送哈希（签名）、会话 ID、用户名、密码，您将其与 API 方法调用请求一起命名。如何使用 Web 服务代理类指定这一点？

2) 请求/响应对象是如何处理的，或者我现在使用 Web 服务/引用不需要担心这一点？我的意思是我还需要创建一个请求对象吗？我将如何接收响应？

3) 当我收到响应时，代理类是否包含它的状态，或者我是否仍然需要创建一个类来保存从 API 方法调用响应返回的数据的状态？网络服务/参考？

4) 我什么时候想要像以前一样只创建自定义代码而不使用 WSDL 的 Web 服务/引用选项？...基本上是创建自己的代理类、请求对象，响应对象，一切？而不是让 VS 吐出基于 WSDL 的 Web 参考？是不是因为它不是基于 SOAP 的第 3 方 API？是不是因为 3rd 方 API 不提供 WSDL，所以你不得不自己手动编写包装器代码？

Answer 1

这里有严重的混乱。请大家停下来！

WSE 已过时。不要使用它。

“Web References”与旧的 ASMX Web 服务技术有关。微软现在认为它是“遗留”代码并已停止修复错误。非必要请勿使用。

OP 应该使用“添加服务引用”。我刚刚试了一下，效果很好。

---

现在，回答您的问题：

1. 如何指定标头参数？

   由于此服务使用标头，因此代理类已生成为消息契约，它可以具有标头部分和正文部分。例如，RefundTransactionRequest 类有一个RequesterCredentials 属性，它属于CustomSecurityHeaderType 类型。您只需在发送请求之前进行设置。事实上，它已经为RefundTransactionRequest 生成了一个构造函数，该构造函数将header 和body 作为参数，所以这很容易。

2. 请求/响应对象是如何处理的？

   除了创建类实例和调用方法之外，您无需执行任何操作。所有的序列化都是为你完成的。所有的类创建都是为你完成的。

3. 当我收到响应时，Proxy 类是否包含它的状态？

   是的。代理类将包含所有消息头和正文部分。当然，只有有输出头才会有头部分。

4. 我什么时候想要像以前一样只创建自定义代码而不使用 WSDL 的 Web 服务/引用选项？

   从来没有，我想。我从来没有看到这样做的理由。我想唯一的一次是“添加服务引用”中存在错误。

---

例子：

using (var svc = new PayPalAPIAAInterfaceClient())
{
    var paypal = (PayPalAPIInterface) svc;
    var credentials = new CustomSecurityHeaderType
                          {
                              Credentials =
                                  new UserIdPasswordType
                                      {
                                          AppId = "",
                                          Username = "John",
                                          Password = "John"
                                      }
                          };
    var request = new RefundTransactionRequestType
                      {
                          Amount =
                              new BasicAmountType
                                  {
                                      currencyID = CurrencyCodeType.USD,
                                      Value = "100.00"
                                  },
                          Memo = "I want my money back",
                          RefundType = RefundType.Full,
                          RefundTypeSpecified = true
                      };
    var refundRequest = new RefundTransactionReq
                            {RefundTransactionRequest = request};
    var result =
        paypal.RefundTransaction(
            new RefundTransactionRequest(credentials, refundRequest));
    var response = result.RefundTransactionResponse1;
    var returnedCredentials = result.RequesterCredentials;
}

Answer 2

我假设您为此使用了网络参考。在大多数情况下，使用 Web 服务应该像使用本地对象一样简单。 .NET 在幕后处理所有管道。有时这很有效——其他时候则不然。

当您向 PayPal Web 服务添加 Web 引用时，Visual Studio 将在 Web 引用的子文件夹中创建一个名为 reference.cs 的文件，该文件是代理类（默认情况下 VS 2008 隐藏它——您必须“显示所有文件”以查看它）。

对于您的具体情况，PayPal 似乎正在使用自定义 SOAP 标头来传输所有安全上下文信息。查看 CustomSecurityHeaderType 和 UserIdPasswordType 类型以了解更多详细信息。此外，来自 PayPal 的一些文档可能会有所帮助。 :)

要使用该服务，您必须执行以下操作：

    PayPalAPISoapBinding payPal = new PayPalAPISoapBinding();

    CustomSecurityHeaderType customSecurity = new CustomSecurityHeaderType();
    customSecurity.eBayAuthToken = "The Auth Token";

    UserIdPasswordType userId = new UserIdPasswordType();
    userId.Password = "PWD";
    userId.Username = "JIMMY";

    customSecurity.Credentials = userId;

    payPal.RequesterCredentials = customSecurity;

    RefundTransactionReq request = new RefundTransactionReq();

    RefundTransactionResponseType response = payPal.RefundTransaction(request); 

我不熟悉 PayPal 服务，但我认为它应该是这样工作的。

Answer 3

1) 在您的情况下，签名、用户名和密码在soap 标头中传输。您需要安装WSE 3.0，在您的VS项目中激活它并再次生成代理。

2) 请求创建和响应解析由 WSE 内部进行。只需创建代理，设置标头并调用代理上的方法。

3) 应该有非常充分的理由来创建代理的自定义实现。 WSE 涵盖 SOAP 场景和 WS-* 规范的一部分。除了 SOAP，WCF 还涵盖 TCP、管道和 MSMQ 传输。即使服务不提供 WSDL，你仍然可以自己指定契约，让框架来做传输工作。