DataContractSerializer 及其问题 - 寻找更好的序列化器

Question

我们已经建立了previously，DCS 按字母顺序序列化/反序列化对象。但是，经过进一步调查，我发现这并非完全正确。

如果我们有这样的结构：

[DataContract]
public class Content
{
    [DataMember]
    public string Title;
    [DataMember]
    public string Slug;
    [DataMember]
    public string Description;
}

[DataContract]
public class TextContent : Content
{
    [DataMember]
    public string Text; 
}

并且有一个 TextContent 类型的对象要序列化，DCS 会这样做：

<Content i:type="TextContent" ...>
<Description>desc</Description>
<Slug>some-slug</Slug>
<Title>content title</Title>
<Text>some content</Text>
</Content>

如您所见，继承类的属性附加到序列化 XML 片段的末尾，即使它应该在 Title 之前。 DCS 不会检查组合属性并重新排序它们。 当我在 Title 元素前面手动添加 Text 元素并且反序列化不想工作时，我注意到了这一点。这就是为什么我执行了一个新对象的序列化并解决了这个问题。

我的问题是：

1. 这不可能是常识？？其他人注意到这一点了吗？
2. 任何人都知道更好的序列化程序（如果我搜索它，我只能找到旧的 XmlSerializer 和 DCS），因为 DCS 的排序问题非常烦人？我知道我们可以使用 Order 属性，但这只能使我们与一个外部 XML 源保持一致。如果我们有三个、四个或更多第三方 XML 提供程序，它们都生成完全有效的 XML，但我们的应用程序在元素顺序上挑剔（因为 DCS）？

Answer 1

基本类型始终排在第一位。您可以根据DataMember 属性的Order 属性定义对象的序列化属性的顺序（请参阅http://msdn.microsoft.com/en-us/library/ms729813.aspx）

Answer 2

有NetDataContractSerializer，但它与 DCS 的唯一区别在于它启用了客户端和服务器之间的类型共享，但您失去了前向兼容性，因为双方都必须序列化/反序列化为相同的类型..

codeplex 上还有用于协议缓冲区的 C# 包装器： http://code.google.com/p/protobuf-net/

我自己没有尝试过，但它应该更快更轻量级。至于您的实际问题：

1. 怀疑，我当然从来没有 注意到了这一点：-P
2. 你能举一个元素的顺序实际上很重要的例子吗？我自己还没有遇到过这种情况（我想这就是我们大多数人没有注意到这种行为的原因..），但是对于 proto-buf 序列化程序，这无疑是一个问题..

Answer 3

如果您需要能够序列化以匹配外部架构，那么您显然不应该使用DataContractSerializer。这不是它的用途。

您可以使用XmlSerializer，它旨在让您更好地控制序列化的 XML，或者实现IXmlSerializable，并获得对 XML 的完全控制，或者您可以使用 LINQ 编写自己的自定义序列化来XML。这将使您完全按照您提到的方式进行操作 - 以不同的方式序列化相同的数据。示例：

数据

internal class Person
{
    internal string Name { get; set; }
    internal string Telephone { get; set; }
    internal Address HomeAddress { get; set; }
    internal Address WorkAddress { get; set; }
}

internal class Address
{
    internal string Line1 { get; set; }
    internal string Line2 { get; set; }
    internal string City { get; set; }
    internal string State { get; set; }
    internal string PostalCode { get; set; }
}

测试程序

private static void Main()
{
    var person = new Person
                     {
                         Name = "John Saunders",
                         Telephone = "something",
                         HomeAddress = new Address
                                           {
                                               Line1 = "Line 1",
                                               Line2 = "Line 2",
                                               City = "SomeCity",
                                               State = "SS",
                                               PostalCode = "99999-9999",
                                           },
                         WorkAddress = new Address
                                           {
                                               Line1 = "Line 1a",
                                               Line2 = "Line 2a",
                                               City = "SomeCitay",
                                               State = "Sa",
                                               PostalCode = "99999-999a",
                                           },
                     };
    XDocument personWithElements = SerializeAsElements(person);
    personWithElements.Save("PersonWithElements.xml");

    XDocument personWithAttributes = SerializeAsAttributes(person);
    personWithAttributes.Save("PersonWithAttributes.xml");
}

序列化为元素：

private static XDocument SerializeAsElements(Person person)
{
    return new XDocument(
        new XElement("Person",
                     new XElement("Name", person.Name),
                     new XElement("Telephone", person.Telephone),
                     SerializeAddressAsElements(person.HomeAddress, "HomeAddress"),
                     SerializeAddressAsElements(person.WorkAddress, "WorkAddress"))
        );
}

private static XElement SerializeAddressAsElements(Address address, string elementName)
{
    return new XElement(elementName,
                        new XElement("Line1", address.Line1),
                        new XElement("Line2", address.Line2),
                        new XElement("City", address.City),
                        new XElement("State", address.State),
                        new XElement("PostalCode", address.PostalCode)
        );
}

序列化为属性：

private static XDocument SerializeAsAttributes(Person person)
{
    return new XDocument(
        new XElement("Person",
                     new XAttribute("Name", person.Name),
                     new XAttribute("Telephone", person.Telephone),
                     SerializeAddressAsAttributes(person.HomeAddress, "HomeAddress"),
                     SerializeAddressAsAttributes(person.WorkAddress, "WorkAddress"))
        );
}

private static XElement SerializeAddressAsAttributes(Address address, string elementName)
{
    return new XElement(elementName,
                        new XAttribute("Line1", address.Line1),
                        new XAttribute("Line2", address.Line2),
                        new XAttribute("City", address.City),
                        new XAttribute("State", address.State),
                        new XAttribute("PostalCode", address.PostalCode)
        );
}

PersonWithElements：

<?xml version="1.0" encoding="utf-8"?>
<Person>
  <Name>John Saunders</Name>
  <Telephone>somethine</Telephone>
  <HomeAddress>
    <Line1>Line 1</Line1>
    <Line2>Line 2</Line2>
    <City>SomeCity</City>
    <State>SS</State>
    <PostalCode>99999-9999</PostalCode>
  </HomeAddress>
  <WorkAddress>
    <Line1>Line 1a</Line1>
    <Line2>Line 2a</Line2>
    <City>SomeCitay</City>
    <State>Sa</State>
    <PostalCode>99999-999a</PostalCode>
  </WorkAddress>
</Person>

PersonWithAttributes：

<?xml version="1.0" encoding="utf-8"?>
<Person Name="John Saunders" Telephone="somethine">
  <HomeAddress Line1="Line 1" Line2="Line 2" City="SomeCity" State="SS" PostalCode="99999-9999" />
  <WorkAddress Line1="Line 1a" Line2="Line 2a" City="SomeCitay" State="Sa" PostalCode="99999-999a" />
</Person>