Как построить документ XML в .NET

С помощью представлений XML, добавленных в SQL Server 2000 и в версию SQL Server 2000 Web releases (SQLXML), удобно работать с данными, которые хранятся в базе данных SQL Server, как будто эти представления есть часть виртуального документа XML. Ранее я описывал, как создавать аннотируемую схему XML Schema Definition (XSD) для построения представлений XML. Эти представления полезны, потому что выполняют иерархические запросы XPath по реляционным данным. Они делают это изящно, комбинируя данные в схеме преобразования данных запросом XPath, для генерации запроса SQL, который, в свою очередь, производит в результате XML.

Первоначально представления XML были единственной методикой для такого построения запросов. Но с выпуском Microsoft .NET Framework появилась возможность не только выполнять иерархические запросы по реляционным данным, но и управлять ими. Давайте рассмотрим, как можно использовать классы из ADO.NET, такие как DataSet и XMLDataDocument, чтобы произвести запрос XML для получения результата из реляционных данных.

Класс DataSet (набор данных)

Класс DataSet - это использующийся на стороне клиента кэш, который хранит данные в структуре, подобной структуре базы данных. То есть обеспечивает относительное представление в памяти по данным, воспроизводимым в локальной системе клиентской станции. Объект класса DataSet позволяет смоделировать данные, сохраняя их в наборе таблиц, которые представлены в классе DataTable и, используя ключевые поля и внешние ключевые поля, определять связи между таблицами, которые называются DataRelations.

Класс DataSet также позволяет строить связи между таблицами, используя для этого внешние ключевые поля, после того как доступ к данным получен. Эта операция концептуально подобна построению связей на SQL Server. Один из путей, которыми можно наполнять DataSet, состоит в том, чтобы использовать DataAdapter, являющийся посредником между источником данных (таких как SQL Server или документ XML) и объектом DataSet. Метод Fill объекта DataAdapter выполняет запрос к SQL Server, выбирает данные, затем вставляет данные в DataTables. Далее я расскажу о том, как объект класса DataAdapter выбирает данные непосредственно из XML-документа. Как мы видим, DataSet обеспечивает существование подобной родственной структуры в памяти, или, иначе говоря, кэширует данные. Объект этого класса также поддерживает реляционную объектную модель для доступа к данным подобную ADO, но данная тема не рассматривается в нашей статье.

Класс XMLDataDocument

Класс XMLDataDocument обеспечивает поддержку виртуальным документам XML, чье содержание будет определяться данными, хранящимися в объектах класса DataSet. Как и представлениям XML (SQLXML), классу XMLDataDocument требуется преобразование данных между реляционным хранением в DataSet и иерархической структурой документа XML, который обеспечивается классом XMLDataDocument. Это преобразование данных определяют следующие правила:

• Таблицы в классе dataset, которые я называю элементами таблицы, отображаются в документе XML с теми же именами;
• Столбцы отображаются в несложные субэлементы элементов таблицы;
• Класс DataRelation устанавливает связи между двумя таблицами, делая при этом элементы таблицы вложенными.

Класс XMLDataDocument - это подкласс класса XMLDocument, который обеспечивает модель программирования Document Object Model (DOM), модель для доступа и навигации по данным в виртуальном документе XML. DOM обеспечивает ориентированную на дерево модель программирования для документов XML, которые хранят данные в узлах дерева. Можно получить доступ к данным, хранящимся в узлах дерева, передвигаясь по связям родитель-потомок, предусмотренным в DOM, или через выполнение запросов Xpath по набору узлов, попадающих под условие запроса. Кроме того, поскольку DataSet и XMLDataDocument пользуются одной и тоже областью памяти, изменения, сделанные при использовании XMLDataDocument, отражаются в DataSet, и наоборот. Теперь, чтобы понять основы DataSet и XMLDataDocument, давайте рассмотрим пример того, как можно использовать эти классы, чтобы получить в результате запроса документ XML.

Выполнение запросов по виртуальным документам XML

