Как создать поток XML-фрагментов из XmlReader
При необходимости обработать большой XML-файл загрузка в память полного XML-дерева, возможно, будет неосуществима. В этом разделе показано, как обрабатывать фрагменты в потоке с помощью XmlReader.
Одним из самых эффективных способов использования XmlReader для чтения объектов XElement является написание собственного метода оси. Метод оси, как правило, возвращает коллекцию, например IEnumerable элементов XElement, как показано в примере этого раздела. В пользовательском методе оси после создания XML-фрагмента с помощью вызова метода ReadFrom возвратите коллекцию, используя yield return. Тем самым в пользовательском методе оси обеспечивается семантика отложенного выполнения.
При создании XML-дерева из объекта XmlReader модулю чтения XmlReader должен быть указан обрабатываемый элемент. Метод ReadFrom не выполняет возврат до тех пор, пока не считает закрывающий тег элемента.
Если нужно создать частичное дерево, можно создать экземпляр XmlReader, указать для модуля чтения узел, который должен быть преобразован в дерево XElement, и создать объект XElement.
Раздел Как создать поток XML-фрагментов с доступом к сведениям заголовка содержит сведения о потоковой обработке более сложного документа и пример такой обработки.
Раздел Как выполнять потоковое преобразование больших XML-документов содержит пример использования LINQ to XML для преобразования чрезвычайно больших XML-документов при сохранении небольшой потребности в памяти.
Пример
В следующем примере создается пользовательский метод оси. Его можно запрашивать с помощью запроса LINQ. Пользовательский метод оси StreamRootChildDoc специально разработан для чтения документа с повторяющимся элементом Child.
Примечание
В следующем примере используется конструкция yield return языка C#.В языке Visual Basic предусмотрен эквивалентный код, в котором используется класс, реализующий интерфейс IEnumerable(Of XElement).Пример реализации интерфейса IEnumerable(Of T) на языке Visual Basic см. в разделе Пошаговое руководство. Реализация IEnumerable(Of T) в Visual Basic.
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
В этом примере выводятся следующие данные:
bbb
ccc
В этом примере документ-источник весьма невелик. Тем не менее, даже если бы он содержал миллионы элементов Child, для этого примера потребовался бы очень небольшой объем памяти.