Streamování fragmentů XML s přístupem k informacím hlavičky (LINQ to XML)

Někdy musíte číst libovolně velké soubory XML a zapisovat aplikaci tak, aby nároky na paměť aplikace byly předvídatelné. Pokud se pokusíte naplnit strom XML velkým souborem XML, bude využití paměti úměrné velikosti souboru – to znamená nadměrné. Proto byste měli místo toho použít techniku streamování.

Jednou z možností je napsat aplikaci pomocí XmlReader. K dotazování stromu XML ale můžete chtít použít LINQ. Pokud ano, můžete napsat vlastní metodu osy. Další informace naleznete v tématu Jak napsat metodu osy LINQ to XML.

Pokud chcete napsat vlastní metodu osy, napíšete malou metodu, která používá XmlReader uzly pro čtení, dokud nedosáhne jednoho z uzlů, které vás zajímají. Metoda pak volá ReadFrom, který čte z XmlReader a vytvoří instanci fragmentu XML. Pak provede každý fragment yield return metodou, která vytvoří výčet vlastní metody osy. Potom můžete napsat dotazy LINQ na vlastní metodu osy.

Techniky streamování se nejlépe používají v situacích, kdy potřebujete zpracovat zdrojový dokument pouze jednou a můžete zpracovat prvky v pořadí dokumentu. Některé standardní operátory dotazů, například OrderByiterace jejich zdroje, shromažďují všechna data, seřadí je a nakonec vyvolají první položku v sekvenci. Pokud použijete operátor dotazu, který před vydáním první položky materializuje jeho zdroj, nezachovají se malé nároky na paměť.

Příklad: Implementace a použití vlastní metody osy, která streamuje fragmenty XML ze souboru určeného identifikátorem URI

Někdy se problém stává trochu zajímavější. V následujícím dokumentu XML musí příjemce vlastní metody osy také znát název zákazníka, ke kterému každá položka patří.

<?xml version="1.0" encoding="utf-8" ?>
<Root>
  <Customer>
    <Name>A. Datum Corporation</Name>
    <Item>
      <Key>0001</Key>
    </Item>
    <Item>
      <Key>0002</Key>
    </Item>
    <Item>
      <Key>0003</Key>
    </Item>
    <Item>
      <Key>0004</Key>
    </Item>
  </Customer>
  <Customer>
    <Name>Fabrikam, Inc.</Name>
    <Item>
      <Key>0005</Key>
    </Item>
    <Item>
      <Key>0006</Key>
    </Item>
    <Item>
      <Key>0007</Key>
    </Item>
    <Item>
      <Key>0008</Key>
    </Item>
  </Customer>
  <Customer>
    <Name>Southridge Video</Name>
    <Item>
      <Key>0009</Key>
    </Item>
    <Item>
      <Key>0010</Key>
    </Item>
  </Customer>
</Root>

Tento příklad používá také sledování informací o této hlavičce, uložení informací v záhlaví a vytvoření malého stromu XML, který obsahuje informace o záhlaví i podrobnosti, které vytváříte. Metoda osy pak získá tento nový malý strom XML. Dotaz pak má přístup k informacím v hlavičce a také k podrobným informacím.

Tento přístup má malou paměťovou stopu. Vzhledem k tomu, že každý podrobný fragment XML je výnosný, žádné odkazy se neuchovávají na předchozí fragment a jsou k dispozici pro uvolňování paměti. Tato technika vytváří na haldě mnoho krátkodobých objektů.

Následující příklad ukazuje, jak implementovat a použít vlastní osovou metodu, která streamuje fragmenty XML ze souboru určeného identifikátorem URI. Tato vlastní osa je napsána tak, aby očekávala dokument, který obsahuje Customer, Namea Item prvky a že tyto prvky budou uspořádány jako v předchozím Source.xml dokumentu. Jedná se o zjednodušenou implementaci. Robustnější implementace by byla připravena analyzovat neplatný dokument.

