Jak przesyłać strumieniowo fragmenty kodu XML z elementu XmlReader (LINQ to XML)

Gdy musisz przetworzyć duże pliki XML, załadowanie całego drzewa XML do pamięci może nie być możliwe. W tym artykule pokazano, jak przesyłać strumieniowo fragmenty przy użyciu kodu w języku XmlReader C# Visual Basic.

Jednym z najbardziej skutecznych sposobów używania obiektu do odczytywania obiektów jest XmlReader XElement napisanie własnej metody osi niestandardowej. Metoda osi zwykle zwraca kolekcję, taką jak IEnumerable<T> XElement , jak pokazano w przykładzie w tym artykule. W metodzie osi niestandardowej po utworzeniu fragmentu XML przez wywołanie metody ReadFrom zwróć kolekcję przy użyciu metody yield return . Zapewnia to semantykę wykonywania odroczonego dla metody osi niestandardowej.

Podczas tworzenia drzewa XML na podstawie XmlReader obiektu obiekt musi być umieszczony na XmlReader elemencie. Metoda ReadFrom nie zwraca elementu , dopóki nie odczyta tagu zamknięcia elementu.

Jeśli chcesz utworzyć drzewo częściowe, możesz utworzyć wystąpienia obiektu , umieścić czytnik w węźle, który chcesz przekonwertować na drzewo, a następnie XmlReader utworzyć obiekt XElement XElement .

Artykuł How to stream XML fragments with access to header information (Jak przesyłać strumieniowo fragmenty kodu XML z dostępem do informacji nagłówka) zawiera informacje dotyczące przesyłania strumieniowego bardziej złożonego dokumentu.

Artykuł How to perform streaming transform of large XML documents (Jak wykonać przesyłanie strumieniowe dużych dokumentów XML) zawiera przykład użycia funkcji LINQ to XML do przekształcania bardzo dużych dokumentów XML przy zachowaniu małego zużycie pamięci.

Przykład: tworzenie niestandardowej metody osi

Ten przykład tworzy niestandardową metodę osi. Zapytania o nie można ćlić za pomocą zapytania LINQ. Metoda osi StreamRootChildDoc niestandardowej może odczytać dokument, który ma powtarzający się Child element.

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

Ten przykład generuje następujące wyniki:

bbb
ccc

Technika używana w tym przykładzie zachowuje niewielkie zużycie pamięci nawet dla milionów Child elementów.

Zobacz też