C# yield在WCF中的錯誤用法（一）

2020-01-24 02:00:21

字體：大中小

來源：轉載

供稿：網友

在定義API的時候，對于一些返回集合對象的方法，很多人喜歡將返回類型定義成IEnumerable<T>，這本沒有什么問題。這里要說的是另一個問題：對于返回類型為IEnumerable<T>的方法來說，我們可以使用yield return的方式來輸出返回集合的元素。但是如果我們不了解yield 關鍵字背后的實現機制，很有可能造成很大的問題。

這是一個WCF相關的問題，我想99%的人都有可能會犯這樣的錯誤――即使你對yield了解得非常透徹。閑話少說，我們通過一個簡單的實例來說明這個問題。我們定義了如下一個IDemoService接口作為服務契約，唯一的方法GetItems返回一個類型為IEnumerable<string>對象，并且具有唯一字符串參數category。

復制代碼代碼如下:

  [ServiceContract]
  public interface IDemoService
  {
      [OperationContract]
      IEnumerable<string> GetItems(string category);
  }

下面是實現了該契約接口的DemoService的實現：GetItems方法返回一個包含3個字符串的集合，但是在返回之前我們需要對參數實施驗證。如果category參數提供的字符串為Null或者是空字符串，拋出一個FaultException異常并提示“Invalid Category”，這樣客戶端在輸入不合法參數的情況下可以得到錯誤消息。這樣的編程方式再正常不過了，不是嗎？

復制代碼代碼如下:

public class DemoService : IDemoService
{
    public IEnumerable<string> GetItems(string categoty)
    {
        if (string.IsNullOrEmpty(categoty))
        {
            throw new FaultException("Invalid category");
        }
        yield return "Foo";
        yield return "Bar";
        yield return "Baz";
    }
}

可是正常并不意味著正確，客戶端其實根本無法得到服務端提供給它的錯誤消息，如下所示的是客戶端調用服務時指定一個空字符串參數情況下得到的錯誤。一個CommunicationException異常被拋出來，得到的錯誤消息為“An error occurred while receiving the HTTP response to http://127.0.0.1:3721/demoservice. This could be due to the service endpoint binding not using the HTTP protocol. This could also be due to an HTTP request context being aborted by the server (possibly due to the service shutting down). See server logs for more details.”

這貌似和我們預期的效果不一樣，我們希望的是客戶端拋出一個FaultException，并提示“Invalid category”。這實際上就是因為“yield”在作祟，不相信的話可以將定義在DemoService的GetItems方法替換成如下的定義，即直接返回一個string[]對像。

復制代碼代碼如下:

public class DemoService : IDemoService
{
    public IEnumerable<string> GetItems(string categoty)
    {
        if (string.IsNullOrEmpty(categoty))
        {
            throw new FaultException("Invalid category");
        }
        return new string[] { "Foo", "Bar", "Baz" };
    }
}

再次運行我們的程序，這回可以得到我們期望的結果了。