DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
PHP 5 XML 實作教學:用物件介面完成節點的增刪改查
編輯:XML詳解     

先說結論:這是一套「以操作手感為優先」的包裝

SAX 解析要自己寫三個回呼函式,還得靠它們直接組出目標資料結構,邏輯負擔很重;換一份結構不同的 XML,往往又要重寫一輪。DOM 好一些,但每個節點都是一個 node,寫起來囉嗦。

於是這份實作走了第三條路:內部用 SAX 解析,外部包裝成近似 DOM 的操作介面。整體是 OO 設計,功能上可以完成節點的查詢、新增、修改、刪除,也能把整份 XML 一次匯出成陣列。程式碼以 PHP 5 撰寫,PHP 4 下無法運行。

使用前必須知道的兩個規則

這套 API 有兩個約定,先懂這兩點,後面的範例才讀得順:

  1. 節點鍵名 = 標籤名稱 + 底線 + 節點 id。 建議每個節點都帶一個 id 屬性。若沒有設,程式會自動以上級節點中的位置編號遞補,從 0 開始。所以 <cat id="food"> 底下第一個 <goods>(無 id)會被索引成 goods_0。
  2. 路徑查詢用 | 串接,且必須由上而下依序書寫。 例如 cat_food|goods_food11 代表「food 分類底下 id 為 food11 的商品」。

這兩個規則是效能與簡潔之間的折衷:代之以 XPath 那樣完整的查詢語言,只靠字串組裝就能定位任意深度的節點,代價是 id 變成了近乎必要的存在。

檔案配置

test.php
test.xml
XML/
  SimpleDocumentParser.php
  SimpleDocumentBase.php
  SimpleDocumentRoot.php
  SimpleDocumentNode.php

準備一份測試 XML

<?xml version="1.0" encoding="GB2312"?>
<shop>
  <name>華聯</name>
  <address>北京長安街-9999號</address>
  <desc>連鎖超市</desc>

  <cat id="food">
    <goods id="food11">
      <name>food11</name>
      <price>12.90</price>
    </goods>
    <goods id="food12">
      <name>food12</name>
      <price>22.10</price>
      <desc creator="hahawen">好東西推薦</desc>
    </goods>
  </cat>

  <cat>
    <goods id="tel21">
      <name>tel21</name>
      <price>1290</price>
    </goods>
  </cat>

  <cat id="coat">
    <goods id="coat31"><name>coat31</name><price>112</price></goods>
    <goods id="coat32"><name>coat32</name><price>45</price></goods>
  </cat>

  <special id="hot">
    <goods><name>hot41</name><price>99</price></goods>
  </special>
</shop>

這份文件刻意混了兩種情況:有 id 的節點,以及沒有 id 的節點(第二個 cat、special 裡的 goods),方便觀察自動編號的行為。

八個操作場景,走一遍完整生命週期

以下整支 test.php 依序示範從載入到修改、擴充、刪除的全套流程。

0. 載入文件

<?php
require_once 'XML/SimpleDocumentParser.php';
require_once 'XML/SimpleDocumentBase.php';
require_once 'XML/SimpleDocumentRoot.php';
require_once 'XML/SimpleDocumentNode.php';

$test = new SimpleDocumentParser();
$test->parse('test.xml');
$dom  = $test->getSimpleDocument();

解析器把 SAX 事件消化成一棵物件樹,之後所有操作都對著 $dom 進行,不必再碰回呼函式。

1. 整份匯出成陣列:getSaveData()

print_r($dom->getSaveData());

輸出結果如下。值得留意的是屬性被收進一個名為 attrs 的子鍵,而帶屬性的純文字節點(例如 desc)則被表示成 value 加 attrs 的組合:

Array
(
    [name]    => 華聯
    [address] => 北京長安街-9999號
    [desc]    => 連鎖超市
    [cat_food] => Array
        (
            [attrs]        => Array ( [id] => food )
            [goods_food11] => Array
                (
                    [name]  => food11
                    [price] => 12.90
                    [attrs] => Array ( [id] => food11 )
                )
            [goods_food12] => Array
                (
                    [name]  => food12
                    [price] => 22.10
                    [desc]  => Array
                        (
                            [value] => 好東西推薦
                            [attrs] => Array ( [creator] => hahawen )
                        )
                    [attrs] => Array ( [id] => food12 )
                )
        )
    [cat_1]       => Array ( [goods_tel21] => Array ( ... ) )
    [cat_coat]    => Array ( [goods_coat31] => ..., [goods_coat32] => ... )
    [special_hot] => Array ( [goods_0] => Array ( [name] => hot41, [price] => 99 ) )
)

對照原始文件即可驗證自動編號規則:cat_1 是第二個 cat(它在根節點的子節點中排序為 1),goods_0 則是 special_hot 底下第一個 goods。

2. 新增節點:setValue()

$dom->setValue('telphone', '123456789');
echo htmlspecialchars($dom->getSaveXML());

輸出:

<?xml version="1.0" encoding="GB2312" ?>
<shop>
  <name>華聯</name>
  <address>北京長安街-9999號</address>
  <desc>連鎖超市</desc>
  <telphone>123456789</telphone>
  <cat id="food">
  ...
  </cat>
</shop>

telphone 被追加在 desc 之後、第一個 cat 之前,也就是根節點既有值的尾端。

