Лучшие практики XmlReader - PullRequest
       5

Лучшие практики XmlReader

1 голос
/ 28 августа 2011

Я хорошо прочитал MSDN и вопросы, связанные с XmlReader, по StackOverflow, и я еще не сталкивался с приличным примером "передового опыта".

Я пробовал различные комбинации, и каждая из них кажетсяиметь недостатки, но лучшее, что я могу придумать, заключается в следующем:

XML:

<properties>
  <actions:name>start</actions:name>
  <actions:value type="System.DateTime">06/08/2011 01:26:49</actions:value>
</properties>

Код:

// Reads past the initial/root element
reader.ReadStartElement();

// Check we haven't hit the end
while (!reader.EOF && reader.NodeType != XmlNodeType.EndElement) {
    if (reader.IsStartElement("name", NamespaceUri)) {
        // Read the name element
        this.name = reader.ReadElementContentAsString();
    } else if (reader.IsStartElement("value", NamespaceUri)) {
        // Read the value element
        string valueTypeName = reader["type"] ?? typeof(string).Name;
        Type valueType = Type.GetType(valueTypeName);
        string valueString = reader.ReadElementContentAsString();
        // Other stuff here that doesn;t matter to the XML parsing
    } else {
        // We can't do anything with this node so skip over it
        reader.Read();
    }
}

Это передаетсяв мой класс из вызова .ReadSubTree (), и каждый класс читает свою собственную информацию.Я бы предпочел, чтобы он НЕ полагался на то, что он находится в определенном порядке.

До этого я пробовал несколько вариантов.

1) while(reader.Read()) Это было взято из различных примеров, но найденочто он "пропустил" некоторые элементы, когда .ReadContent*() элемента 1 оставил его в начале элемента 2, .Read прочитал его поверх элемента 3.

2) Удаление .Read() вызвало егопросто застрять после первого элемента, который я прочитал.

3) Несколько других, которые я долгое время отправлял в "fail".

Насколько я вижу, код, на котором я остановился, кажется,быть наиболее приемлемым и стабильным, но есть ли что-то очевидное, что мне не хватает?

(обратите внимание на тег c # 2.0, поэтому LINQ / XNode / XElement не являются опциями)

1 Ответ

1 голос
/ 28 августа 2011

Один из подходов заключается в использовании пользовательского XmlReader.XmlReader является абстрактным, и XmlReader может быть объединен в цепочку, предоставляя мощный механизм для выполнения специфичной для домена обработки в считывателе.

Пример: XamlXmlReader

Справка в XmlWrappingReader

Вот пример того, как это можно реализовать (см. Встроенные комментарии):

/// <summary>
/// Depending on the complexity of the Xml structure, a complex statemachine could be required here.
/// Such a reader nicely separates the structure of the Xml from the business logic dependent on the data in the Xml. 
/// </summary>
public class CustomXmlReader: XmlWrappingReader
{
    public CustomXmlReader(XmlReader xmlReader)
        :base(XmlReader.Create(xmlReader, xmlReader.Settings))
    {

    }

    public override bool Read()
    {
        var b = base.Read();
        if (!b)
            return false;
        _myEnum = MyEnum.None;
        if("name".Equals(this.Name))
        {
            _myEnum = MyEnum.Name;
            //custom logic to read the entire element and set the enum, name and any other properties relevant to your domain
            //Use base.Read() until you've read the complete "logical" chunk of Xml. The "logical" chunk could be more than a element.
        }
        if("value".Equals(this.Value))
        {
            _myEnum = Xml.MyEnum.Value;
            //custom logic to read the entire element and set the enum, value and and any other properties relevant to your domain
            //Use base.Read() until you've read the complete "logical" chunk of Xml. The "logical" chunk could be more than a element.
        }
        return true;
    }
    //These properties could return some domain specific values
    #region domain specific reader properties. 
    private MyEnum _myEnum;
    public MyEnum MyEnum
    {
        get { return _myEnum; }
    }

    #endregion
}

public enum MyEnum
{
    Name,
    Value,
    None
}

public class MyBusinessAppClass
{
    public void DoSomething(XmlReader passedInReader)
    {

        var myReader = new CustomXmlReader(passedInReader);
         while(myReader.Read())
         {
             switch(myReader.MyEnum)
             {
                 case MyEnum.Name:
                     //Do something here;
                     break;
                 case MyEnum.Value:
                     //Do something here;
                     break;

             }
         }
    }
}

Слово предостережения: это может быть излишним длянекоторая простая обработка XML, которую вы показали здесь.Если у вас есть более двух элементов, требующих пользовательской обработки, такой подход не рекомендуется.

...