首先我得承認,我喜歡電腦標準。如果每個人都遵從這個產業的標準,網際網路將會是一個更好的媒體。唯有使用標準化的資料交換格式,才能使開放且獨立於平台的運算模式切實可行,這正是我身為 XML 愛好者的原因。
所幸,我最鍾愛的腳本語言不但支援 XML,對它的支援還在不斷加強。PHP 能讓我迅速把 XML 文件發布到網路上、收集 XML 文件的統計資訊,並將 XML 文件轉換成其他格式。舉例來說,我時常用 PHP 的 XML 處理能力,來管理我用 XML 撰寫的文章與書籍。
本文將討論如何用 PHP 內建的 Expat 解析器來處理 XML 文件。透過範例,我會示範 Expat 的處理方式,並說明如何:建立自己的處理函數,以及把 XML 文件轉換成自己的 PHP 資料結構。
XML 的解析器(也稱為 XML 處理器)能讓程式存取 XML 文件的結構與內容。Expat 是 PHP 腳本語言的 XML 解析器,同時也運行於其他專案中,例如 Mozilla、Apache 與 Perl。
XML 解析器有兩種基本類型:
● 以樹為基礎的解析器:把 XML 文件轉換成樹狀結構,這類解析器分析整篇文章,並提供一個 API 來存取所產生樹的每個元素,其通用標準為 DOM(文件物件模型)。
● 以事件為基礎的解析器:把 XML 文件視為一連串的事件,當某個特殊事件發生時,解析器便呼叫開發者提供的函數來處理。
以事件為基礎的解析器有一個 XML 文件資料集導向的視角,也就是說,它聚焦於 XML 文件的資料部分,而非其結構。這類解析器從頭到尾處理文件,並把類似「元素開始」、「元素結束」、「資料開始」等事件,透過回呼(callback)函數報告給應用程式。以下是一個「Hello-World」的 XML 文件範例:
<greeting> Hello World </greeting>以事件為基礎的解析器會把它報告為三個事件:
開始元素:greeting
CDATA 項的開始,值為:Hello World
結束元素:greeting
不像以樹為基礎的解析器,以事件為基礎的解析器不會產生描述文件結構的資訊。在 CDATA 項中,它不會讓你取得父元素 greeting 的資訊;然而,它提供了更底層的存取,因而能更充分地利用資源、更快速地存取。透過這種方式,就沒有必要把整個文件載入記憶體——事實上,整個文件甚至可以大於實際的記憶體容量。
Expat 正是這樣一種以事件為基礎的解析器。當然,必要時它一樣能在 PHP 中生成完整的原生樹結構。
上面 Hello-World 的範例包含了完整的 XML 格式,但它是無效的,因為既沒有 DTD(文件類型定義)與之連結,也沒有內嵌 DTD。不過對 Expat 而言,這並無差別:Expat 是一個不檢查有效性的解析器,因此會忽略任何與文件連結的 DTD。但應注意,文件仍需格式完整,否則 Expat(以及其他符合 XML 標準的解析器)將會隨著錯誤訊息而停止。作為不檢查有效性的解析器,Expat 的快速與輕巧,使它十分適合網際網路程式。
Expat 可以編譯進 PHP 3.0.6 版本(含)以上。從 Apache 1.3.9 開始,Expat 已作為 Apache 的一部分。在 Unix 系統中,可透過 --with-xml 選項設定 PHP,將其編譯入 PHP;若把 PHP 編譯為 Apache 的模組,Expat 則預設作為 Apache 的一部分。在 Windows 中,你則必須載入 XML 動態連結庫。
了解 Expat 函數的一個辦法,就是透過範例。我們要討論的範例,是用 Expat 來收集 XML 文件的統計資料。對於文件中的每個元素,都會輸出以下資訊:
該元素在文件中被使用的次數
該元素中字元資料的數量
元素的父元素
元素的子元素
注意:為了示範,我們利用 PHP 產生一個結構,來保存元素的父元素與子元素。
用於產生 XML 解析器實例的函數為 xml_parser_create()。該實例將用於後續的所有函數,這個思路非常類似於 PHP 中 MySQL 函數的連線標記。在解析文件前,以事件為基礎的解析器通常要求你先註冊回呼函數——在特定事件發生時呼叫。Expat 也不例外,它定義了如下七個可能事件:
物件/XML 解析函數/描述
元素/xml_set_element_handler()/元素的開始與結束
字元資料/xml_set_character_data_handler()/字元資料的開始
外部實體/xml_set_external_entity_ref_handler()/外部實體出現
未解析外部實體/xml_set_unparsed_entity_decl_handler()/未解析的外部實體出現
處理指令/xml_set_processing_instruction_handler()/處理指令的出現
記法聲明/xml_set_notation_decl_handler()/記法聲明的出現
預設/xml_set_default_handler()/其他沒有指定處理函數的事件
所有的回呼函數都必須把解析器的實例作為其第一個參數(此外還有其他參數)。
對於本文最後的範例腳本,你需要注意的是,它既用到了元素處理函數,也用到了字元資料處理函數。元素的回呼處理函數透過 xml_set_element_handler() 來註冊,這個函數需要三個參數:解析器的實例、處理開始元素的回呼函數名稱,以及處理結束元素的回呼函數名稱。當開始解析 XML 文件時,回呼函數必須存在,且須定義為與 PHP 手冊中所描述的原型一致。
例如,Expat 會把三個參數傳給開始元素的處理函數。在腳本範例中,其定義如下:
function start_element($parser, $name, $attrs)第一個參數是解析器標示,第二個參數是開始元素的名稱,第三個參數則為包含元素所有屬性與值的陣列。一旦開始解析 XML 文件,Expat 在遇到開始元素時便會呼叫你的 start_element() 函數,並把參數傳過去。
用 xml_parser_set_option() 函數把 Case folding 選項關閉。這個選項預設是開啟的,會使傳給處理函數的元素名稱自動轉換為大寫。但 XML 對大小寫是敏感的(因此大小寫對統計 XML 文件非常重要),所以對於我們的範例,必須關閉 Case folding 選項。
完成所有準備工作後,腳本終於可以解析 XML 文件了:
xml_parse_from_file()(一個自訂函數)會開啟參數中指定的檔案,並以 4KB 的大小逐段解析。
xml_parse() 與 xml_parse_from_file() 一樣,當發生錯誤(即 XML 文件格式不完整)時,會傳回 false。
你可以用 xml_get_error_code() 函數取得最後一個錯誤的數字代碼,把此代碼傳給 xml_error_string() 函數,即可得到錯誤的文字訊息。
輸出 XML 目前的行號,使除錯更容易。
在解析的過程中,呼叫回呼函數。
解析文件時,Expat 有一個需要強調的問題:如何保持文件結構的基本描述?如前所述,以事件為基礎的解析器本身並不產生任何結構資訊。
不過,標籤(tag)結構是 XML 的重要特性。例如,元素序列 <book><title> 的意思,不同於 <figure><title>——也就是說,任何作者都會告訴你,書名與圖名是毫不相干的,儘管它們都用到「title」這個術語。因此,為了更有效地以事件為基礎的解析器處理 XML,你必須用自己的堆疊(stacks)或清單(lists)來維護文件的結構資訊。
為了產生文件結構的鏡像,腳本至少需要知道目前元素的父元素。用 Expat 的 API 是無法做到的,因為它只報告目前元素的事件,而沒有任何上下文資訊,因此你需要建立自己的堆疊結構。
腳本範例使用先進後出(FILO)的堆疊結構。透過一個陣列,堆疊會保存全部的開始元素:對於開始元素處理函數,目前的元素會被 array_push() 函數推到堆疊頂部;相對地,結束元素處理函數則透過 array_pop() 把最頂的元素移走。
對於序列 <book><title></title></book>,堆疊的填充如下:
開始元素 book:把「book」賦給堆疊的第一個元素($stack[0])。
開始元素 title:把「title」賦給堆疊的頂部($stack[1])。
結束元素 title:從堆疊中把最頂部的元素移去($stack[1])。
結束元素 book:從堆疊中把最頂部的元素移去($stack[0])。
PHP 3.0 透過一個 $depth 變數手動控制元素的嵌套來實作範例,這使腳本看起來較為複雜;PHP 4.0 則透過 array_pop() 與 array_push() 兩個函數,使腳本看起來更簡潔。
為了收集每個元素的資訊,腳本需要記住每個元素的事件。透過使用一個全域陣列變數 $elements 來保存文件中所有不同的元素,陣列的項目是元素類別的實例,有四個屬性(類別的變數):
$count-該元素在文件中被發現的次數
$chars-元素中字元事件的位元組數
$parents-父元素
$childs-子元素
如你所見,把類別實例保存在陣列中是輕而易舉的。注意:PHP 有個特性,你可以透過 while(list() = each()) 迴圈遍歷整個類別結構,如同你遍歷整個相應的陣列一樣;所有的類別變數(當你用 PHP 3.0 時還有方法名)都以字串的方式輸出。
當發現一個元素時,我們需要增加其相應的計數器,以追蹤它在文件中出現多少次;同時,在相應的 $elements 項中的計數元素也要加一。我們同樣要讓父元素知道目前的元素是它的子元素,因此,目前元素的名稱會被加入父元素的 $childs 陣列項目中;最後,目前元素應記住誰是它的父元素,所以父元素會被加入目前元素的 $parents 陣列項目中。
剩下的程式碼,在 $elements 陣列及其子陣列中循環,顯示其統計結果。這就是最簡單的嵌套循環,儘管輸出結果正確,但程式碼既不簡潔,也沒有什麼特別的技巧,它僅是一個你每天可能用來完成工作的循環。
腳本範例被設計為透過 PHP 的 CGI 方式,從命令列呼叫,因此統計結果以文字格式輸出。若要把腳本運用到網路上,你就需要修改輸出函數,以產生 HTML 格式。
Expat 是 PHP 的 XML 解析器。作為以事件為基礎的解析器,它不產生文件的結構描述,但透過提供底層存取,使資源利用更充分、存取更快速。作為一個不檢查有效性的解析器,Expat 忽略與 XML 文件連結的 DTD,但若文件格式不完整,它仍會隨著錯誤訊息而停止。
● 提供事件處理函數來處理文件。
● 建立自己的事件結構(例如堆疊與樹),以獲得 XML 結構資訊標記的優點。
每天都有新的 XML 程式出現,而 PHP 對 XML 的支援也不斷加強(例如增加了支援以 DOM 為基礎的 XML 解析器 LibXML)。有了 PHP 與 Expat,你就能為即將到來的有效、開放且獨立於平台的標準做好準備。
<?php
/*****************************************************************************
* 名稱:XML 解析範例:XML 文件資訊統計
* 描述
* 本範例透過 PHP 的 Expat 解析器收集並統計 XML 文件的資訊(例如:每個元素出現的次數、父元素與子元素)
* XML 文件作為一個參數 ./XMLstats.php4 test.xml
* $Requires: Expat 要求:Expat、PHP4.0 編譯為 CGI 模式
*****************************************************************************/
// 第一個參數是 XML 文件
$file = $argv[1];
// 變數的初始化
$elements = $stack = array();
$total_elements = $total_chars = 0;
// 元素的基本類別
class element
{
var $count = 0;
var $chars = 0;
var $parents = array();
var $childs = array();
}
// 解析 XML 文件的函數
function XML_parse_from_file($parser, $file)
{
if(!file_exists($file))
{
die("Can't find file \"$file\".");
}
if(!($fp = @fopen($file, "r")))
{
die("Can't open file \"$file\".");
}
while($data = fread($fp, 4096))
{
if(!xml_parse($parser, $data, feof($fp)))
{
return(false);
}
}
fclose($fp);
return(true);
}
// 輸出結果函數(方框形式)
function print_box($title, $value)
{
printf("\n+%-60s+\n", "");
printf("|%20s", "$title:");
printf("%14s", $value);
printf("%26s|\n", "");
printf("+%-60s+\n", "");
}
// 輸出結果函數(行形式)
function print_line($title, $value)
{
printf("%20s", "$title:");
printf("%15s\n", $value);
}
// 排序函數
function my_sort($a, $b)
{
return(is_object($a) && is_object($b) ? $b->count - $a->count: 0);
}
function start_element($parser, $name, $attrs)
{
global $elements, $stack;
// 元素是否已在全域 $elements 陣列中?
if(!isset($elements[$name]))
{
// 否-增加一個元素的類別實例
$element = new element;
$elements[$name] = $element;
}
// 該元素的計數器加一
$elements[$name]->count++;
// 是否有父元素?
if(isset($stack[count($stack)-1]))
{
// 是-將父元素賦給 $last_element
$last_element = $stack[count($stack)-1];
// 如果目前元素的父元素陣列為空,初始化為 0
if(!isset($elements[$name]->parents[$last_element]))
{
$elements[$name]->parents[$last_element] = 0;
}
// 該元素的父元素計數器加一
$elements[$name]->parents[$last_element]++;
// 如果目前元素的父元素的子元素陣列為空,初始化為 0
if(!isset($elements[$last_element]->childs[$name]))
{
$elements[$last_element]->childs[$name] = 0;
}
// 該元素的父元素的子元素計數器加一
$elements[$last_element]->childs[$name]++;
}
// 將目前的元素加入到堆疊中
array_push($stack, $name);
}
function stop_element($parser, $name)
{
global $stack;
// 從堆疊中將最頂部的元素移去
array_pop($stack);
}
function char_data($parser, $data)
{
global $elements, $stack, $depth;
// 增加目前元素的字元數目
$elements[$stack[count($stack)-1]]->chars += strlen(trim($data));
}
// 產生解析器的實例
$parser = xml_parser_create();
// 設定處理函數
xml_set_element_handler($parser, "start_element", "stop_element");
xml_set_character_data_handler($parser, "char_data");
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
// 解析文件
$ret = XML_parse_from_file($parser, $file);
if(!$ret)
{
die(sprintf("XML error: %s at line %d",
xml_error_string(xml_get_error_code($parser)),
xml_get_current_line_number($parser)));
}
// 釋放解析器
xml_parser_free($parser);
// 釋放協助元素
unset($elements["current_element"]);
unset($elements["last_element"]);
// 根據元素的次數排序
uasort($elements, "my_sort");
// 在 $elements 中循環收集元素資訊
while(list($name, $element) = each($elements))
{
print_box("Element name", $name);
print_line("Element count", $element->count);
print_line("Character count", $element->chars);
printf("\n%20s\n", "* Parent elements");
// 在該元素的父中循環,輸出結果
while(list($key, $value) = each($element->parents))
{
print_line($key, $value);
}
if(count($element->parents) == 0)
{
printf("%35s\n", "[root element]");
}
// 在該元素的子中循環,輸出結果
printf("\n%20s\n", "* Child elements");
while(list($key, $value) = each($element->childs))
{
print_line($key, $value);
}
if(count($element->childs) == 0)
{
printf("%35s\n", "[no childs]");
}
$total_elements += $element->count;
$total_chars += $element->chars;
}
// 最終結果
print_box("Total elements", $total_elements);
print_box("Total characters", $total_chars);
?>