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. Мы опробовали образец, явно указав строковые коды [DataContract] на наши атрибуты (например, «B», «C»). Однако в наших случаях использования атрибуты не известны во время компиляции. Мы можем запросить сервер для списка атрибутов типа «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, то разбор результирующей строки во второй раз. Вместо того, чтобы делать это, вы можете разобрать XML только один раз, вызвав XNode.ReadFrom() на входящем читателя, например, так:

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%.

Update

Для наилучшей производительности реализующей 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? для некоторых общих принципов вручную чтение иерархии элементов правильно.