Reading Xml with XmlReader in C#

Question

I'm trying to read the following Xml document as fast as I can and let additional classes manage the reading of each sub block.

<ApplicationPool>     <Accounts>         <Account>             <NameOfKin></NameOfKin>             <StatementsAvailable>                 <Statement></Statement>             </StatementsAvailable>         </Account>     </Accounts> </ApplicationPool> 

However, I'm trying to use the XmlReader object to read each Account and subsequently the "StatementsAvailable". Do you suggest using XmlReader.Read and check each element and handle it?

I've thought of seperating my classes to handle each node properly. So theres an AccountBase class that accepts a XmlReader instance that reads the NameOfKin and several other properties about the account. Then I was wanting to interate through the Statements and let another class fill itself out about the Statement (and subsequently add it to an IList).

Thus far I have the "per class" part done by doing XmlReader.ReadElementString() but I can't workout how to tell the pointer to move to the StatementsAvailable element and let me iterate through them and let another class read each of those proeprties.

Sounds easy!

Answer 1

My experience of XmlReader is that it's very easy to accidentally read too much. I know you've said you want to read it as quickly as possible, but have you tried using a DOM model instead? I've found that LINQ to XML makes XML work much much easier.

If your document is particularly huge, you can combine XmlReader and LINQ to XML by creating an XElement from an XmlReader for each of your "outer" elements in a streaming manner: this lets you do most of the conversion work in LINQ to XML, but still only need a small portion of the document in memory at any one time. Here's some sample code (adapted slightly from this blog post):

static IEnumerable<XElement> SimpleStreamAxis(string inputUrl,                                               string elementName) {   using (XmlReader reader = XmlReader.Create(inputUrl))   {     reader.MoveToContent();     while (reader.Read())     {       if (reader.NodeType == XmlNodeType.Element)       {         if (reader.Name == elementName)         {           XElement el = XNode.ReadFrom(reader) as XElement;           if (el != null)           {             yield return el;           }         }       }     }   } } 

I've used this to convert the StackOverflow user data (which is enormous) into another format before - it works very well.

EDIT from radarbob, reformatted by Jon - although it's not quite clear which "read too far" problem is being referred to...

This should simplify the nesting and take care of the "a read too far" problem.

using (XmlReader reader = XmlReader.Create(inputUrl)) {     reader.ReadStartElement("theRootElement");      while (reader.Name == "TheNodeIWant")     {         XElement el = (XElement) XNode.ReadFrom(reader);     }      reader.ReadEndElement(); } 

This takes care of "a read too far" problem because it implements the classic while loop pattern:

initial read; (while "we're not at the end") {     do stuff;     read; }