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.

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

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