Difference between revisions of "XML Tutorial/de"

From Free Pascal wiki
Jump to navigationJump to search
m (→‎Füllen eines TreeView mit XML: Fehler im Beispiel-Code (Zugriff auf Attribute))
m (Text replace - "<xml>" to "<syntaxhighlight lang="xml">")
Line 18: Line 18:
 
Wenn Sie mit TXMLDocument arbeiten, ist zu beachten, dass der Text innerhalb eines Knotens ein separater Textknoten ist. Deshalb müssen Sie auf den Text eines Knotens als separaten Knoten zugreifen. Gehen Sie zum Beispiel von folgender XML-Datei aus:
 
Wenn Sie mit TXMLDocument arbeiten, ist zu beachten, dass der Text innerhalb eines Knotens ein separater Textknoten ist. Deshalb müssen Sie auf den Text eines Knotens als separaten Knoten zugreifen. Gehen Sie zum Beispiel von folgender XML-Datei aus:
  
<xml>
+
<syntaxhighlight lang="xml">
 
  <?xml version="1.0"?>
 
  <?xml version="1.0"?>
 
  <request>
 
  <request>
Line 50: Line 50:
 
Unterhalb sehen Sie die XML-Datei namens 'C:\Programas\teste.xml':
 
Unterhalb sehen Sie die XML-Datei namens 'C:\Programas\teste.xml':
  
<xml>
+
<syntaxhighlight lang="xml">
 
  <?xml version="1.0"?>
 
  <?xml version="1.0"?>
 
  <images directory="mydir">
 
  <images directory="mydir">
Line 220: Line 220:
 
Hier ist ein kleines Beispiel einer XML-Datei mit interner DTD:
 
Hier ist ein kleines Beispiel einer XML-Datei mit interner DTD:
  