static IEnumerable<XElement> StreamCustomerItem(string uri)
{
    using XmlReader reader = XmlReader.Create(uri);

    reader.MoveToContent();

    // Parse the file, save header information when encountered, and yield the
    // Item XElement objects as they're created.

    // Loop through Customer elements
    do
    {
        if (reader.NodeType == XmlNodeType.Element && reader.Name == "Customer")
        {
            // Move to Name element
            XElement? name = null;
            do
            {
                if (reader.NodeType == XmlNodeType.Element && reader.Name == "Name")
                {
                    name = XNode.ReadFrom(reader) as XElement;
                    break;
                }
            }
            while (reader.Read());

            // Loop through Item elements
            while (reader.NodeType != XmlNodeType.EndElement)
            {
                if (reader.NodeType == XmlNodeType.Element && reader.Name == "Item")
                {
                    if (XNode.ReadFrom(reader) is XElement item && name != null)
                    {
                        XElement tempRoot = new XElement("Root",
                            new XElement(name),
                            item
                        );
                        yield return item;
                    }
                }
                else if (!reader.Read())
                    break;
            }
        }
    }
    while (reader.Read());
}

static void Main(string[] args)
{
    XElement xmlTree = new XElement("Root",
        from el in StreamCustomerItem("Source.xml")
        where (int)el.Element("Key") >= 3 && (int)el.Element("Key") <= 7
        select new XElement("Item",
            new XElement("Customer", (string)el.Parent.Element("Name")),
            new XElement(el.Element("Key"))
        )
    );
    Console.WriteLine(xmlTree);
}

Imports System.Xml

Module Module1

    Public Iterator Function StreamCustomerItem(uri As String) As IEnumerable(Of XElement)
        Using reader As XmlReader = XmlReader.Create(uri)
            reader.MoveToContent()

            ' Parse the file, save header information when encountered, And yield the
            ' Item XElement objects as they're created.

            ' Loop through Customer elements
            Do

                If reader.NodeType = XmlNodeType.Element And reader.Name = "Customer" Then

                    ' Move to Name element
                    Dim name As XElement = Nothing
                    Do
                        If reader.NodeType = XmlNodeType.Element And reader.Name = "Name" Then

                            name = TryCast(XNode.ReadFrom(reader), XElement)
                            Exit Do

                        End If

                    Loop While reader.Read()

                    ' Loop through Item elements
                    While reader.NodeType <> XmlNodeType.EndElement

                        If reader.NodeType = XmlNodeType.Element And reader.Name = "Item" Then

                            Dim item = TryCast(XNode.ReadFrom(reader), XElement)

                            If name IsNot Nothing AndAlso item IsNot Nothing Then

                                Dim tempRoot = <Root>
                                                   <Name><%= name.Value %></Name>
                                                   <%= item %>
                                               </Root>

                                Yield item

                            End If

                        ElseIf Not reader.Read() Then
                            Exit While
                        End If

                    End While

                End If

            Loop While reader.Read()

        End Using
    End Function

    Sub Main()
        Dim xmlTree = <Root>
                          <%=
                              From el In StreamCustomerItem("Source.xml")
                              Let itemKey = CInt(el.<Key>.Value)
                              Where itemKey >= 3 AndAlso itemKey <= 7
                              Select <Item>
                                         <Customer><%= el.Parent.<Name>.Value %></Customer>
                                         <%= el.<Key> %>
                                     </Item>
                          %>
                      </Root>

        Console.WriteLine(xmlTree)
    End Sub

End Module

Výsledkem tohoto kódu je následující výstup:

<Root>
  <Item>
    <Customer>A. Datum Corporation</Customer>
    <Key>0003</Key>
  </Item>
  <Item>
    <Customer>A. Datum Corporation</Customer>
    <Key>0004</Key>
  </Item>
  <Item>
    <Customer>Fabrikam, Inc.</Customer>
    <Key>0005</Key>
  </Item>
  <Item>
    <Customer>Fabrikam, Inc.</Customer>
    <Key>0006</Key>
  </Item>
  <Item>
    <Customer>Fabrikam, Inc.</Customer>
    <Key>0007</Key>
  </Item>
</Root>