Cara melakukan streaming fragmen XML dari XmlReader (LINQ ke XML)

Ketika Anda harus memproses file XML besar, kemungkinan proses tersebut tidak memungkinkan untuk memuat seluruh pohon XML ke dalam memori. Artikel ini memperlihatkan cara melakukan streaming fragmen menggunakan XmlReader di C# dan Visual Basic.

Salah satu cara paling efektif untuk menggunakan XmlReader untuk membaca objek XElement adalah dengan menulis metode sumbu kustom milik Anda sendiri. Metode sumbu biasanya mengembalikan koleksi seperti IEnumerable<T> dari XElement, seperti yang ditunjukkan dalam contoh dalam artikel ini. Dalam metode sumbu kustom, setelah Anda membuat fragmen XML dengan memanggil metode ReadFrom, kembalikan koleksi menggunakan yield return. Ini memberikan semantik eksekusi yang ditangguhkan ke metode sumbu kustom Anda.

Saat Anda membuat pohon XML dari objek XmlReader, XmlReader harus diposisikan pada elemen. Metode ReadFrom ini tidak kembali sampai telah membaca tag tutup elemen.

Jika Anda ingin membuat pohon parsial, Anda dapat membuat instans XmlReader, memosisikan pembaca pada node yang ingin Anda konversi ke pohon XElement, lalu membuat objek XElement.

Artikel Cara mengalirkan fragmen XML dengan akses ke informasi header berisi informasi tentang streaming dokumen yang lebih kompleks.

Artikel Cara melakukan transformasi streaming dokumen XML besar berisi contoh penggunaan LINQ ke XML untuk mengubah dokumen XML yang sangat besar sambil mempertahankan jejak memori kecil.

Contoh: Membuat metode sumbu kustom

Contoh ini membuat metode sumbu kustom. Anda dapat memintanya dengan menggunakan kueri LINQ. Metode sumbu kustom StreamRootChildDoc dapat membaca dokumen yang memiliki elemen Child berulang.

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

Contoh ini menghasilkan output berikut:

bbb
ccc

Teknik yang digunakan dalam contoh ini mempertahankan jejak memori kecil bahkan untuk jutaan elemen Child.

Lihat juga

• Urai XML