WCF集合数据契约

Question

我最近在一篇文章中注意到，wcf 服务操作返回了一个集合数据契约

Users GetUsers(string someInput);

，并且用户类型定义如下：

[CollectionDataContract]
    public class Users : List<User>
    {
        public Users()
        {
        }

        public Users(IEnumerable<User> users) : base(users)
        {
        }
    }

返回集合数据契约（如本例中的用户）是否与简单返回 List？

Answer 1

据我了解，在 DataContractSerializer 完成序列化集合的工作后，此属性将使您能够对最终 xml 字符串中元素的名称进行一些控制。

当您稍后必须手动解析结果时，这会很有用（换句话说，您将知道要在该 xml 文本中查找什么元素，以找到您的集合及其部分）。

查看示例和更多信息：

http://msdn.microsoft。 com/en-us/library/aa347850.aspx

Answer 2

如果返回一个 List，则数据序列化器有一种生成 xml 的特定方式。我不知道它如何对 List 执行此操作，但如果它是一个数组，它会生成类似的内容 -

<arrayOfUsers>
<User>
...here User object 1
</User>
...etc.
</arrayOfUsers>

但使用 CollectionDataContract 您可以将其序列化，并更好地向可能手动创建 XML 的消费者公开它。例子 - 我可以给 -
CollectionDataCOntract(Name="AllUsers") // 我不记得 ItemName 或 Name

，那么预期的 XML 会类似于 -

<AllUsers>
<User>
...here User object 1
</User>
...etc.
</AllUsers>

这是一个实用程序。

Answer 3

只是为了阐述 Andrei 的答案并分享我的经验，我刚刚经历了一个最终使用 CollectionDataContract 解决的问题。基本上，为了与特定系统交互，我希望能够发送和接收以下格式的 xml：

<SomeMessageList>
  <Message>
    <ID>blah</ID>
    <data1>blah</data1>
    <data2>etc.etc.</data2>
  </Message>
  <Message>
    <ID>blah</ID>
    <data1>blah</data1>
    <data2>etc.etc.</data2>
  </Message>
  //any number of repeated <Message> here
</SomeMessageList>

但是，如果我使用数组或 List 对象，则根标记始终称为 ArrayOfMessage。如果我创建了一个包含 Message 对象数组的类（假设称为 MsgList），那么 WCF 会将其添加为混合中的额外标记，但我找不到摆脱它的方法。所以它看起来像：

<SomeMessageList>
  <MsgList>
    <Message>
      <ID>blah</ID>
      <data1>blah</data1>
      <data2>etc.etc.</data2>
    </Message>
    //any number of repeated <Message> here
  </MsgList>
</SomeMessageList>

所以 CollectionDataContract 只是给了我一个简单的方法来控制根列表元素的名称。