3. 取出某分類下的所有子節點:getNode()

$obj      = $dom->getNode('cat_food');
$nodeList = $obj->getNode();

foreach ($nodeList as $node) {
    $data = $node->getValue();
    echo '商品名:' . $data['name'] . '<br>';
    print_r($data);
    print_r($node->getAttribute());
}

輸出:

商品名:food11
Array ( [name] => food11, [price] => 12.90 )
Array ( [id] => food11 )

商品名:food12
Array (
    [name]  => food12
    [price] => 22.10
    [desc]  => Array (
        [value] => 好東西推薦
        [attrs] => Array ( [creator] => hahawen )
    )
)
Array ( [id] => food12 )

這裡有個關鍵分工:getValue() 只回傳「值」的部分,getAttribute() 只回傳屬性,兩者不混在一起。要完整資料就兩個都取。

4. 按路徑定位單一節點:findNodeByPath()

$obj = $dom->findNodeByPath('cat_food|goods_food11');

if (!is_object($obj)) {
    echo '該商品不存在';
} else {
    $data = $obj->getValue();
    echo '商品名:' . $data['name'] . '<br>';
    print_r($data);
    print_r($obj->getAttribute());
}

輸出:

商品名:food11
Array ( [name] => food11, [price] => 12.90 )
Array ( [id] => food11 )

找不到時回傳 null,因此呼叫端一定要用 is_object() 檢查,否則後續取值會出錯。

5. 為節點附加帶屬性的內容

$obj = $dom->findNodeByPath('cat_food|goods_food11');
$obj->setValue('leaveWord', array(
    'value' => '這個商品不錯',
    'attrs' => array('author' => 'hahawen', 'date' => date('Y-m-d'))
));
echo htmlspecialchars($dom->getSaveXML());

輸出片段:

<goods id="food11">
  <name>food11</name>
  <price>12.90</price>
  <leaveword author="hahawen" date="2004-12-05">這個商品不錯</leaveword>
</goods>

這裡出現一個值得注意的細節:輸出時標籤名稱被轉成小寫 leaveword。原因是解析器建立節點時的標籤處理策略,而新增的節點沿用了同一套規則;若你需要嚴格保留大小寫,這點必須自行調整。

6. 修改與刪除值:setValue() / removeValue()

$obj = $dom->findNodeByPath('cat_food|goods_food12');
$obj->setValue('name', 'new food12');
$obj->removeValue('desc');

echo htmlspecialchars($dom->getSaveXML());

輸出:

<goods id="food12">
  <name>new food12</name>
  <price>22.10</price>
</goods>

name 的值被覆寫,desc 連同它的 creator 屬性一起消失。屬性本身也有對應的 setAttribute() 與 removeAttribute(),行為對稱。

7. 動態新增節點:createNode()

$obj    = $dom->findNodeByPath('cat_food');
$newObj = $obj->createNode('goods', array('id' => 'food13'));
$newObj->setValue('name', 'food13');
$newObj->setValue('price', 100);

echo htmlspecialchars($dom->getSaveXML());

輸出:

<goods id="food13">
  <name>food13</name>
  <price>100</price>
</goods>

createNode() 回傳新節點物件,因此可以立刻鏈上一串 setValue() 把內容填滿——這是整組 API 寫起來最順的一段。

8. 刪除節點:removeNode()

$obj = $dom->findNodeByPath('cat_food');
$obj->removeNode('goods_food12');

echo htmlspecialchars($dom->getSaveXML());

輸出:

<cat id="food">
  <goods id="food11">
    <name>food11</name>
    <price>12.90</price>
    <leaveword author="hahawen" date="2004-12-05">這個商品不錯</leaveword>
  </goods>
  <goods id="food13">
    <name>food13</name>
    <price>100</price>
  </goods>
</cat>

food12 整筆消失,food11 與 food13 相對順序維持不變。

API 速查

方法用途
getSaveData()整份 XML 匯出為遞迴陣列
getSaveXML()重建並回傳 XML 文字(含宣告與縮排)
getNode($name)取得子節點;不傳參數則回傳全部子節點
findNodeByPath($path)以 | 路徑定位深層節點,找不到回傳 null
createNode($name, $attrs)建立並掛上子節點,回傳新節點物件
removeNode($name)刪除指定子節點
setValue / getValue / removeValue值的新增、讀取、刪除
setAttribute / getAttribute / removeAttribute屬性的新增、讀取、刪除

該在什麼時候用它

這套做法適合的是「把一份結構固定的 XML 當設定檔或輕量資料容器」的場景:讀進來、改幾個節點、存回去,中間不需要 XSD 驗證,也不需要 XQuery 等級的查詢能力。在這種需求下,它比 SAX 少寫很多樣板程式,也比 DOM 直覺。

但正式專案中有幾個地方需要留意:getSaveXML() 並未對文字內容做 XML 轉義,值裡若含 & 或 < 會產生不合法的文件;編碼轉換(iconv 在 UTF-8 與 GB2312 之間)是寫死的;自動編號的鍵名在節點被刪除後可能改變,若外部有依賴該鍵名的邏輯就會出問題。若你的環境已是 PHP 5 以上,SimpleXMLElement 與 DOMDocument 是更省事的選擇;這份實作的價值,在於示範如何把「我想要的 API 長什麼樣子」直接寫成程式碼。

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