C# yield在WCF中的错误用法（一）

Iris ·

更新时间:2024-11-13

· 884 次阅读

在定义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" };
    }
}

再次运行我们的程序，这回可以得到我们期望的结果了。