Jak streamovat fragmenty XML ze třídy XmlReader (LINQ to XML)

Pokud potřebujete zpracovat velké soubory XML, nemusí být možné načíst celý strom XML do paměti. Tento článek ukazuje, jak streamovat fragmenty pomocí jazyka XmlReader C# a Visual Basic.

Jedním z nejúčinnějších způsobů, jak použít XmlReader ke čtení XElement objektů, je napsat vlastní metodu osy. Metoda osy obvykle vrací kolekci, například IEnumerable<T>XElement, jak je znázorněno v příkladu v tomto článku. Ve vlastní osové metodě po vytvoření fragmentu XML voláním ReadFrom metody vraťte kolekci pomocí yield return. To poskytuje sémantiku odloženého spuštění pro vaši vlastní metodu osy.

Když vytvoříte strom XML z objektu XmlReader , XmlReader musí být umístěn na elementu. Metoda ReadFrom se nevrátí, dokud nepřečte značku uzavření elementu.

Pokud chcete vytvořit částečný strom, můžete vytvořit instanci XmlReaderobjektu , umístit čtenáře na uzel, který chcete převést na XElement strom, a pak vytvořit XElement objekt.

Článek Jak streamovat fragmenty XML s přístupem k informacím hlavičky obsahuje informace o streamování složitějšího dokumentu.

Článek Postup provedení streamované transformace velkých dokumentů XML obsahuje příklad použití LINQ to XML k transformaci extrémně velkých dokumentů XML při zachování malé paměti.

Příklad: Vytvoření vlastní metody osy

Tento příklad vytvoří vlastní metodu osy. Můžete ho dotazovat pomocí dotazu LINQ. Vlastní metoda StreamRootChildDoc osy může číst dokument, který má opakující se Child prvek.

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

Tento příklad vytvoří následující výstup:

bbb
ccc

Technika použitá v tomto příkladu udržuje malou paměťovou stopu i pro miliony Child prvků.

Viz také

• Analýza XML