DataContract + IxmlSerializable

Question

我们在 Java 服务器上创建了一个带有“自定义对象和属性”的项目，并且在 C# 客户端上需要这些数据。

例如自定义对象“A”具有属性“B”、“C”。 “B”和“C”都由客户在运行时描述。服务器以 XML 格式将其发送给我们，例如：

<A>
    <B> B Data </B>
    <C> C Data </C>
</A>

我们创建了一个实现 IXmlSerializable 的类，它读取/写入 xml 以供服务器将自定义属性填充到字典中

public class CustomObject : IXmlSerializable
{
    private Dictionary<String, String> attributes;

    public void ReadXml(XmlReader reader)
    {
        attributes = XDocument.Parse(reader.ReadOuterXml()).Root.Elements()
            .ToDictionary(xElm => xElm.Name.LocalName, xElm => xElm.Value)
    }

    // More Serialization logic for IXmlSerializable is here
}

项目很慢，我们想使用更快的 DataContract 序列化。 我们通过在我们的属性（如“B”、“C”）上明确指定硬编码 [DataContract] 来对样本进行测试。然而，在我们的用例中，属性在编译时是未知的。我们可以向服务器查询类型“A”的属性列表。

我们如何将 DataContract 用于运行时定义的属性

Answer 1

DataContractSerializer 不支持允许任意未知元素的显式数据协定。 XmlSerializer 通过[XmlAnyElementAttribute] 支持这一点，但正如答案Using [XmlAnyElement] 中所述，数据合约没有相同的功能。

你的类可以实现IExtensibleDataObject。它类似于[XmlAnyElement]，适用于forward-compatible data contracts。不幸的是，在这种情况下，未知元素存储在不透明的ExtensionDataObject 中，没有明显的方法可以访问这些值。虽然可以从这样的对象中提取 XML（请参阅 here），但它并不明显，并且不太可能比您当前的代码性能更高，因为它需要在包装类中重新序列化 ExtensionDataObject，然后解析结果。

关于性能的注意事项 - 当您执行 XDocument.Parse(reader.ReadOuterXml()) 时，reference source 表明您正在有效地解析 XML，然后通过 XmlWriter 将其流式传输到 StringWriter，然后再次解析生成的字符串。您可以通过在传入阅读器上调用 XNode.ReadFrom() 来仅解析一次 XML，而不是这样做，如下所示：

public class CustomObject : IXmlSerializable
{
    private readonly Dictionary<String, String> attributes = new Dictionary<string, string>();

    public IDictionary<string, string> Attributes { get { return attributes; } }

    #region IXmlSerializable Members

    System.Xml.Schema.XmlSchema IXmlSerializable.GetSchema()
    {
        return null;
    }

    void IXmlSerializable.ReadXml(XmlReader reader)
    {
        var element = XElement.ReadFrom(reader) as XElement;
        if (element != null)
        {
            foreach (var item in element.Elements())
                attributes.Add(item.Name.LocalName, (string)item);
        }
    }

    void IXmlSerializable.WriteXml(XmlWriter writer)
    {
        // Do NOT write the wrapper element when writing.
        foreach (var pair in attributes)
        {
            writer.WriteElementString(pair.Key, pair.Value);
        }
    }

    #endregion
}

这应该比您当前的课程更高效。例如，Web API performance issues with large dynamic XML 报告的类似优化改进为 40%。

更新

为了实现IXmlSerializable 的最佳性能，您需要使用定制代码直接从XmlReader 读取内容。例如，以下将元素名称和值读入attributes 字典：

    void IXmlSerializable.ReadXml(XmlReader reader)
    {
        if (reader.IsEmptyElement)
        {
            reader.Read();
            return;
        }
        reader.Read();
        while (reader.NodeType != XmlNodeType.EndElement)
        {
            switch (reader.NodeType)
            {
                case XmlNodeType.Element:
                    var key = reader.Name;
                    var value = reader.ReadElementContentAsString();
                    attributes.Add(key, value);
                    break;

                default:
                    // Comment, for instance.
                    reader.Read();
                    break;
            }
        }
        // Consume the EndElement
        reader.Read();
    }

请参阅Proper way to implement IXmlSerializable?，了解有关正确手动读取元素层次结构的一些一般准则。