Перед тем как погрузиться в изучение кода, давайте взглянем на сценарий, используемый для примера в этой статье. Предположим, что ваша компания нанимает третью фирму, которая работает с клиентами, разместившими у вас большие заказы. Внешняя фирма требует, чтобы вы послали им документ XML с информацией об уже размещенных заказах от клиентов. Каждый заказ включает в себя идентификатор заказа, дату размещения и общее количество заказов, отсортированных по уникальному идентификатору клиента.

Для того чтобы выполнить требования фирмы, нужно доработать программу так, чтобы программа могла подключаться к базе данных, извлекать данные и создавать документ XML. Пример использует типовую базу данных Northwind, которая поставляется с SQL Server. Я использую DataSet для хранения данных по клиенту и заказу, полученных от SQL Server, и XMLDataDocument - для того чтобы строить содержащий данные виртуальный документ XML. Я также применяю запрос, построенный на XPath, чтобы выбирать только тех клиентов, которые разместили, по крайней мере, один заказ общей стоимостью более $800. Для краткости, я показываю только подмножество от всего результата запроса. Теперь, держа этот сценарий в голове, давайте взглянем на текст кода.

В Листинге1 показан код, написанный для данного примера на C#. Единственный метод, Main, включает в себя всю программу. В метке А создается новый DataSet с названием CustOrder, затем добавляется два объекта DataTables с названиями Customer и Order. Названия, которые используются для DataSet и DataTables, соответствуют непосредственно названиям элементов в виртуальном документе XML, так что их нужно выбирать тщательно. В общем, следует выбрать единственное число в имени вместо множественного (например, "Клиент" вместо "Клиенты"), потому что элемент XML представляет отдельного клиента, а не набор клиентов, подобно строкам в DataTable.

В тексте кода в метке B создается и открывается соединение с базой данных Northwind. Следом создаются два объекта SQLCommand, с запросами, которые возвращают набор строк клиентов Customer и набор строк заказов Order из базы данных. Затем в метке C создается объект DataAdapters, который использует эти запросы для заполнения двух классов DataTables, созданных ранее в тексте кода в метке А.

После того как DataAdapters заполнил DataTables, создается объект класса DataRelation с именем CustOrder для связи между Customer и Order DataTables. Объект класса DataRelation задает, что эти две таблицы связанны через столбцы CustomerID. Выставляем свойство вложенности в состояние true, после чего XMLData Document создает виртуальный документ XML с вложенными в него клиентами (текст кода в метке D). На следующей строке кода происходит сохранение полного содержания виртуального документа XML в файл с названием result.xml.

Теперь, когда объект XMLDataDocument заполнен, можно воспользоваться запросом по данным Xpath. В метке E применяется метод SelectNodes в классе XMLDataDocument, чтобы выполнить запрос XPath, который возвращает заказы общей стоимостью более 800 долл. Метод SelectNodes возвращает список узлов - в данном случае элементов, которые соответствуют условию запроса.

Затем создается объект XmlTextWriter, который используется для того, чтобы записать XML в файл. Надо убедиться, что XML сформирован корректно, а именно, что он имеет единственный элемент корня, который содержит все остальные элементы. Для этого следует сначала использовать XmlTextWriter, который будет выводить элемент LargeOrders. Затем нужно записать каждый узел, выбирая его из запроса XPath и записывая в файл, используя метод узла WriteTo. Метод WriteTo записывает XML-отображение узла и всех его потомков. Как только все узлы записаны в выходной файл, закройте элемент корня и объект класса XmlTextWriter.

.NET XML. Результаты запросов

Классы DataSet и XMLDataDocument аналогичны базе SQL Server. Они преобразуют схемы, используемые программистами для обеспечения представлений XML. Однако, в отличие от представлений XML, которые не имеют объектной модели, классы DataSet и XMLDataDocument поддерживают реляционные и иерархические объектные модели, DataSet и XML DOM, которые можно использовать для управления данными или выполнять функциональную логику.

