Så här strömmar du XML-fragment från en XmlReader (LINQ till XML)

När du måste bearbeta stora XML-filer är det kanske inte möjligt att läsa in hela XML-trädet i minnet. Den här artikeln visar hur du strömmar fragment med hjälp av en XmlReader i C# och Visual Basic.

Ett av de mest effektiva sätten att använda ett XmlReader för att läsa XElement objekt är att skriva en egen anpassad axelmetod. En axelmetod returnerar vanligtvis en samling, till exempel IEnumerable<T> , XElementsom visas i exemplet i den här artikeln. När du har skapat XML-fragmentet genom att anropa ReadFrom metoden i metoden anpassad axel returnerar du samlingen med .yield return Detta ger uppskjuten körningssemantik till din anpassade axelmetod.

När du skapar ett XML-träd från ett XmlReader objekt måste det XmlReader placeras på ett element. Metoden ReadFrom returneras inte förrän den har läst stängningstaggen för elementet.

Om du vill skapa ett partiellt träd kan du instansiera en XmlReader, placera läsaren på den nod som du vill konvertera till ett XElement träd och sedan skapa XElement objektet.

Artikeln Så här strömmar du XML-fragment med åtkomst till rubrikinformation innehåller information om hur du strömmar ett mer komplext dokument.

Artikeln How to perform streaming transform of large XML documents contains a example of using LINQ to XML to transform extremely large XML documents while maintaining a small memory footprint.

Exempel: Skapa en anpassad axelmetod

I det här exemplet skapas en anpassad axelmetod. Du kan köra frågor mot den med hjälp av en LINQ-fråga. Metoden för anpassad axel StreamRootChildDoc kan läsa ett dokument som har ett upprepande Child element.

using System.Xml;
using System.Xml.Linq;

static IEnumerable<XElement> StreamRootChildDoc(StringReader stringReader)
{
    using XmlReader reader = XmlReader.Create(stringReader);

    reader.MoveToContent();

    // Parse the file and display each of the nodes.
    while (true)
    {
        // If the current node is an element and named "Child"
        if (reader.NodeType == XmlNodeType.Element && reader.Name == "Child")
        {
            // Get the current node and advance the reader to the next
            if (XNode.ReadFrom(reader) is XElement el)
                yield return el;

        }
        else if (!reader.Read())
            break;
    }
}

string markup = """
                <Root>
                  <Child Key="01">
                    <GrandChild>aaa</GrandChild>
                  </Child>
                  <Child Key="02">
                    <GrandChild>bbb</GrandChild>
                  </Child>
                  <Child Key="03">
                    <GrandChild>ccc</GrandChild>
                  </Child>
                </Root>
                """;

IEnumerable<string> grandChildData =
    from el in StreamRootChildDoc(new StringReader(markup))
    where (int)el.Attribute("Key") > 1
    select (string)el.Element("GrandChild");

foreach (string str in grandChildData)
    Console.WriteLine(str);

Imports System.Xml

Module Module1

    Public Iterator Function StreamRootChildDoc(stringReader As IO.StringReader) As IEnumerable(Of XElement)
        Using reader As XmlReader = XmlReader.Create(stringReader)
            reader.MoveToContent()

            ' Parse the file and display each of the nodes.
            While True

                ' If the current node is an element and named "Child"
                If reader.NodeType = XmlNodeType.Element And reader.Name = "Child" Then

                    ' Get the current node and advance the reader to the next
                    Dim el As XElement = TryCast(XNode.ReadFrom(reader), XElement)

                    If (el IsNot Nothing) Then
                        Yield el
                    End If

                ElseIf Not reader.Read() Then
                    Exit While
                End If

            End While
        End Using
    End Function

    Sub Main()

        Dim markup = "<Root>
                       <Child Key=""01"">
                         <GrandChild>aaa</GrandChild>
                       </Child>
                       <Child Key=""02"">
                         <GrandChild>bbb</GrandChild>
                       </Child>
                       <Child Key=""03"">
                         <GrandChild>ccc</GrandChild>
                       </Child>
                     </Root>"

        Dim grandChildData =
             From el In StreamRootChildDoc(New IO.StringReader(markup))
             Where CInt(el.@Key) > 1
             Select el.<GrandChild>.Value

        For Each s In grandChildData
            Console.WriteLine(s)
        Next

    End Sub
End Module

Det här exemplet genererar följande utdata:

bbb
ccc

Tekniken som används i det här exemplet har ett litet minnesfotavtryck även för miljontals Child element.

Se även

• Parsa XML