VCL: Работа с XML-файлами при помощи XMLDocument. Основы

.
По работе столкнулся с необходимостью использования xml-файлов в одном из разрабатываемых приложений. Выбор соответствующих библиотек велик, но так как разработка ведется в IDE CodeGear RAD Studio 2009, то не хотелось в очередной раз замарачиваться с подключением библиотек импорта (*.lib файла для компиляторов Borland и VS отличаются). К тому же задачи передо мной стояли тривиальные: создать xml-файл, добавить в него секцию, суметь прочитать из него данные. В итоге остановил свой взгляд на входящем в библиотеку VCL компоненте TXMLDocument. Данный же топик, по сути, - краткий обзор компонента, если угодно, введение в суть вопроса. Все, что я буду описывать, можно найти с лихвой во встроенной в IDE системе помощи. Но Все же мы иногда ленимся … ;=)

Вобщем, тем кто желает задействовать мощь xml-документов в своем приложении и при этом работает в Borland Developer Studio или CodeGear RAD Studio топик может показаться интересным.

Итак, приступим.
Допустим, имеется xml-файл следующего содержания:

<?xml version="1.0" encoding="UTF-8" ?>

<users>

- <user uid="1">
    <name>Homer Simpson</name>
    <comment>Отец семейства</comment>
 </user>

- <user uid="2">
    <name>Marge Simpson</name>
    <comment>Красавица жена</comment>
 </user>

- <user uid="3">
    <name>Bart Simpson</name>
    <comment>Малолетний озорник</comment>
 </user>

- <user uid="4">
    <name>Lisa Simpson</name>
    <comment>Маленький гений</comment>
 </user>

</users>

* This source code was highlighted with Source Code Highlighter.

Рассмотрим, как :

• создать файл с такой структурой
• редактировать поля существующего файла
• добавлять новых пользователей
• считывать информацию из файла

Но прежде всего, пару вступительных слов о …

1.Создание объекта, инициализация и уничтожение:

В VCL имеется интерфейсный класс IXMLDocument, в котором и прописаны все методы для работы с XML-документами. Для языка С++ имя данного интерфейса заменяется на _di_IXMLDocument. Код в подтверждение тому:

typedef System::DelphiInterface<IXMLDocument> _di_IXMLDocument;


Компонент же TXMLDocument является ни чем иным, как реализацией интерфейса IXMLDocument.

Существует несколько способов создать объект, реализующий интерфейс IXMLDocument. Некоторые из них:

a). Использовать компонент TXMLDocument:

TXMLDocument *XMLDocument = new TXMLDocument( this );

Либо просто поместить одноименный компонент с вкладки Internet на одну из форм приложения.

b). Xmldoc::NewXMLDocument

Xmlintf::_di_IXMLDocument xmlDocument = Xmldoc::NewXMLDocument();

c). Xmldoc::LoadXMLDocument

Xmlintf::_di_IXMLDocument xmlDocument = Xmldoc:: LoadXMLDocument («D:\\db.xml»);

Как видим, в данном варианте одновременно с созданием объекта происходит парсинг указанного файла.


Для настройки поведения созданного объекта используются следующие свойства:

