当前位置：文江博客话题详情

WCF OperationContract - 我应该公开哪种通用集合类型？

发布于 2024-08-22 08:40:18 字数 409 浏览 3 评论 0原文

我有一个 WCF Web 服务，它有一个返回通用集合的方法。现在，我的问题是：我应该将其公开为 ICollection、List、IList、IEnumerable 还是其他什么？

我认为 List 是不可能的，因为我想避免 CA1002 错误，但基础类型将是 List。

我真的很想听听你对此的看法，最好能很好地解释你为什么这么想。

提前致谢

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

硬不硬你别怂 2024-08-29 08:40:18

请记住，诸如 CA1002 之类的错误实际上适用于库。 WCF 服务不是一个库，它是一个通过 SOAP、REST 等序列化所有内容的端点。

如果您尝试公开诸如 ICollection 或 之类的接口，您会发现这一点IList，您会收到类型无法序列化的错误。事实上，List 可能是这里的最佳选择。当客户端生成代理时，默认情况下它最终会以数组形式结束，并且许多（如果不是大多数）人将其更改为 List，所以 90% 的情况下，无论如何您选择如何公开它，这就是客户无论如何都会看到的类型。

我要指出的是，一般来说，最好不要从 WCF 操作或 Web 服务中“返回”集合。更常见的是创建一个包含所需集合的代理类，然后返回该集合，即：

[OperationContract]
OrdersResult GetOrders(OrderRequest request);

代理类可能如下所示：

[DataContract]
public class OrdersResult
{
    [DataMember]
    public List<Order> Orders { get; set; }
}

这样，如果您决定需要向请求或响应添加更多数据，您可以可以这样做而不会对客户端造成重大更改。

附录：WCF 的真正问题是 WCF 不知道特定类型仅用于出站数据。当通过 WCF 服务公开任何类时，WCF 假定它可以是该类型的一部分。请求或响应，如果它是请求的一部分，则类型必须是具体的 > 和不能是不可变的。这就是所有其他愚蠢限制（例如要求属性设置者）的原因。

这里你别无选择，只能使用具体的、可变的集合类型，在大多数情况下，这意味着数组或通用列表。

Keep in mind that errors such as CA1002 are really meant to apply to libraries. A WCF service is not a library, it's an endpoint that's serializing everything over SOAP, REST, etc.

You'll find that if you try to expose an interface such as ICollection<T> or IList<T>, you'll get errors that the type can't be serialized. In fact, List<T> is probably the best choice here. When a proxy gets generated on the client side, it ends up as an array by default, and many if not most people change it to a List<T>, so 90% of the time, no matter how you choose to expose it, that's the type that the client is going to see anyway.

I'll note that it's generally good practice not to "return" a collection at all from a WCF operation or a web service in general. It's more common to create a proxy class that contains the collection you want, and return that, i.e.:

[OperationContract]
OrdersResult GetOrders(OrderRequest request);

Where the proxy class might look like this:

[DataContract]
public class OrdersResult
{
    [DataMember]
    public List<Order> Orders { get; set; }
}

That way if you decide you need to add more data to either the request or the response, you can do so without causing breaking changes to the client.

Addendum: The real issue here with WCF is that WCF doesn't know that a particular type is used only for outbound data. When any class is exposed through a WCF service, WCF assumes that it can be part of either a request or a response, and if it is part of a request, then the type must be concrete and cannot be immutable. That's the reason for all the other silly restrictions like requiring property setters.

You simply have no choice here but to use a concrete, mutable collection type, and in most cases that means either an array or a generic list.

回复收藏 0 原文