DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 PHP 的 Expat 解析器處理 XML:以事件為導向的實作教學
編輯:XML詳解     

我喜歡電腦標準。如果每個人都遵守產業標準,網際網路會是一個更好的媒體;唯有採用標準化的資料交換格式,開放且跨平台的運算模式才切實可行。這正是我熱愛 XML 的原因。

幸運的是,我最喜歡的腳本語言不但支援 XML,支援力度還持續增強。PHP 能讓我迅速把 XML 文件發布到網路上、收集 XML 的統計資訊、把 XML 轉換成其他格式。舉例來說,我常用 PHP 的 XML 處理能力來管理自己以 XML 撰寫的文章與書稿。

本文要談的是如何用 PHP 內建的 Expat 解析器處理 XML 文件。透過範例,你將學會:建立自己的處理函式,以及把 XML 文件轉換成自訂的 PHP 資料結構。

認識 Expat

XML 解析器(也稱 XML 處理器)讓程式能存取 XML 文件的結構與內容。Expat 就是 PHP 的 XML 解析器,同時也用於 Mozilla、Apache、Perl 等專案。

兩類解析器

基於樹的解析器:把 XML 文件轉換成樹狀結構,先分析整份文件,再提供 API 存取樹上的每個元素。通用標準是 DOM(文件物件模型)。

基於事件的解析器:把 XML 文件視為一連串事件。當特定事件發生時,解析器呼叫開發者提供的函式來處理。這類解析器關注的是文件的「資料」,而非「結構」;它從頭到尾掃過文件,把「元素開始」、「元素結束」、「文字資料開始」等事件透過回呼函式回報給應用程式。

以這段 "Hello World" 文件為例:

<greeting>
Hello World
</greeting>

基於事件的解析器會回報三個事件:開始元素 greeting;文字資料 "Hello World";結束元素 greeting。

與樹型解析器不同,事件型解析器不會產生描述文件結構的資訊。在文字資料事件中,你不會得知父元素是 greeting。但代價換來的是更底層的存取、更好的資源運用與更快的處理速度——你不需要把整份文件載入記憶體,事實上文件甚至可以大於實際可用記憶體。

Expat 就是這樣的事件型解析器。當然,必要時它也能在 PHP 中組出完整的原生樹狀結構。

回到範例:那段 Hello World 是格式良好的 XML,但它是「無效」的——既沒有關聯 DTD,也沒有內嵌 DTD。對 Expat 而言這沒有差別,因為它是不做驗證的解析器,會忽略任何關聯的 DTD。但文件仍必須格式良好,否則 Expat(以及其他合規解析器)會隨著錯誤訊息中止。正是這種「不驗證」的特性,讓 Expat 輕巧快速,特別適合網路應用。

編譯 Expat

Expat 可編譯進 PHP 3.0.6 以上版本。從 Apache 1.3.9 起,Expat 已是 Apache 的一部分。在 Unix 系統中,用 --with-xml 選項設定 PHP 即可將其編入;若你把 PHP 編譯為 Apache 模組,Expat 會預設隨 Apache 一起可用;在 Windows 上則需自行載入 XML 動態連結庫。

範例:用 Expat 統計 XML 文件

理解 Expat 函式最快的途徑就是動手做。這個範例用 Expat 收集 XML 文件的統計資訊,對每個元素輸出:出現次數、字元資料數量、父元素、子元素。

準備工作。用 XML_parser_create() 建立解析器實例,後續所有函式都用它——概念很類似 PHP 中 MySQL 函式的連線標記。

解析文件前,事件型解析器通常要求你先註冊回呼函式。Expat 定義了七種可能事件:

  • 元素 — 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() 註冊,需要三個參數:解析器實例、處理開始元素的函式名稱、處理結束元素的函式名稱。開始元素處理函式會收到三個參數,範例中定義為:

function start_element($parser, $name, $attrs)

第一個是解析器標識,第二個是元素名稱,第三個是包含該元素所有屬性與值的陣列。

關閉大小寫摺疊。Expat 有個 Case Folding 選項,預設開啟,會把傳給處理函式的元素名稱自動轉為大寫。但 XML 對大小寫敏感(對統計工作而言尤其關鍵),所以必須關掉:

xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);

解析文件。xml_parse() 在文件格式不完整時會回傳 false;用 xml_get_error_code() 取得錯誤代碼,再傳給 xml_error_string() 得到文字訊息;xml_get_current_line_number() 則能告訴你出錯的行號,除錯時非常方便。解析過程中,Expat 會在遇到對應事件時呼叫你的回呼函式。

如何保留文件結構

事件型解析器本身不產生結構資訊,但標籤的嵌套關係是 XML 的重要特性。例如 <book><title> 與 <figure><title> 的意思完全不同——任何作者都會告訴你書名和圖名沒有關係,雖然它們都叫 title。

因此要有效運用事件型解析器,你必須自己用堆疊或清單維護結構資訊。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 保存文件中所有不同的元素,每個項目是 element 類別的實例,含四個屬性:$count(出現次數)、$chars(字元事件位元組數)、$parents(父元素)、$childs(子元素)。把類別實例存進陣列,在 PHP 中輕而易舉。

順帶一提,PHP 有個特性:你可以用 while (list() = each()) 迴圈遍歷整個類別結構,就像遍歷陣列一樣,所有類別變數都會以字串形式輸出。

每遇到一個元素,就把它的計數器加一;同時讓父元素知道「目前這個是它的子元素」,把目前元素名稱加入父元素的 $childs;最後讓目前元素記住自己的父元素,把父元素加入 $parents。

剩下的程式碼只是在 $elements 及其子陣列中做巢狀迴圈,把統計結果印出來。範例設計為透過 PHP 的 CGI 命令列方式執行,輸出為純文字格式;若要放到網路上,改寫輸出函式產生 HTML 即可。

總結

Expat 是 PHP 的事件型 XML 解析器,不產生結構描述,但透過底層存取換來更好的資源效率與速度。作為不驗證的解析器,它忽略關聯的 DTD,但文件格式不完整時仍會中止。

使用它的兩個要點:提供事件處理函式來接收文件內容;自己建立堆疊或樹狀結構來取得 XML 的結構資訊。

每天都有新的 XML 程式問世,PHP 對 XML 的支援也不斷增強(例如加入了 DOM 型的 libxml2 解析器)。有了 PHP 與 Expat,你就能為即將到來的開放、跨平台標準預作準備。

範例程式碼

<?
/*
* 名稱:XML 解析範例——XML 文件資訊統計
* 說明:以 PHP 的 Expat 解析器收集 XML 文件資訊(各元素出現次數、父元素與子元素)
* 用法:xmlstats.php test.xml
* 需求:Expat;PHP 4.0;編譯為 CGI 模式
*/

$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();
}

function XML_parse_from_file($parser, $file)
{
if (!file_exists($file)) die("找不到檔案 $file。");
if (!($fp = @fopen($file, "r"))) die("無法開啟檔案 $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+------------------------------------------------------------+\n");
printf("|%20s", "$title:");
printf("%14s", $value);
printf("%26s|\n", "");
printf("+------------------------------------------------------------+\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;

if (!isset($elements[$name])) {
$element = new element;
$elements[$name] = $element;
}

$elements[$name]->count++;

if (isset($stack[count($stack) - 1])) {
$last_element = $stack[count($stack) - 1];

if (!isset($elements[$name]->parents[$last_element]))
$elements[$name]->parents[$last_element] = 0;
$elements[$name]->parents[$last_element]++;

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;
$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);

if (!XML_parse_from_file($parser, $file)) {
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);

uasort($elements, "my_sort");

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);
?>

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved