Vorgehensweise: Streamen von XML-Fragmenten aus einem XmlReader (LINQ to XML)

Wenn Sie große XML-Dateien verarbeiten müssen, kann u. U. nicht die gesamte XML-Struktur in den Arbeitsspeicher geladen werden. In diesem Artikel wird gezeigt, wie Fragmente mithilfe von XmlReader in C# und Visual Basic gestreamt werden.

Eine der effektivsten Möglichkeiten, einen XmlReader zum Lesen von XElement-Objekten zu verwenden, besteht darin, eine eigene benutzerdefinierte Achsenmethode zu schreiben. Achsenmethoden geben in der Regel eine Auflistung zurück, z. B. IEnumerable<T> von XElement, wie dies im Beispiel in diesem Thema dargestellt ist. Nachdem Sie in der benutzerdefinierten Achsenmethode durch Aufrufen der ReadFrom-Methode das XML-Fragment erstellt haben, geben Sie die Auflistung mit yield return zurück. Auf diese Weise versehen Sie Ihre benutzerdefinierte Achsenmethode mit der Semantik für eine verzögerte Ausführung.

Wenn Sie eine XML-Struktur auf der Grundlage eines XmlReader-Objekts erstellen, muss der XmlReader auf einem Element positioniert sein. Die ReadFrom-Methode gibt erst dann einen Wert zurück, wenn sie das Endtag des Elements gelesen hat.

Wenn Sie eine Teilstruktur erstellen möchten, können Sie einen XmlReader instanziieren, den Reader auf dem Knoten positionieren, der in eine XElement-Struktur umgewandelt werden soll, und dann das XElement-Objekt erstellen.

Der Artikel Vorgehensweise: Streamen von XML-Fragmenten mit Zugriff auf Headerinformationen enthält Informationen zum Streamen eines komplexeren Dokuments.

Der Artikel Vorgehensweise: Durchführen einer Streamingtransformation großer XML-Dokumente enthält ein Beispiel für das Verwenden von LINQ to XML, um sehr große XML-Dokumente zu transformieren und gleichzeitig eine geringe Speicherbeanspruchung beizubehalten.

Beispiel: Benutzerdefinierte Achsenmethode erstellen

Dieses Beispiel erstellt eine benutzerdefinierte Achsenmethode. Zum Abfragen kann eine LINQ-Abfrage verwendet werden. Die benutzerdefinierte Achsenmethode StreamRootChildDoc kann ein Dokument lesen, das über ein wiederholtes Child-Element verfügt.

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

Dieses Beispiel erzeugt die folgende Ausgabe:

bbb
ccc

Die in diesem Beispiel verwendete Technik behält auch für mehrere Millionen Child-Elemente einen geringen Arbeitsspeicherbedarf bei.

Siehe auch

• XML-Analyse