Использование классов DataSet и XMLDataDocument для генерации запроса XML обеспечивает дополнительную выгоду - сокращает загрузку SQL Server, перемещая создание результатов запроса XML на промежуточный уровень или на клиентскую станцию. Однако следует тщательно взвесить выгоды от генерации XML на клиенте или на логическом промежуточном уровне, если сравнивать их с затратами при извлечении большого количества данных из SQL Server в локальный кэш объекта класса DataSet. Если нужно сформировать документ XML из запроса, выполнить функциональную логику или перенести процедуру обработки с SQL Server, использование класса XMLDataDocument из .NET может оказаться оптимальным решением.

Рич Ролман - Руководил подразделением программистов, отвечавших за XML в команде, разрабатывавшей SQL Server 2000 в корпорации Microsoft. С ним можно связаться по адресу: xmlquestions@sqlmag.com.

Листинг 1: Код C#, запрашивающий XMLDataDocument

using System;
using System.Collections;
using System.Data;
using System.Data.SqlClient;
using System.Xml;
public class XMLView
{
  public static void Main()
  {
BEGIN CALLOUT A
   DataSet custOrderDS = new DataSet("CustOrder");
   DataTable custDT = custOrderDS.Tables.Add("Customer");
   DataTable orderDT = custOrderDS.Tables.Add("Order");
END CALLOUT A
BEGIN CALLOUT B
   // Connection string *** Change for your system. ***
   SqlConnection nwindConn =
     new SqlConnection("Data Source=localhost;Integrated Security=SSPI;Initial 
Catalog=northwind");
   nwindConn.Open();
   // Select a single customer and the corresponding orders.
   SqlCommand selectCustCMD =
     new SqlCommand("SELECT CustomerID, CompanyName FROM Customers WHERE 
CustomerID='ALFKI'", nwindConn);
   SqlCommand selectOrderCMD =
     new SqlCommand("SELECT o.CustomerID, o.OrderID, 
OrderDate, SUM(UnitPrice * Quantity) as OrderTotal " +
           "FROM Orders o JOIN [Order Details] od ON 
o.OrderID = od.OrderID " +
           "WHERE CustomerID='ALFKI' " +
           "GROUP BY CustomerID, o.OrderID, OrderDate", nwindConn);
END CALLOUT B
BEGIN CALLOUT C
   // Allocate DataAdapters and assign queries.
   SqlDataAdapter custDA = new SqlDataAdapter();
   custDA.SelectCommand = selectCustCMD;
   SqlDataAdapter orderDA = new SqlDataAdapter();
   orderDA.SelectCommand = selectOrderCMD;
   // Execute the queries to fill the DataTables.
   custDA.Fill(custDT);
   orderDA.Fill(orderDT);
   // Create a DataRelation to relate Customer and Order by using the CustomerID column.
   DataRelation custOrderDR = custOrderDS.Relations.Add("CustOrder",
                custOrderDS.Tables["Customer"].Columns["CustomerID"],
                custOrderDS.Tables["Order"].Columns["CustomerID"]);
   // Use hierarchical relationships in the XML.
   custOrderDR.Nested = true;
END CALLOUT C
BEGIN CALLOUT D
   // Build the XML view.
   XmlDataDocument xmlddoc = new XmlDataDocument(custOrderDS);
   // Save XML to file.
   xmlddoc.Save("result.xml");
END CALLOUT D
BEGIN CALLOUT E
   // Query for orders in years 1998 and later.
   XmlNodeList nl = xmlddoc.SelectNodes("//Customer[CustomerID='ALFKI']/Order[OrderTotal > 
800]");
   // Write list to file.
   XmlTextWriter xtw = new XmlTextWriter("LargeOrders.xml",null);
   xtw.Formatting = Formatting.Indented;
   xtw.WriteStartElement("","LargeOrders",""); // Write a root element.
   // Write each node returned by the XPath query to the output document.
   IEnumerator nle = nl.GetEnumerator();
   while (nle.MoveNext())
   {
     XmlNode node = (XmlNode) nle.Current;
     node.WriteTo(xtw);
   }
   xtw.WriteEndElement(); // Close the root element.
   xtw.Close();
END CALLOUT E
   nwindConn.Close();
   }
}

Источник: Osp.ru