• NodeIndentStr – определяет строку-разделитель между вложенными узлами
• ParseOptions - определяет различные аспекты разбора (парсинга входного xml-файла
• Encoding – определяет кодировку XML-файла
• Version - определяет версию XML
• Options - определяет различные аспекты поведения документа
• DOMVendor - задает реализацию DOM, используемую для разбора входного xml-файла (имеются MSXML, Open XML, Xerces XML). Данное свойство имеется только у компонента TXMLDocument, и как задавать вендора (если и можно) для интерфейсных объектов я узнавать не стал.

Признаюсь честно, из всех перечисленных свойств, я воспользовался лишь свойством Encoding. Задачи у меня тривиальные и не требуют детальной настройки объекта.

Такс, что дальше…? Ах да, пишем же на С++, а значит не забываем про память, точнее ее очистку. И тут приятная новость – все уже сделано за нас.

Смотрите, если мы используем компонент TXMLDocument и при его создании передавали в конструктор указатель на родительскую форму (свойство Owner), то уничтожение компонента произойдет в момент уничтожения формы-родителя (это, вообщем-то, дефакто для VCL). Тут не важно как создавался компонент - с помощью drag-n-dropа на форму или ручками в коде, главное корректно установить свойство Owner (при drag-n-dropе это произойдет автоматически).

Если же мы используем интерфейсные объекты, полученные из методов NewXMLDocument, LoadXMLDocument, то освобождение ресурсов объекта произойдет автоматически, после закрытия (отвязки) всех ссылок на объект.


2. Создание xml-файла заданной структуры.

Следующий код создает xml-файл, рассмотренный выше.

1.  // получаем интерфейсный объект
2.  Xmlintf::_di_IXMLDocument m_xmlDocument = Xmldoc::NewXMLDocument();
3.  
4.  // указываем внутренную кодировку xml-файла
5.  m_xmlDocument->Encoding = "UTF-8";
6.  
7.  // создаем корневой узел (root node)
8.  // По стандарту XML - в документе может быть лишь один root node
9.  m_xmlDocument->AddChild( "users" );
10.  
11.  // внутренняя структура, представляющая пользовательские данные
12.  struct TUserInfo
13.  {
14.     int    Uid;          // id пользователя
15.     String Name;         // имя пользователя
16.     String Comment;      // другая информация о пользователе
17.     //..конструктор
18.     TUserInfo ( int _uid, String _name, String _comment ):
19.      Uid(_uid), Name(_name), Comment(_comment) {}
20.  };
21.  
22.  // данные о пользователях. Именно эти данные мы и должны записать в XML-документ
23.  int userUid = 1;
24.  TUserInfo arrUsers[] =
25.  {
26.     TUserInfo( userUid++, "Homer Simpson", "Отец семейства" ),
27.     TUserInfo( userUid++, "Marge Simpson", "Красавица жена" ),
28.     TUserInfo( userUid++, "Bart Simpson", "Малолетний озорник" ),
29.     TUserInfo( userUid++, "Lisa Simpson", "Маленький гений" )
30.  };
31.  
32.  // кол-во пользователей вычисляем динамически
33.  unsigned numUsers = sizeof(arrUsers) / sizeof(TUserInfo);
34.  
35.  // cоздаем узлы(секции) для каждого из пользователей
36.  for( unsigned i = 0; i < numUsers; i++ )
37.  {
38.     //..добавляем секцию-узел user
39.     IXMLNode *addingNode = m_xmlDocument->DocumentElement->AddChild( "user" );
40.  
41.     //..устанавливаем атрибут id для узла user
42.     addingNode->SetAttribute( "uid" , arrUsers[i].Uid );
43.  
44.     //..в секци user добавляем узел name
45.     addingNode->AddChild( "name" )->Text    = arrUsers[i].Name;
46.  
47.     //..в секцию user добавляем узел comment
48.     addingNode->AddChild( "comment" )->Text = arrUsers[i].Comment;
49.  }
50.  
51.  
52.  // сбрасываем произведенные изменения в XML-файл
53.  // Если файл существует, то будет перезаписен, иначе создан.
54.  m_xmlDocument->SaveToFile( "D:\\db.xml" );

* This source code was highlighted with Source Code Highlighter.

3. Считывание информации из существующего XML-файла с известной структурой

1.  // загружаем описание XML-файл
2.  m_xmlDocument->LoadFromFile( "D:\\db.xml" );
3.  
4.  // проверяем корректность корневого узла - он должен существоват и иметь имя "users"(case-sensitive)
5.  // DocumentElement - описание корневого узла
6.  if( m_xmlDocument->GetChildNodes()->Count < 1 ||
7.      m_xmlDocument->DocumentElement->LocalName != String("users")
8.     )
9.  {
10.     throw ( Exception("Отсутсвует корневая секция") );
11.  }
12.  
13.  // кол-во пользователей, описанных в XML-файле
14.  unsigned numUsers = m_xmlDocument->DocumentElement->GetChildNodes()->Count;
15.  
16.  // считываем информацию о кажом пользователе
17.  for( unsigned i = 0; i < numUsers; i++ )
18.  {
19.     //..получаем описание узла "user"
20.     IXMLNode *userNode = m_xmlDocument->DocumentElement->GetChildNodes()->Get(i);
21.  
22.     //..получаем uid пользователя. Если атрибута с таким именем нет, произойдет исключение
23.     int uid = userNode->GetAttribute("uid");
24.  
25.     //..получаем другие данные пользователя. Если атрибутов с таким именем нет, произойдет исключение
26.     String name    = userNode->GetChildNodes()->GetNode("name")->Text;
27.     String comment = userNode->GetChildNodes()->GetNode("comment")->Text;
28.  }

* This source code was highlighted with Source Code Highlighter.

Если xml-файл, во время работы вашей программы меняется внешней средой, и вам надо учитывать эти изменения, то на помощь приходит свойство Active. При выставление данного свойства в true, происходит перезагрузка xml-файла (файл заново парсится) и загружается в DOM, после чего мы можем работать с данными через интерфейсный объект IXMLDocument. При присваивании же свойству Active значений false, все хранимые в объекте данные (DOM) уничтожаются. Может чего понял и неправильно, буду рад если кто поправит.

m_xmlDocument->Active = true; // перезагружаем xml-файл в DOM

// … работаем с данными, находящимися в m_xmlDocument (DOM)

m_xmlDocument->Active = false; // данные в m_xmlDocument (DOM) теряются



Не смущайтесь, что мы не задействовали свойство Active в предыдущем листинге. Там оно автоматически выставится в true в момент вызова метода LoadFromFile.


4. Редактирование существующих записей, добавление новых.

Не думаю, что есть смысл приводить код для данных операций. По сути, создавая XML-файл, мы занимались добавлением новых пользователей. А редактирование существующих записей (узлов) – это тоже считывание xml-файла известной структуры, но с изменением левого и правого операндов:

userNode->GetChildNodes()->GetNode("name")->Text = name

Отмечу лишь, что все производимые изменения, окажутся на диске только после вызова метода SaveToFile.

m_xmlDocument->SaveToFile( "D:\\db.xml" );

5. Исключения

Будьте готовы, что практически каждый метод интерфейса IXMLDocument может сгенерировать исключение: отсутствие файла на диске, отсутствие запрашиваемого узла и др. Более того, как показала практика, часть исключений совершенна неинформативна и скорее всего придется писать свои обертки для пользовательской логики.