這一組問題多半不是「不會寫 XML」,而是「寫了卻解析失敗」。內容涵蓋外國字元、實體引用、屬性中的引號、空白正規化,以及如何在 Visual C++ 中使用 MSXML。
文件可以包含外國字元,例如 foreign characters (úóí)。這類字元必須以 escape 序列表示,或改用其他編碼宣告:
<?xml version="1.0" encoding="utf-8"?> <description>foreign characters (úóí)</description>
宣告正確的編碼後,XML 就能正常載入。
但有些字元是 XML 語法結構的一部分,不能就這樣放進資料中。以下文件會產生錯誤:
<description>This & that</description>
錯誤訊息大致是「此處不允許有空格」,並指出 & 的位置。因為 & 是實體參照的起始符號,解析器期待後面接一個實體名稱,結果遇到空格就判定語法錯誤。
解法是把這些字元替換成對應的實體:
<description>This & that</description>
需要實體化的五個字元如下:
| 字元 | 實體 |
|---|---|
| < | < |
| & | & |
| > | > |
| " | " |
| ' | ' |
引號被用作屬性值的定界符,因此通常不能在屬性值內部直接使用同類引號。以下寫法會出錯,因為單引號同時當了定界符又出現在值裡:
<person name='John's Stuff' />
有兩種修正方式。一是把定界符換成雙引號:
<person name="John's Stuff" />
二是把單引號轉義成實體:
<person name='John's Stuff' />
兩種寫法透過 DOM 的 getAttribute 方法都會回傳相同的值 John's Stuff。同理,雙引號可以用 " 處理。
另一個選項是把文字放進 CDATA 節中,讓解析器完全跳過剖析:
<description><![CDATA[This & that is just "text" content.]]></description>
這段內容完全合法。此時 XML DOM 會把 CDATA 呈現為該元素節點的子節點,其 nodeValue 回傳字串 This & that is just "text" content.
實務判斷很簡單:需要嵌入大量 HTML 片段、程式碼或含大量特殊符號的文字時,用 CDATA;只有零星幾個符號要處理時,用實體更清楚。
最簡便的方式是用 #import 指令:
#import "msxml.dll" named_guids no_namespace
這會定義所有 IXML* 介面與介面 ID,讓你在程式中直接使用它們。另外也可以從 INETSDK 取得 MSXML 的型別庫與標頭檔,以及包含類別 IID 的 uuid.lib。
以下文件含 HTML 實體:
<description>Copyright © 2000, Microsoft Inc, All rights reserved.</description>
它會產生錯誤:「引用未定義的實體 'copy'」。原因是 XML 只有五個內建實體,© 不在其中。
要使用 HTML 實體,必須用 DTD 定義它們,再把 DTD 直接放進 DOCTYPE 標記中:
<?xml version="1.0"?> <!DOCTYPE description [ <!ENTITY copy "©"> ]> <description>Copyright © 2000, Microsoft Inc, All rights reserved.</description>
載入時需要關閉 IXMLDOMDocument 介面的 validateOnParse 屬性。文件會成功載入,版權符號則出現在 DOM 樹的末端。
如果已經完成了 DTD 驗證流程,則應把 HTML 實體作為參數實體納入既有 DTD:
<!ENTITY % HTMLENT SYSTEM "htmlentities.dtd"> %HTMLENT;
這樣就能在 XML 文件中使用所有 HTML 實體了。
XML DOM 提供三種存取元素文字內容的方式,行為各不相同:
| 屬性 | 行為 |
|---|---|
| nodeValue | 依原始 XML 源中指定的樣子,回傳 TEXT、CDATA、COMMENT 與 PI 節點的原始文字內容(含空白)。對 ELEMENT 節點與文件本身則回傳空值。 |
| data | 與 nodeValue 相同。 |
| text | 重複串接指定子樹中的多個 TEXT 與 CDATA 節點,回傳組合結果。 |
此處的「空白字元」包含換行、tab 與空格。
nodeValue 通常回傳原始文件的內容,與文件如何載入、目前的 xml:space 範圍無關。text 則會串接子樹中所有文字並擴展實體,因此結果會受載入時 preserveWhiteSpace 開關狀態與 xml:space 範圍影響。
文件載入時 preserveWhiteSpace = true 的情況:
| 設定組合 | 結果 |
|---|---|
| preserveWhiteSpace=true, xml:space=preserve | 保留 |
| preserveWhiteSpace=true, xml:space=default | 保留 |
| preserveWhiteSpace=false, xml:space=preserve | 保留 |
| preserveWhiteSpace=false, xml:space=default | 保留並截斷 |
文件載入時 preserveWhiteSpace = false 的情況:
| 設定組合 | 結果 |
|---|---|
| preserveWhiteSpace=true, xml:space=preserve | 半保留 |
| preserveWhiteSpace=true, xml:space=default | 半保留並截斷 |
| preserveWhiteSpace=false, xml:space=preserve | 半保留 |
| preserveWhiteSpace=false, xml:space=default | 半保留並截斷 |
三個名詞的定義:「保留」指與原始文件完全相同的文字內容;「截斷」指前導與尾部空白已刪除;「半保留」指保留了「重要的空白字元」並正規化了「不重要的空白字元」。
差別在於位置:重要空白是文字內容內部的空白;不重要空白是標記之間的空白。以下面這段為例:
<name>
Jane
Smith
</name>
標記與 "Jane" 之間的換行與縮排是不重要空白,而 "Jane" 與 "Smith" 之間的換行加縮排則是重要空白,因為它是文字內容的一部分。
對應的四種結果:
| 狀態 | 回傳值 |
|---|---|
| 保留 | 含全部換行與 tab 的原始字串 |
| 保留並截斷 | 去除首尾空白後的原始字串 |
| 半保留 | 首尾空白保留,內部換行與 tab 正規化為單一空格 |
| 半保留並截斷 | 去除首尾空白,內部換行與 tab 正規化為單一空格 |
關鍵在於「半保留」會正規化不重要空白——換行與 tab 會退化成單一個空格。修改 xml:space 屬性或 preserveWhiteSpace 開關後,text 屬性會回傳不同的值。
CDATA 節點或「保留」範圍節點的內容會被串接,因為它們不參與不重要空白的正規化。例如:
<name><![CDATA[
Jane
Smith
]]></name>
這種情況下,CDATA 內部的空白不再與「不重要空白」合併,也不會被截斷。因此「半保留並截斷」會回傳 " Jane Smith "——CDATA 邊界之外的標記間空白照樣納入,與 CDATA 內容無關。若把 CDATA 換成普通文字節點,結果相同。
實體作為 DTD 的一部分被載入與剖析,顯示在 DOCTYPE 節點之下,不一定要有任何 xml:space 範圍。
<!DOCTYPE foo [
<!ENTITY Jane "Jane
">
]>
<foo>&Jane;</foo>
假定 preserveWhiteSpace=false(在 DOCTYPE 標記範圍內),剖析實體時不重要空白就已遺失,實體內部不會產生空白節點。DOM 樹中 DOCTYPE 底下的 ENTITY 節點不含任何 WHITESPACE 節點,因此 ENTITYREF 節點的子節點也沒有——即使實體引用位於 xml:space="preserve" 範圍內也是如此。
結論很實用:若實體必須保留空白,就必須在實體內部自行指定 xml:space 屬性,或把文件的 preserveWhiteSpace 開關設為 true。同一份文件中被引用的每個 ENTITY 實例,通常都會有相同的樹結構。
屬性值可以透過幾種方式存取,回傳結果不同:
| 屬性 | 回傳的文字 |
|---|---|
| attrNode.nodeValue attrNode.value getAttribute("name") | 與原始文件完全相同(含擴展後的實體)。 |
| attrNode.nodeTypedValue | Null |
| attrNode.text | 除前導與尾部空白已截斷外,其餘與 nodeValue 相同。 |
而依 XML 規範為應用程式定義的行為,則按屬性型別分歧:
| 屬性型別 | 正規化方式 |
|---|---|
| CDATA | 半正規化 |
| ID、IDREF、IDREFS、ENTITY、ENTITIES、NOTATION、枚舉 | 全正規化 |
差別在於:半正規化把換行與 tab 轉為空格,但多個空格不會退化成一個;全正規化則會進一步把連續空白合併為單一空格,並截斷首尾。
這一整組問題其實指向同一件事:XML 對「什麼是資料、什麼是結構」有明確界線,而大多數解析錯誤都來自跨越了這條界線。& 與 < 屬於結構符號,進資料就得轉義;標記之間的空白屬於格式,進文字就得正規化;屬性型別決定了空白會被保留多少。把這三條記住,九成的解析錯誤都能自己定位。