Difference between revisions of "XML Tutorial/ru"
Line 11: | Line 11: | ||
== Примеры == | == Примеры == | ||
− | + | В статье даны примеры работы с XML-данными по принципу нарастающей сложностьи. | |
=== Чтение текстового узла === | === Чтение текстового узла === | ||
Line 19: | Line 19: | ||
Помните, что когда Вы работаете с TXMLDocument, текст в пределах узла считается '''отдельным текстовым узлом'''. Таким образом, Вы должны обратиться к текстовому значению узла, как к отдельному узлу. Альтернативно, свойство '''TextContent''' может быть использовано для возврата значения всех узлов лежащих ниже, которые связаны с данным. | Помните, что когда Вы работаете с TXMLDocument, текст в пределах узла считается '''отдельным текстовым узлом'''. Таким образом, Вы должны обратиться к текстовому значению узла, как к отдельному узлу. Альтернативно, свойство '''TextContent''' может быть использовано для возврата значения всех узлов лежащих ниже, которые связаны с данным. | ||
− | Процедура '''ReadXMLFile''' всегда создаёт новый '''TXMLDocument''', таким образом Вы не должны создавать его заранее. Однако Вы должны вызывать | + | Процедура '''ReadXMLFile''' всегда создаёт новый '''TXMLDocument''', таким образом Вы не должны создавать его заранее. Однако Вы должны вызывать метод '''Free''' вручную после окончания работы с документом для освобождения ресурсов занятых объектом '''TXMLDocument'''. |
− | Для примера рассмотрим следующий XML: | + | Для примера рассмотрим следующий XML-файл: |
<xml> | <xml> | ||
Line 43: | Line 43: | ||
// Запрашиваем узел с именем "password" | // Запрашиваем узел с именем "password" | ||
PassNode := Doc.DocumentElement.FindNode('password'); | PassNode := Doc.DocumentElement.FindNode('password'); | ||
− | // Выводим значение выбранного узла | + | // Выводим значение выбранного узла |
+ | //Неправильный способ | ||
WriteLn(PassNode.NodeValue); // вывод будет пустым | WriteLn(PassNode.NodeValue); // вывод будет пустым | ||
+ | //Правильный способ | ||
// Текст узла - это отдельный дочерний узел | // Текст узла - это отдельный дочерний узел | ||
WriteLn(PassNode.FirstChild.NodeValue); // правильно выведет "abc" | WriteLn(PassNode.FirstChild.NodeValue); // правильно выведет "abc" | ||
− | // | + | // Альтернативный способ |
WriteLn(PassNode.TextContent); | WriteLn(PassNode.TextContent); | ||
− | // В завершении делаем Free | + | // В завершении делаем Free для документа |
Doc.Free; | Doc.Free; | ||
end; | end; | ||
Line 58: | Line 60: | ||
Маленькое замечание о навигации по дереву DOM: | Маленькое замечание о навигации по дереву DOM: | ||
− | Когда вам нужен последовательный доступ к узлам, лучшим решением будет использование свойства '''FirstChild''' и '''NextSibling''' (чтобы шагать вперед по дереву) или '''LastChild''' и '''PreviousSibling''' (назад с конца дерева). Для свободного доступа к элементам дерева можно пользоваться | + | Когда вам нужен последовательный доступ к узлам, лучшим решением будет использование свойства '''FirstChild''' и '''NextSibling''' (чтобы шагать вперед по дереву) или '''LastChild''' и '''PreviousSibling''' (назад с конца дерева). Для свободного доступа к элементам дерева можно пользоваться свойством '''ChildNodes''' или методом '''GetElementsByTagName''', но это создаст объект TDOMNodeList, который в конце его использования должен быть освобождён. Этот метод отличается от других DOM реализаций, таких к примеру как MSXML, поскольку FCL реализация базируется на объектах, а не на интерфейсе. |
Следующий пример демонстрирует, как выводить имена узлов в компонент TMemo, расположенный на форме. | Следующий пример демонстрирует, как выводить имена узлов в компонент TMemo, расположенный на форме. | ||
− | Ниже приведён XML файл с именем 'C:\Programs\test.xml': | + | Ниже приведён XML-файл с именем 'C:\Programs\test.xml': |
<xml> | <xml> | ||
Line 89: | Line 91: | ||
begin | begin | ||
Memo.Lines.Add(Child.NodeName + ' ' + Child.Attributes.Item[0].NodeValue); | Memo.Lines.Add(Child.NodeName + ' ' + Child.Attributes.Item[0].NodeValue); | ||
− | // Используем | + | // Используем свойство ChildNodes |
with Child.ChildNodes do | with Child.ChildNodes do | ||
try | try | ||
Line 113: | Line 115: | ||
=== Загрузка XML в TreeView === | === Загрузка XML в TreeView === | ||
− | Одно из обычных использований файла XML - разбор и показ информации в | + | Одно из обычных использований файла XML - разбор и показ информации в древовидном формате. Вы можете отыскать компонент TTreeView на вкладке "Common Controls" Lazarus'а. |
− | Функция, приведённая ниже, возмёт документ XML, предварительно загруженный из файла или сгенерированный программно, и заполнит TreeView его содержимым. Заголовком каждого узла будет содержимое первого | + | Функция, приведённая ниже, возмёт документ XML, предварительно загруженный из файла или сгенерированный программно, и заполнит TreeView его содержимым. Заголовком каждого узла будет содержимое первого атрибута этого узла. |
<delphi> | <delphi> | ||
Line 161: | Line 163: | ||
Первая вещь, о которой следует помнить, TDOMDocument это хэндл (handle) к DOM. Вы можете получить экземпляр этого класса создавая или загружая XML документ. | Первая вещь, о которой следует помнить, TDOMDocument это хэндл (handle) к DOM. Вы можете получить экземпляр этого класса создавая или загружая XML документ. | ||
− | С другой стороны, узлы не могут быть созданы как | + | С другой стороны, узлы не могут быть созданы как обычные объекты. Вы должны использовать методы, которые предоставляет TDOMDocument для их создания и, впоследствии, использовать другие методы для помещения их в нужное место дерева. Это говорит о том, что узлы должны принадлежать вполне определённому документу DOM. |
Вот некоторые общераспространённые методы TDOMDocument: | Вот некоторые общераспространённые методы TDOMDocument: | ||
Line 173: | Line 175: | ||
</delphi> | </delphi> | ||
− | Вот, в качестве примера, метод, который ищет | + | Вот, в качестве примера, метод, который ищет выбранный элемент в TTreeView и затем вставляет дочерний узел в документ XML, где он должен находиться . TreeView должен быть предварительно заполнен содержанием из XML файла, используя [[Networking#Populating a TreeView with XML|XML2Tree function]]. |
<delphi> | <delphi> | ||
Line 240: | Line 242: | ||
=== Проверка достоверности документа === | === Проверка достоверности документа === | ||
− | + | Начиная с марта 2007, средство проверки правильности DTD было включено в FCL XML парсер. Проверка правильности проверяет, соответствует ли логическая структура документа предопределенным правилам, названным "Определение Типа документа" (DTD). | |
− | + | Это пример документа XML вместе с DTD: | |
<xml> | <xml> | ||
Line 256: | Line 258: | ||
</xml> | </xml> | ||
− | + | Этот DTD определяет, что у 'корневого' элемента должны быть один или более 'дочерних' элементов и что у 'дочерних' элементов могут быть только символьные данные внутри. Если синтаксический анализатор обнаружит какие-нибудь нарушения этих правил, то он сообщит о них. | |
− | + | Загрузка такого документа немного более сложна. Давайте предположим, что у нас есть данные XML в объекте TStream: | |
<delphi> | <delphi> | ||
Line 267: | Line 269: | ||
TheDoc: TXMLDocument; | TheDoc: TXMLDocument; | ||
begin | begin | ||
− | // | + | // Создаём объект-парсер |
Parser := TDOMParser.Create; | Parser := TDOMParser.Create; | ||
− | // | + | // и источник данных |
Src := TXMLInputSource.Create(AStream); | Src := TXMLInputSource.Create(AStream); | ||
− | // | + | // Включаем проверку правильности |
Parser.Options.Validate := True; | Parser.Options.Validate := True; | ||
− | // | + | // Назначаем обработчик ошибок, который будет получать уведомления о них |
Parser.OnError := @ErrorHandler; | Parser.OnError := @ErrorHandler; | ||
− | // | + | // А теперь работаем |
Parser.Parse(Src, TheDoc); | Parser.Parse(Src, TheDoc); | ||
− | // ... | + | // ... и убираем за собой :) |
Src.Free; | Src.Free; | ||
Parser.Free; | Parser.Free; | ||
Line 284: | Line 286: | ||
procedure TMyObject.ErrorHandler(E: EXMLReadError); | procedure TMyObject.ErrorHandler(E: EXMLReadError); | ||
begin | begin | ||
− | if E.Severity = esError then // | + | if E.Severity = esError then // Нас интересуют только ошибки проверки правильности |
writeln(E.Message); | writeln(E.Message); | ||
end; | end; |
Revision as of 05:47, 17 January 2010
│
Deutsch (de) │
English (en) │
español (es) │
français (fr) │
magyar (hu) │
Bahasa Indonesia (id) │
italiano (it) │
日本語 (ja) │
한국어 (ko) │
português (pt) │
русский (ru) │
中文(中国大陆) (zh_CN) │
Введение
XML - Расширяемый Язык Разметки (eXtensible Markup Language) рекомендован W3C как язык для обмена информацией между различными системами. Это ориентированный на текст способ сохранения информации. Современные языки обмена данными, такие как XHTML, так же как и большинство технологий WebServices, основаны на XML.
В настоящее время в Free Pascal существует ряд модулей для поддержки XML. Эти модули называются "XMLRead", "XMLWrite" и "DOM", и являются частью Free Component Library (FCL) из компилекта Free Pascal. FCL уже находится в заданном по умолчанию пути поиска файлов для компилятора в Лазарусе, таким образом Вам нужно только добавить названия модулей в строку USES чтобы получить поддержку XML в Вашей программе. Использование XML пока не документировано, поэтому данная статья даёт необходимые вводные сведения для работы с модулями поддержки XML.
DOM XML (Объектная модель документов) - это ряд стандартизированных объектов, которые предоставляют однотипный интерфейс для использования XML в различных языках и платформах. Стандарт определяет только методы, свойства и другие части интерфейса объекта, оставляя реализацию свободной для различных языков. FCL в настоящее время поддерживает полностью DOM 1.0.
Примеры
В статье даны примеры работы с XML-данными по принципу нарастающей сложностьи.
Чтение текстового узла
Для Delphi-программистов:
Помните, что когда Вы работаете с TXMLDocument, текст в пределах узла считается отдельным текстовым узлом. Таким образом, Вы должны обратиться к текстовому значению узла, как к отдельному узлу. Альтернативно, свойство TextContent может быть использовано для возврата значения всех узлов лежащих ниже, которые связаны с данным.
Процедура ReadXMLFile всегда создаёт новый TXMLDocument, таким образом Вы не должны создавать его заранее. Однако Вы должны вызывать метод Free вручную после окончания работы с документом для освобождения ресурсов занятых объектом TXMLDocument.
Для примера рассмотрим следующий XML-файл:
<xml>
<?xml version="1.0"?> <request> <request_type>PUT_FILE</request_type> <username>123</username> <password>abc</password> </request>
</xml>
Следующий пример показывает корректный и некорректный способы получения значений текстового узла xml:
<delphi>
var PassNode: TDOMNode; Doc: TXMLDocument; begin // Читаем xml файл с жесткого диска ReadXMLFile(Doc, 'c:\xmlfiles\test.xml'); // Запрашиваем узел с именем "password" PassNode := Doc.DocumentElement.FindNode('password'); // Выводим значение выбранного узла //Неправильный способ WriteLn(PassNode.NodeValue); // вывод будет пустым //Правильный способ // Текст узла - это отдельный дочерний узел WriteLn(PassNode.FirstChild.NodeValue); // правильно выведет "abc" // Альтернативный способ WriteLn(PassNode.TextContent); // В завершении делаем Free для документа Doc.Free;
end; </delphi>
Вывод названий узлов
Маленькое замечание о навигации по дереву DOM:
Когда вам нужен последовательный доступ к узлам, лучшим решением будет использование свойства FirstChild и NextSibling (чтобы шагать вперед по дереву) или LastChild и PreviousSibling (назад с конца дерева). Для свободного доступа к элементам дерева можно пользоваться свойством ChildNodes или методом GetElementsByTagName, но это создаст объект TDOMNodeList, который в конце его использования должен быть освобождён. Этот метод отличается от других DOM реализаций, таких к примеру как MSXML, поскольку FCL реализация базируется на объектах, а не на интерфейсе.
Следующий пример демонстрирует, как выводить имена узлов в компонент TMemo, расположенный на форме.
Ниже приведён XML-файл с именем 'C:\Programs\test.xml':
<xml>
<?xml version="1.0"?> <images directory="mydir"> <imageNode URL="graphic.jpg" title=""> <Peca DestinoX="0" DestinoY="0">Pecacastelo.jpg1.swf</Peca> <Peca DestinoX="0" DestinoY="86">Pecacastelo.jpg2.swf</Peca> </imageNode> </images>
</xml>
И код на Pascal, который выполняет эту задачу:
<delphi>
var Documento: TXMLDocument; Child: TDOMNode; j: Integer; begin ReadXMLFile(Documento, 'C:\Programas\teste.xml'); Memo.Lines.Clear; // Используем свойства FirstChild и NextSibling Child := Documento.DocumentElement.FirstChild; while Assigned(Child) do begin Memo.Lines.Add(Child.NodeName + ' ' + Child.Attributes.Item[0].NodeValue); // Используем свойство ChildNodes with Child.ChildNodes do try for j := 0 to (Count - 1) do Memo.Lines.Add(Item[j].NodeName + ' ' + Item[j].FirstChild.NodeValue); finally Free; end; Child := Child.NextSibling; end; Documento.Free; end;
</delphi>
В результате программа выведет следующее:
imageNode graphic.jpg Peca Pecacastelo.jpg1.swf Peca Pecacastelo.jpg1.swf
Загрузка XML в TreeView
Одно из обычных использований файла XML - разбор и показ информации в древовидном формате. Вы можете отыскать компонент TTreeView на вкладке "Common Controls" Lazarus'а.
Функция, приведённая ниже, возмёт документ XML, предварительно загруженный из файла или сгенерированный программно, и заполнит TreeView его содержимым. Заголовком каждого узла будет содержимое первого атрибута этого узла.
<delphi> procedure TForm1.XML2Tree(tree: TTreeView; XMLDoc: TXMLDocument); var
iNode: TDOMNode;
procedure ProcessNode(Node: TDOMNode; TreeNode: TTreeNode); var cNode: TDOMNode; s: string; begin if Node = nil then Exit; // выходим, если достигнут конец документа // добавляем узел в дерево if Node.HasAttributes and (Node.Attributes.Length>0) then s:=Node.Attributes[0].NodeValue else s:=; TreeNode := tree.Items.AddChild(TreeNode, s);
// переходим к дочернему узлу cNode := Node.FirstChild;
// проходим по всем дочерним узлам while cNode <> nil do begin ProcessNode(cNode, TreeNode); cNode := cNode.NextSibling; end; end;
begin
iNode := XMLDoc.DocumentElement.FirstChild; while iNode <> nil do begin ProcessNode(iNode, nil); // Рекурсия iNode := iNode.NextSibling; end;
end; </delphi>
Изменение XML документа
Первая вещь, о которой следует помнить, TDOMDocument это хэндл (handle) к DOM. Вы можете получить экземпляр этого класса создавая или загружая XML документ.
С другой стороны, узлы не могут быть созданы как обычные объекты. Вы должны использовать методы, которые предоставляет TDOMDocument для их создания и, впоследствии, использовать другие методы для помещения их в нужное место дерева. Это говорит о том, что узлы должны принадлежать вполне определённому документу DOM.
Вот некоторые общераспространённые методы TDOMDocument:
<delphi>
function CreateElement(const tagName: DOMString): TDOMElement; virtual; function CreateTextNode(const data: DOMString): TDOMText; function CreateCDATASection(const data: DOMString): TDOMCDATASection; virtual; function CreateAttribute(const name: DOMString): TDOMAttr; virtual;
</delphi>
Вот, в качестве примера, метод, который ищет выбранный элемент в TTreeView и затем вставляет дочерний узел в документ XML, где он должен находиться . TreeView должен быть предварительно заполнен содержанием из XML файла, используя XML2Tree function.
<delphi> procedure TForm1.actAddChildNode(Sender: TObject); var
position: Integer; NovoNo: TDomNode;
begin
{******************************************************************* * Определение выбраного элемента *******************************************************************} if TreeView1.Selected = nil then Exit;
if TreeView1.Selected.Level = 0 then begin position := TreeView1.Selected.Index;
NovoNo := XMLDoc.CreateElement('item'); TDOMElement(NovoNo).SetAttribute('nome', 'Item'); TDOMElement(NovoNo).SetAttribute('arquivo', 'Arquivo'); with XMLDoc.DocumentElement.ChildNodes do begin Item[position].AppendChild(NovoNo); Free; end;
{******************************************************************* * Обновление TreeView *******************************************************************} TreeView1.Items.Clear; XML2Tree(TreeView1, XMLDoc); end else if TreeView1.Selected.Level >= 1 then begin {******************************************************************* * Эта функция работает только на верхнем уровне дерева * и вы должны её модефицировать, чтобы использовать другие уровни *******************************************************************} end;
end; </delphi>
Создание TXMLDocument из обычного текста
Дан файл XML в MyXmlString, следующий код создаёт из него DOM:
<delphi> Var
S : TStringStream; XML : TXMLDocument;
begin
S:= TStringStream.Create(MyXMLString); Try S.Position:=0; XML:=Nil; ReadXMLFile(XML,S); // XML документ целиком // Альтернативно: ReadXMLFragment(AParentNode,S); // Читаем только XML фрагмент. Finally S.Free; end;
end; </delphi>
Проверка достоверности документа
Начиная с марта 2007, средство проверки правильности DTD было включено в FCL XML парсер. Проверка правильности проверяет, соответствует ли логическая структура документа предопределенным правилам, названным "Определение Типа документа" (DTD).
Это пример документа XML вместе с DTD:
<xml>
<?xml version='1.0'?> <!DOCTYPE root [ <!ELEMENT root (child)+ > <!ELEMENT child (#PCDATA)> ]> <root> <child>This is a first child.</child> <child>And this is the second one.</child> </root>
</xml>
Этот DTD определяет, что у 'корневого' элемента должны быть один или более 'дочерних' элементов и что у 'дочерних' элементов могут быть только символьные данные внутри. Если синтаксический анализатор обнаружит какие-нибудь нарушения этих правил, то он сообщит о них.
Загрузка такого документа немного более сложна. Давайте предположим, что у нас есть данные XML в объекте TStream:
<delphi> procedure TMyObject.DOMFromStream(AStream: TStream); var
Parser: TDOMParser; Src: TXMLInputSource; TheDoc: TXMLDocument;
begin
// Создаём объект-парсер Parser := TDOMParser.Create; // и источник данных Src := TXMLInputSource.Create(AStream); // Включаем проверку правильности Parser.Options.Validate := True; // Назначаем обработчик ошибок, который будет получать уведомления о них Parser.OnError := @ErrorHandler; // А теперь работаем Parser.Parse(Src, TheDoc); // ... и убираем за собой :) Src.Free; Parser.Free;
end;
procedure TMyObject.ErrorHandler(E: EXMLReadError); begin
if E.Severity = esError then // Нас интересуют только ошибки проверки правильности writeln(E.Message);
end; </delphi>
Генерация файла XML
Below is the complete code to write in a XML file. (This was taken from a tutorial in DeveLazarus blog ) Please, remember DOM and XMLWrite libs in uses clause
<delphi> unit Unit1;
{$mode objfpc}{$H+}
interface
uses
Classes, SysUtils, LResources, Forms, Controls, Graphics, Dialogs, StdCtrls, DOM, XMLWrite;
type
{ TForm1 } TForm1 = class(TForm) Button1: TButton; Label1: TLabel; Label2: TLabel; procedure Button1Click(Sender: TObject); private { private declarations } public { public declarations } end;
var
Form1: TForm1;
implementation
{ TForm1 }
procedure TForm1.Button1Click(Sender: TObject); var
xdoc: TXMLDocument; // variable to document RootNode, parentNode, nofilho: TDOMNode; // variable to nodes
begin
//create a document xdoc := TXMLDocument.create;
//create a root node RootNode := xdoc.CreateElement('register'); Xdoc.Appendchild(RootNode); // save root node
//create a parent node RootNode:= xdoc.DocumentElement; parentNode := xdoc.CreateElement('usuario'); TDOMElement(parentNode).SetAttribute('id', '001'); // create atributes to parent node RootNode.Appendchild(parentNode); // save parent node
//create a child node parentNode := xdoc.CreateElement('nome'); // create a child node //TDOMElement(parentNode).SetAttribute('sexo', 'M'); // create atributes nofilho := xdoc.CreateTextNode('Fernando'); // insert a value to node parentNode.Appendchild(nofilho); // save node RootNode.ChildNodes.Item[0].AppendChild(parentNode); // insert child node in respective parent node
//create a child node parentNode := xdoc.CreateElement('idade'); // create a child node //TDOMElement(parentNode).SetAttribute('ano', '1976'); // create atributes nofilho := xdoc.CreateTextNode('32'); // insert a value to node parentNode.Appendchild(nofilho); // save node .ChildNodes.Item[0].AppendChild(parentNode); // insert a childnode in respective parent node
writeXMLFile(xDoc,'teste.xml'); // write to XML Xdoc.free; // free memory
end;
initialization
{$I unit1.lrs}
end. </delphi>
The result will be the XML file below: <xml> <?xml version="1.0"?> <register>
<usuario id="001"> <nome>Fernando</nome> <idade>32</idade> </usuario>
</register> </xml>
--Fernandosinesio 22:28, 24 April 2008 (CEST)fernandosinesio@gmail.com
Кодировки
Starting from SVN revision 12582, XML reader is able to process data in any encoding by using external decoders. See XML_Decoders for more details.
According to the XML standard, the encoding attribute in the first line of the XML is optional in case the actual encoding is UTF-8 or UTF-16 (which is detected by presence of the BOM). As of version 0.9.26 of Lazarus, there is an encoding property in a TXMLDocument, but it is ignored. writeXMLFile always uses UTF-8 and doesn´t generate an encoding attribute in first line of the XML file.
Дополнительные ссылки
- W3Schools Xml Tutorial
- Thomas Zastrow article FPC and XML