詳解用PHP讀取和編寫(xiě)XML DOM
用PHP讀取和編寫(xiě)可擴(kuò)展標(biāo)記語(yǔ)言(XML)看起來(lái)可能有點(diǎn)恐怖。實(shí)際上,XML 和它的所有相關(guān)技術(shù)可能是恐怖的,但是用PHP讀取和編寫(xiě)XML不一定是項(xiàng)恐怖的任務(wù)。首先,需要學(xué)習(xí)一點(diǎn)關(guān)于XML的知識(shí):它是什么,用它做什么。然后,需要學(xué)習(xí)如何用PHP讀取和編寫(xiě)XML,而有許多種方式可以做這件事。
51CTO推薦閱讀:JavaScript DOM的本質(zhì)及操作方法
什么是XML?
XML是一種數(shù)據(jù)存儲(chǔ)格式。它沒(méi)有定義保存什么數(shù)據(jù),也沒(méi)有定義數(shù)據(jù)的格式。XML只是定義了標(biāo)記和這些標(biāo)記的屬性。格式良好的XML標(biāo)記看起來(lái)像這樣:
- <name>Jack Herrington</name>
這個(gè)<name>標(biāo)記包含一些文本:Jack Herrington。不包含文本的 XML 標(biāo)記看起來(lái)像這樣:
- <powerUp />
用 XML 對(duì)某件事進(jìn)行編寫(xiě)的方式不止一種。例如,這個(gè)標(biāo)記形成的輸出與前一個(gè)標(biāo)記相同:
- <powerUp></powerUp>
也可以向 XML 標(biāo)記添加屬性。例如,這個(gè) <name> 標(biāo)記包含 first 和 last 屬性:
- <name first="Jack" last="Herrington" />
也可以用 XML 對(duì)特殊字符進(jìn)行編碼。例如,& 符號(hào)可以像這樣編碼:
- &
包含標(biāo)記和屬性的 XML 文件如果像示例一樣格式化,就是格式良好的,這意味著標(biāo)記是對(duì)稱(chēng)的,字符的編碼正確。清單 1 是一份格式良好的 XML 的示例。
清單 1. XML圖書(shū)列表示例
- <books>
- <book>
- <author>Jack Herrington</author>
- <title>PHP Hacks</title>
- <publisher>O'Reilly</publisher>
- </book>
- <book>
- <author>Jack Herrington</author>
- <title>Podcasting Hacks</title>
- <publisher>O'Reilly</publisher>
- </book>
- </books>
清單 1 中的 XML 包含一個(gè)圖書(shū)列表。父標(biāo)記 <books> 包含一組 <book> 標(biāo)記,每個(gè) <book> 標(biāo)記又包含 <author>、<title> 和 <publisher> 標(biāo)記。當(dāng) XML 文檔的標(biāo)記結(jié)構(gòu)和內(nèi)容得到外部模式文件的驗(yàn)證后,XML 文檔就是正確的。模式文件可以用不同的格式指定。對(duì)于本文來(lái)說(shuō),所需要的只是格式良好的 XML。
如果覺(jué)得 XML 看起來(lái)很像超文本標(biāo)記語(yǔ)言(HTML),那么就對(duì)了。XML 和 HTML 都是基于標(biāo)記的語(yǔ)言,它們有許多相似之處。但是,要著重指出的是:雖然 XML 文檔可能是格式良好的 HTML,但不是所有的 HTML 文檔都是格式良好的 XML。換行標(biāo)記(br)是 XML 和 HTML 之間區(qū)別的一個(gè)好例子。這個(gè)換行標(biāo)記是格式良好的 HTML,但不是格式良好的 XML:
- <p>This is a paragraph<br>
- With a line break</p>
這個(gè)換行標(biāo)記是格式良好的 XML 和 HTML:
- <p>This is a paragraph<br />
- With a line break</p>
如果要把 HTML 編寫(xiě)成同樣是格式良好的 XML,請(qǐng)遵循 W3C 委員會(huì)的可擴(kuò)展超文本標(biāo)記語(yǔ)言(XHTML)標(biāo)準(zhǔn)(參見(jiàn) 參考資料)。所有現(xiàn)代的瀏覽器都能呈現(xiàn) XHTML。而且,還可以用 XML 工具讀取 XHTML 并找出文檔中的數(shù)據(jù),這比解析 HTML 容易得多。
#p#
使用DOM庫(kù)讀取XML
讀取格式良好的 XML 文件最容易的方式是使用編譯成某些 PHP 安裝的文檔對(duì)象模型 (DOM)庫(kù)。DOM 庫(kù)把整個(gè) XML 文檔讀入內(nèi)存,并用節(jié)點(diǎn)樹(shù)表示它,如圖 1 所示。
樹(shù)頂部的 books 節(jié)點(diǎn)有兩個(gè) book 子標(biāo)記。在每本書(shū)中,有 author、publisher 和 title 幾個(gè)節(jié)點(diǎn)。author、publisher 和 title 節(jié)點(diǎn)分別有包含文本的文本子節(jié)點(diǎn)。讀取圖書(shū) XML 文件并用 DOM 顯示內(nèi)容的代碼如清單 2 所示。
清單 2. 用DOM讀取圖書(shū)XML
- <?php
- $doc = new DOMDocument();
- $doc->load( 'books.xml' );
- $books = $doc->getElementsByTagName( "book" );
- foreach( $books as $book )
- {
- $authors = $book->getElementsByTagName( "author" );
- $author = $authors->item(0)->nodeValue;
- $publishers = $book->getElementsByTagName( "publisher" );
- $publisher = $publishers->item(0)->nodeValue;
- $titles = $book->getElementsByTagName( "title" );
- $title = $titles->item(0)->nodeValue;
- echo "$title - $author - $publisher\n";
- }
- ?>
腳本首先創(chuàng)建一個(gè)new DOMdocument對(duì)象,用load方法把圖書(shū) XML 裝入這個(gè)對(duì)象。之后,腳本用 getElementsByName 方法得到指定名稱(chēng)下的所有元素的列表。在 book 節(jié)點(diǎn)的循環(huán)中,腳本用getElementsByName方法獲得author、publisher和 title 標(biāo)記的 nodeValue。nodeValue 是節(jié)點(diǎn)中的文本。腳本然后顯示這些值??梢栽诿钚猩舷襁@樣運(yùn)行 PHP 腳本:
- % php e1.php
- PHP Hacks - Jack Herrington - O'Reilly
- Podcasting Hacks - Jack Herrington - O'Reilly
- %
可以看到,每個(gè)圖書(shū)塊輸出一行。這是一個(gè)良好的開(kāi)始。但是,如果不能訪問(wèn) XML DOM 庫(kù)該怎么辦?
用SAX解析器讀取XML
讀取 XML 的另一種方法是使用 XML Simple API(SAX)解析器。PHP 的大多數(shù)安裝都包含 SAX 解析器。SAX 解析器運(yùn)行在回調(diào)模型上。每次打開(kāi)或關(guān)閉一個(gè)標(biāo)記時(shí),或者每次解析器看到文本時(shí),就用節(jié)點(diǎn)或文本的信息回調(diào)用戶定義的函數(shù)。
SAX 解析器的優(yōu)點(diǎn)是,它是真正輕量級(jí)的。解析器不會(huì)在內(nèi)存中長(zhǎng)期保持內(nèi)容,所以可以用于非常巨大的文件。缺點(diǎn)是編寫(xiě) SAX 解析器回調(diào)是件非常麻煩的事。清單 3 顯示了使用 SAX 讀取圖書(shū) XML 文件并顯示內(nèi)容的代碼。
清單 3. 用SAX解析器讀取圖書(shū)XML
- <?php
- $g_books = array();
- $g_elem = null;
- function startElement( $parser, $name, $attrs )
- {
- global $g_books, $g_elem;
- if ( $name == 'BOOK' ) $g_books []= array();
- $g_elem = $name;
- }
- function endElement( $parser, $name )
- {
- global $g_elem;
- $g_elem = null;
- }
- function textData( $parser, $text )
- {
- global $g_books, $g_elem;
- if ( $g_elem == 'AUTHOR' ||
- $g_elem == 'PUBLISHER' ||
- $g_elem == 'TITLE' )
- {
- $g_books[ count( $g_books ) - 1 ][ $g_elem ] = $text;
- }
- }
- $parser = xml_parser_create();
- xml_set_element_handler( $parser, "startElement", "endElement" );
- xml_set_character_data_handler( $parser, "textData" );
- $f = fopen( 'books.xml', 'r' );
- while( $data = fread( $f, 4096 ) )
- {
- xml_parse( $parser, $data );
- }
- xml_parser_free( $parser );
- foreach( $g_books as $book )
- {
- echo $book['TITLE']." - ".$book['AUTHOR']." - ";
- echo $book['PUBLISHER']."\n";
- }
- ?>
腳本首先設(shè)置 g_books 數(shù)組,它在內(nèi)存中容納所有圖書(shū)和圖書(shū)信息,g_elem 變量保存腳本目前正在處理的標(biāo)記的名稱(chēng)。然后腳本定義回調(diào)函數(shù)。在這個(gè)示例中,回調(diào)函數(shù)是 startElement、endElement 和 textData。在打開(kāi)和關(guān)閉標(biāo)記的時(shí)候,分別調(diào)用 startElement 和 endElement 函數(shù)。在開(kāi)始和結(jié)束標(biāo)記之間的文本上面,調(diào)用 textData。
在這個(gè)示例中,startElement 標(biāo)記查找 book 標(biāo)記,在 book 數(shù)組中開(kāi)始一個(gè)新元素。然后,textData 函數(shù)查看當(dāng)前元素,看它是不是 publisher、title 或 author 標(biāo)記。如果是,函數(shù)就把當(dāng)前文本放入當(dāng)前圖書(shū)。
為了讓解析繼續(xù),腳本用 xml_parser_create 函數(shù)創(chuàng)建解析器。然后,設(shè)置回調(diào)句柄。之后,腳本讀取文件并把文件的大塊內(nèi)容發(fā)送到解析器。在文件讀取之后,xml_parser_free 函數(shù)刪除解析器。腳本的末尾輸出 g_books 數(shù)組的內(nèi)容??梢钥吹?,這比編寫(xiě) DOM 的同樣功能要困難得多。如果沒(méi)有 DOM 庫(kù)也沒(méi)有 SAX 庫(kù)該怎么辦?還有替代方案么?
#p#
用正則表達(dá)式解析XML
可以肯定,即使提到這個(gè)方法,有些工程師也會(huì)批評(píng)我,但是確實(shí)可以用正則表達(dá)式解析 XML。清單 4 顯示了使用 preg_ 函數(shù)讀取圖書(shū)文件的示例。
清單 4. 用正則表達(dá)式讀取XML
- <?php
- $xml = "";
- $f = fopen( 'books.xml', 'r' );
- while( $data = fread( $f, 4096 ) ) { $xml .= $data; }
- fclose( $f );
- preg_match_all( "/\<book\>(.*?)\<\/book\>/s",
- $xml, $bookblocks );
- foreach( $bookblocks[1] as $block )
- {
- preg_match_all( "/\<author\>(.*?)\<\/author\>/",
- $block, $author );
- preg_match_all( "/\<title\>(.*?)\<\/title\>/",
- $block, $title );
- preg_match_all( "/\<publisher\>(.*?)\<\/publisher\>/",
- $block, $publisher );
- echo( $title[1][0]." - ".$author[1][0]." - ".
- $publisher[1][0]."\n" );
- }
- ?>
請(qǐng)注意這個(gè)代碼有多短。開(kāi)始時(shí),它把文件讀進(jìn)一個(gè)大的字符串。然后用一個(gè) regex 函數(shù)讀取每個(gè)圖書(shū)項(xiàng)目。***用 foreach 循環(huán),在每個(gè)圖書(shū)塊間循環(huán),并提取出 author、title 和 publisher。
那么,缺陷在哪呢?使用正則表達(dá)式代碼讀取 XML 的問(wèn)題是,它并沒(méi)先進(jìn)行檢查,確保 XML 的格式良好。這意味著在讀取之前,無(wú)法知道 XML 是否格式良好。而且,有些格式正確的 XML 可能與正則表達(dá)式不匹配,所以日后必須修改它們。
我從不建議使用正則表達(dá)式讀取 XML,但是有時(shí)它是兼容性***的方式,因?yàn)檎齽t表達(dá)式函數(shù)總是可用的。不要用正則表達(dá)式讀取直接來(lái)自用戶的 XML,因?yàn)闊o(wú)法控制這類(lèi) XML 的格式或結(jié)構(gòu)。應(yīng)當(dāng)一直用 DOM 庫(kù)或 SAX 解析器讀取來(lái)自用戶的 XML。
用DOM編寫(xiě)XML
讀取 XML 只是公式的一部分。該怎樣編寫(xiě) XML 呢?編寫(xiě) XML ***的方式就是用 DOM。清單 5 顯示了 DOM 構(gòu)建圖書(shū) XML 文件的方式。
清單 5. 用DOM編寫(xiě)圖書(shū)XML
- <?php
- $books = array();
- $books [] = array(
- 'title' => 'PHP Hacks',
- 'author' => 'Jack Herrington',
- 'publisher' => "O'Reilly"
- );
- $books [] = array(
- 'title' => 'Podcasting Hacks',
- 'author' => 'Jack Herrington',
- 'publisher' => "O'Reilly"
- );
- $doc = new DOMDocument();
- $doc->formatOutput = true;
- $r = $doc->createElement( "books" );
- $doc->appendChild( $r );
- foreach( $books as $book )
- {
- $b = $doc->createElement( "book" );
- $author = $doc->createElement( "author" );
- $author->appendChild(
- $doc->createTextNode( $book['author'] )
- );
- $b->appendChild( $author );
- $title = $doc->createElement( "title" );
- $title->appendChild(
- $doc->createTextNode( $book['title'] )
- );
- $b->appendChild( $title );
- $publisher = $doc->createElement( "publisher" );
- $publisher->appendChild(
- $doc->createTextNode( $book['publisher'] )
- );
- $b->appendChild( $publisher );
- $r->appendChild( $b );
- }
- echo $doc->saveXML();
- ?>
在腳本的頂部,用一些示例圖書(shū)裝入了 books 數(shù)組。這個(gè)數(shù)據(jù)可以來(lái)自用戶也可以來(lái)自數(shù)據(jù)庫(kù)。
示例圖書(shū)裝入之后,腳本創(chuàng)建一個(gè) new DOMDocument,并把根節(jié)點(diǎn) books 添加到它。然后腳本為每本書(shū)的 author、title 和 publisher 創(chuàng)建節(jié)點(diǎn),并為每個(gè)節(jié)點(diǎn)添加文本節(jié)點(diǎn)。每個(gè) book 節(jié)點(diǎn)的***一步是重新把它添加到根節(jié)點(diǎn) books。腳本的末尾用 saveXML 方法把 XML 輸出到控制臺(tái)。(也可以用 save 方法創(chuàng)建一個(gè) XML 文件。)腳本的輸出如清單 6 所示。
清單6. DOM構(gòu)建腳本的輸出
- % php e4.php
- <?xml version="1.0"?>
- <books>
- <book>
- <author>Jack Herrington</author>
- <title>PHP Hacks</title>
- <publisher>O'Reilly</publisher>
- </book>
- <book>
- <author>Jack Herrington</author>
- <title>Podcasting Hacks</title>
- <publisher>O'Reilly</publisher>
- </book>
- </books>
- %
使用 DOM 的真正價(jià)值在于它創(chuàng)建的 XML 總是格式正確的。但是如果不能用 DOM 創(chuàng)建 XML 時(shí)該怎么辦?
#p#
用PHP編寫(xiě)XML
如果 DOM 不可用,可以用 PHP 的文本模板編寫(xiě) XML。清單 7 顯示了 PHP 如何構(gòu)建圖書(shū) XML 文件。
清單7. 用PHP編寫(xiě)圖書(shū)XML
- <?php
- $books = array();
- $books [] = array(
- 'title' => 'PHP Hacks',
- 'author' => 'Jack Herrington',
- 'publisher' => "O'Reilly"
- );
- $books [] = array(
- 'title' => 'Podcasting Hacks',
- 'author' => 'Jack Herrington',
- 'publisher' => "O'Reilly"
- );
- ?>
- <books>
- <?php
- foreach( $books as $book )
- {
- ?>
- <book>
- <title><?php echo( $book['title'] ); ?></title>
- <author><?php echo( $book['author'] ); ?>
- </author>
- <publisher><?php echo( $book['publisher'] ); ?>
- </publisher>
- </book>
- <?php
- }
- ?>
- </books>
腳本的頂部與DOM腳本類(lèi)似。腳本的底部打開(kāi)books標(biāo)記,然后在每個(gè)圖書(shū)中迭代,創(chuàng)建book標(biāo)記和所有的內(nèi)部 title、author 和 publisher 標(biāo)記。這種方法的問(wèn)題是對(duì)實(shí)體進(jìn)行編碼。為了確保實(shí)體編碼正確,必須在每個(gè)項(xiàng)目上調(diào)用htmlentities函數(shù),如清單8所示。
清單8. 使用htmlentities函數(shù)對(duì)實(shí)體編碼
- <books>
- <?php
- foreach( $books as $book )
- {
- $title = htmlentities( $book['title'], ENT_QUOTES );
- $author = htmlentities( $book['author'], ENT_QUOTES );
- $publisher = htmlentities( $book['publisher'], ENT_QUOTES );
- ?>
- <book>
- <title><?php echo( $title ); ?></title>
- <author><?php echo( $author ); ?> </author>
- <publisher><?php echo( $publisher ); ?>
- </publisher>
- </book>
- <?php
- }
- ?>
- </books>
這就是用基本的 PHP 編寫(xiě) XML 的煩人之處。您以為自己創(chuàng)建了***的 XML,但是在試圖使用數(shù)據(jù)的時(shí)候,馬上就會(huì)發(fā)現(xiàn)某些元素的編碼不正確。
結(jié)束語(yǔ)
XML 周?chē)傆性S多夸大之處和混淆之處。但是,并不像您想像的那么難 —— 特別是在 PHP 這樣優(yōu)秀的語(yǔ)言中。在理解并正確地實(shí)現(xiàn)了 XML 之后,就會(huì)發(fā)現(xiàn)有許多強(qiáng)大的工具可以使用。XPath 和 XSLT 就是這樣兩個(gè)值得研究的工具。
【編輯推薦】