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.

static IEnumerable<XElement> StreamRootChildDoc(StringReader stringReader)
{
    using (XmlReader reader = XmlReader.Create(stringReader))
    {
        reader.MoveToContent();
        // Parse the file and display each of the nodes.
        while (reader.Read())
        {
            switch (reader.NodeType)
            {
                case XmlNodeType.Element:
                    if (reader.Name == "Child") {
                        XElement el = XElement.ReadFrom(reader) as XElement;
                        if (el != null)
                            yield return el;
                    }
                    break;
            }
        }
    }
}

static void Main(string[] args)
{
    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);
    }
}

Module Module1
    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 New 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

Public Class StreamRootChildDoc
    Implements IEnumerable(Of XElement)

    Private _stringReader As IO.StringReader

    Public Sub New(ByVal stringReader As IO.StringReader)
        _stringReader = stringReader
    End Sub

    Public Function GetEnumerator() As IEnumerator(Of XElement) Implements IEnumerable(Of XElement).GetEnumerator
        Return New StreamChildEnumerator(_stringReader)
    End Function

    Public Function GetEnumerator1() As IEnumerator Implements IEnumerable.GetEnumerator
        Return Me.GetEnumerator()
    End Function
End Class

Public Class StreamChildEnumerator
    Implements IEnumerator(Of XElement)

    Private _current As XElement
    Private _reader As Xml.XmlReader
    Private _stringReader As IO.StringReader

    Public Sub New(ByVal stringReader As IO.StringReader)
        _stringReader = stringReader
        _reader = Xml.XmlReader.Create(_stringReader)
        _reader.MoveToContent()
    End Sub

    Public ReadOnly Property Current As XElement Implements IEnumerator(Of XElement).Current
        Get
            Return _current
        End Get
    End Property

    Public ReadOnly Property Current1 As Object Implements IEnumerator.Current
        Get
            Return Me.Current
        End Get
    End Property

    Public Function MoveNext() As Boolean Implements IEnumerator.MoveNext
        While _reader.Read()
            Select Case _reader.NodeType
                Case Xml.XmlNodeType.Element
                    Dim el = TryCast(XElement.ReadFrom(_reader), XElement)
                    If el IsNot Nothing Then
                        _current = el
                        Return True
                    End If
            End Select
        End While

        Return False
    End Function

    Public Sub Reset() Implements IEnumerator.Reset
        _reader = Xml.XmlReader.Create(_stringReader)
        _reader.MoveToContent()
    End Sub

#Region "IDisposable Support"

    Private disposedValue As Boolean ' To detect redundant calls

    ' IDisposable
    Protected Overridable Sub Dispose(ByVal disposing As Boolean)
        If Not Me.disposedValue Then
            If disposing Then
                _reader.Close()
            End If
        End If
        Me.disposedValue = True
    End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        Dispose(True)
        GC.SuppressFinalize(Me)
    End Sub
#End Region

End Class

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