<xml>
+
<syntaxhighlight lang="xml">
 
   <?xml version='1.0'?>
 
   <?xml version='1.0'?>
 
   <!DOCTYPE root [
 
   <!DOCTYPE root [
Line 355: Line 355:
  
 
Das Ergebnis steht in folgender XML-Datei:
 
Das Ergebnis steht in folgender XML-Datei:
<xml><?xml version="1.0"?>
+
<syntaxhighlight lang="xml"><?xml version="1.0"?>
 
<register>
 
<register>
 
   <usuario id="001">
 
   <usuario id="001">

Revision as of 11:11, 24 March 2012

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)

Einleitung

Die Extensible Markup Language ist eine von W3C empfohlene Sprache, die für den Informationsaustausch zwischen verschiedenen Systemen geschaffen wurde. Sie ist eine textbasierte Möglichkeit, um Informationen zu speichern. Moderne Datenaustauschsprachen wie XHTML, ebenso wie die meisten WebServices Technologien, basieren auf XML.

Gegenwärtig gibt es eine Reihe von Units, die XML unter Free Pascal unterstützen. Diese Units sind "XMLRead", "XMLWrite" und "DOM" und sind ein Teil der Free Component Library (FCL) des Free Pascal Compilers. Die FCL ist bereits im Standard-Suchpfad für den Compiler in Lazarus. Daher müssen Sie nur die Units zu Ihrem uses Abschnitt hinzufügen, um die XML Unterstützung zu erhalten. Die FCL ist gegenwärtig (Oktober 2005) noch nicht dokumentiert. Daher hat dieses kurze Tutorial das Ziel, einen Einstieg in XML unter Verwendung dieser Units zu bieten.

Das XML DOM (Document Object Model) ist eine Reihe standardisierter Objekte, die eine ähnliche Schnittstelle für die Benutzung von XML für verschiedene Sprachen und Systeme bieten. Der Standard spezifiziert nur die Methoden, Eigenschaften und andere Schnittstellen Teile des Objekts. Die Implementierung in verschiedenen Sprachen ist frei gelassen. Die FCL unterstützt gegenwärtig vollständig das XML DOM 1.0.

Beispiele

Unten finden Sie eine Liste von Beispielen zur XML-Datenmanipulation mit wachsender Komplexität.

Lesen eines Textknotens

Für Delphi Programmierer: Wenn Sie mit TXMLDocument arbeiten, ist zu beachten, dass der Text innerhalb eines Knotens ein separater Textknoten ist. Deshalb müssen Sie auf den Text eines Knotens als separaten Knoten zugreifen. Gehen Sie zum Beispiel von folgender XML-Datei aus:

<syntaxhighlight lang="xml">

<?xml version="1.0"?>
<request>
  <request_type>PUT_FILE</request_type>
  <username>123</username>
  <password>abc</password>
</request>

</xml>

Das folgende Code-Beispiel zeigt sowohl den richtigen als auch den falschen Weg, um den Wert eines Textknotens zu erhalten:

<delphi>

var
 PassNode: TDOMNode;
 Doc:      TXMLDocument;
begin
 // Einlesen der xml Datei
 ReadXMLFile(Doc, 'c:\xmlfiles\test.xml');
 // Abrufen des "password" Knotens
 PassNode := Doc.DocumentElement.FindNode('password');
 // Ausgeben des Wertes des gewählten Knotens
 WriteLn(PassNode.NodeValue); // wird leer sein
 // Der Text des Knotens ist ein separater Kindknoten
 WriteLn(PassNode.FirstChild.NodeValue); // gibt "abc" korrekt aus

</delphi>

Ausgeben der Knotennamen

Das folgende Beispiel zeigt, wie man die Knotennamen in einem Memo (platziert auf einem Formular) ausgibt.

Unterhalb sehen Sie die XML-Datei namens 'C:\Programas\teste.xml':

<syntaxhighlight lang="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>

Und hier der Pascal Code um die Aufgabe auszuführen:

<delphi>

var
  Documento: TXMLDocument;
  i, j: Integer;
begin
  ReadXMLFile(Documento, 'C:\Programas\teste.xml');
  Memo.Lines.Clear;
  with Documento.DocumentElement.ChildNodes do
  begin
    for i := 0 to (Count - 1) do
    begin
      Memo.Lines.Add(Item[i].NodeName + ' ' + Item[i].Attributes.Item[0].NodeValue);
      for j := 0 to (Item[i].ChildNodes.Count - 1) do
      begin
        Memo.Lines.Add(Item[i].ChildNodes.Item[j].NodeName + ' '
         + Item[i].ChildNodes.Item[j].FirstChild.NodeValue);
      end;
    end;
  end;
  Documento.Free;
end;

</delphi>

Dies führt zur Ausgabe von:

imageNode graphic.jpg
Peca Pecacastelo.jpg1.swf
Peca Pecacastelo.jpg1.swf

Füllen eines TreeView mit XML

Eine übliche Verwendung von XML Dateien ist, sie zu analysieren und ihren Inhalt in einem baumartigen Format anzuzeigen. Sie können die TTreeView-Komponente auf dem "Common Controls" Tab von Lazarus finden.

Die Funktion unten nimmt ein zuvor geladenes oder im Code erzeugtes XML-Dokument und füllt einen TreeView mit seinen Inhalten. Die Beschriftung jedes Knotens ist der Inhalt des ersten Attributs eines jeden Knotens.

<delphi> procedure TForm1.XML2Tree(tree: TTreeView; XMLDoc: TXMLDocument); var

 iNode: TDOMNode;
 procedure ProcessNode(Node: TDOMNode; TreeNode: TTreeNode);
 var
   cNode: TDOMNode;
 begin
   if Node = nil then Exit; // Aufhören, wenn ein Blatt erreicht ist
   
   // Einen Knoten zum Baum hinzufügen
   if Node.HasAttributes then
       TreeNode := tree.Items.AddChild(TreeNode, Node.Attributes[0].NodeValue)
   else
       TreeNode := tree.Items.Addchild(TreeNode, );
   // Zum Kindknoten weiter gehen
   cNode := Node.ChildNodes.Item[0];
   // Alle Kindknoten bearbeiten
   while cNode <> nil do
   begin
     ProcessNoDe(cNode, TreeNode);
     cNode := cNode.NextSibling;
   end;
 end;
   

begin

 iNode := XMLDoc.DocumentElement.ChildNodes.Item[0];
 while iNode <> nil do
 begin
   ProcessNode(iNode, nil); // Rekursiv
   iNode := iNode.NextSibling;
 end;

end; </delphi>

Modifizieren eines XML-Dokuments

Das wichtigste, was man sich merken muss ist, dass 'TDOMDocument' das "Handle" für DOM ist. Eine Instanz dieser Klasse erhält man, indem man eine erzeugt oder indem man ein XML-Dokument lädt.

Dagegen können Knoten nicht wie normale Objekte erzeugt werden. Man muss die Methoden von TDOMDocument für die Erzeugung verwenden und sie danach mit anderen Methoden an die richtige Stelle zu bringen. Der Grund dafür ist, dass die Knoten einem speziellen Dokument auf DOM gehören müssen.

Nachfolgend sind einige gebräuchliche Methoden von 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>

Und jetzt eine Beispielsmethode, die das ausgewählte Element auf einem TTreeView lokalisiert und einen Kindknoten in das entsprechende XML-Dokument einfügt. Der TreeView muss vorher mit den Inhalten einer XML-Datei unter Verwendung der XML2Tree Funktion gefüllt werden.

<delphi> procedure TForm1.actAddChildNode(Sender: TObject); var

 Posicao: Integer;
 NovoNo: TDomNode;

begin

 {*******************************************************************
 *  Ausgewähltes Element bestimmen
 *******************************************************************}
 if TreeView1.Selected = nil then Exit;
 if TreeView1.Selected.Level = 0 then
 begin
   Posicao := TreeView1.Selected.Index;
   NovoNo := XMLDoc.CreateElement('item');
   TDOMElement(NovoNo).SetAttribute('nome', 'Item');
   TDOMElement(NovoNo).SetAttribute('arquivo', 'Arquivo');
   XMLDoc.DocumentElement.ChildNodes.Item[Posicao].AppendChild(NovoNo);
   {*******************************************************************
   *  Den TreeView updaten
   *******************************************************************}
   TreeView1.Items.Clear;
   XML2Tree(TreeView1, XMLDoc);
 end
 else if TreeView1.Selected.Level >= 1 then
 begin
   {*******************************************************************
   *  Diese Funktion bearbeitet nur eine Ebene des Baumes,
   *  kann aber leicht so geändert werden, dass eine beliebige Anzahl von Ebenen bearbeitet wird.
   *******************************************************************}
 end;

end; </delphi>

Erzeugen eines TXMLDocument aus einem String

Ist eine XML-Datei in MyXmlString gegeben, erzeugt der folgende Code Ihre DOM:

<delphi> Var

 S : TStringStream;
 XML : TXMLDocument;

begin

 S:= TStringStream.Create(MyXMLString);
 Try
   S.Position:=0;
   XML:=Nil;
   ReadXMLFile(XML,S); // Komplettes XML-Dokument
   // Alternativ:
   ReadXMLFragment(AParentNode,S); // Nur das XML-Fragment lesen.
 Finally
   S.Free;
 end;

end; </delphi>

Überprüfen der Gültigkeit der Struktur einer XML-Datei

Seit März 2007 besitzt der FCL XML-Parser die Fähigkeit ein XML-Dokument anhand einer DTD zu überprüfen. Dabei wird überprüft, ob die logische Struktur des Dokumentes mit vordefinierten Regeln aus einer Document Type Definition (DTD) übereinstimmt. Diese Technik wird auch bei Webseiten mit HMTL angewendet.

Hier ist ein kleines Beispiel einer XML-Datei mit interner DTD:

<syntaxhighlight lang="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>

Diese DTD legt als 'root' als Wurzelelement fest. Dieses Wurzelelement muss mindestens ein Kindelement mit dem Namen 'child' besitzen. Diese 'child'-Elemente dürfen nur Buchstaben (PCHDATA = parsed character data, verarbeite Buchstaben-Daten) enthalten. Wenn der Parser irgendwelche Abweichungen gegenüber diesen Regeln feststellt, wird er diese melden.

Durch das Überprüfen der Dokumentstruktur ist das Laden der XML-Datei etwas komplizierter. In diesem Beispiel können wir auf die XML-Datei über ein TStream-Objekt zugreifen:

<delphi>procedure TMyObject.DOMFromStream(AStream: TStream); var

 Parser: TDOMParser;
 Src: TXMLInputSource;
 TheDoc: TXMLDocument;

begin

 try
   // ein neues Parserobjekt erstellen
   Parser := TDOMParser.Create;
   // die XML-Datei muss über ein TXMLInputSource-Objekt geladen werden
   Src := TXMLInputSource.Create(AStream);
   // wir wollen eine Überprüfung der Dokumentstruktur
   Parser.Options.Validate := True;
   // Festlegen einer Methode, die bei Fehlern aufgerufen wird
   Parser.OnError := @ErrorHandler;
   // nun beginnen wir die Überprüfung
   Parser.Parse(Src, TheDoc);
   // ... und räumen hinterher wieder auf
 finally
   Src.Free;
   Parser.Free;
 end;

end;

procedure TMyObject.ErrorHandler(E: EXMLReadError); begin

 if E.Severity = esError then  // wir sind nur in Fehlern bezüglich der Verletzung der DTD interessiert
   writeln(E.Message);
 // an dieser Stelle können wir auch alles andere machen, was bei einem Fehler getan werden sollte

end;</delphi>

Whitespace-Zeichen

Wenn Sie führende Whitespace-Zeichen in den Knotentexten erhalten wollen, dann ist obige Methode der richtige Weg zum Laden Ihres Dokuments. Führende Whitespace-Zeichen werden standardgemäß ignoriert. Dies ist der Grund, warum die Funktion 'ReadXML(...)' niemals die Whitespace-Zeichen in Knotentexten zurückgibt. Vor dem Aufruf von Parser.Parse(Src, TheDoc) fügen Sie folgende Zeile ein:

<delphi>Parser.Options.PreserveWhitespace := True;</delphi>

Dadurch zwingt man den Parser dazu, alle Whitespace-Zeichen zu übergeben. Dies schließt auch alle Zeilenendezeichen ein, die in einem XML-Dokument nur zur besseren Lesbarkeit stehen!

Erzeugen einer XML-Datei

Nachfolgend ist der komplette Code für das Schreiben in eine XML-Datei. (Er wurde einem Tutorial des DeveLazarus-Blogs entnommen.) Bitte denken Sie an den Verweis auf die Bibliotheken DOM und XMLWrite in der 'uses'-Klausel.

<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

 Doc: TXMLDocument;                                         // Variable für das Dokument
 RootNode, parentNode, nofilho: TDOMNode;                   // Variable für die Elemente (Knoten)

begin

 try
   // Erzeuge ein Dokument
   Doc := TXMLDocument.Create;
   // Erzeuge einen Wurzelknoten
   RootNode := Doc.CreateElement('register');
   Doc.Appendchild(RootNode);                               // sichere den Wurzelelement   
   // Create a parent node
   RootNode:= Doc.DocumentElement;
   parentNode := Doc.CreateElement('usuario');
   TDOMElement(parentNode).SetAttribute('id', '001');       // erzeuge die Attribute für das Elternelement
   RootNode.Appendchild(parentNode);                        // sichere das Elternelement
   // Create a child node
   parentNode := Doc.CreateElement('nome');                 // erzeuge einen Kindelement
   // TDOMElement(parentNode).SetAttribute('sexo', 'M');    // erzeuge die Attribute
   nofilho := Doc.CreateTextNode('Fernando');               // füge einen Wert für den Knoten ein
   parentNode.Appendchild(nofilho);                         // sichere den Knoten
   RootNode.ChildNodes.Item[0].AppendChild(parentNode);     // füge das Kindelement in das Elternelement ein

   // Create a child node
   parentNode := Doc.CreateElement('idade');                // erzeuge einen Kindelement
   // TDOMElement(parentNode).SetAttribute('ano', '1976');  // erzeuge die Attribute
   nofilho := Doc.CreateTextNode('32');                     // füge einen Wert für den Knoten ein
   parentNode.Appendchild(nofilho);                         // sichere den Knoten
   RootNode.ChildNodes.Item[0].AppendChild(parentNode);     // füge das Kindelement in das Elternelement ein
   writeXMLFile(Doc, 'test.xml');                           // schreibe in die XML-Datei
 finally
   Doc.Free;                                                // gib den Speicher frei
 end;

end;

initialization

 {$I unit1.lrs}

end.</delphi>

Das Ergebnis steht in folgender XML-Datei: <syntaxhighlight lang="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

Encoding

Seit der SVN Revision 12582, ist der XML-Reader fähig, Daten in einer beliebigen Kodierung zu verarbeiten durch den Einsatz externer Dekoder. Siehe XML_Decoders für weitere Details.

Nach den XML-Standards ist das Encoding-Attribut in der ersten Zeile einer XML-Datei optional, falls die tatsächliche Kodierung UTF-8 oder UTF-16 ist (was durch Vorhandensein des BOM erkannt wird). In Lazarus Version 0.9.26 hat TXMLDocument eine Eigenschaft Encoding, die aber momentan ignoriert wird. writeXMLFile benutzt immer UTF-8 und erzeugt kein Encoding-Attribut in der ersten Zeile der XML-Datei.

Siehe auch

Externe Links