XML 的應用愈來愈普遍,但很多 XML 的結構並不理想。就算結構良好,也常常設計得很糟,令後續處理與維護痛苦不堪;而支撐 XML 的大部分基礎設施,往往讓問題雪上加霜。於是,關於 XML 最佳實踐的公開討論應運而生,例如 Henri Sivonen 的文章〈HOWTO Avoid Being Called a Bozo When Producing XML〉。Uche Ogbuji 經常在 IBM developerWorks 上探討 XML 最佳實踐,本文便整理歸納了這些文章的觀點。
多年來,我一直在本專欄與其他系列文章中談論 XML 最佳實踐,同行的專欄作家 Elliotte Rusty Harold 也談過這個題目。參與 XML 設計原則討論的專家愈多愈好,這樣社群才能為不同層次的開發者提供一致的建議。本文將結合最新與過去的文章,更詳盡地介紹 XML 最佳實踐。
Henri Sivonen 寫過一篇實用文章〈HOWTO Avoid Being Called a Bozo When Producing XML〉。他從以 XML 為基礎的 Web 提要格式(如 RSS 與 Atom)出發,提出了用程式生成結構良好的 XML 時,該做與不該做的指南。正如他在簡介中所說:有些開發者似乎認為以程式生成結構良好的 XML 非常困難、甚至不可能,另一些開發者卻輕鬆做到,還納悶旁人為何如此笨拙。他假定沒人願意顯得笨拙或被點名,因此希望下列建議能幫開發者從前一類轉變為後一類。
Henri 的第一條建議是「不要把 XML 當成純文字格式」,我認為這條建議有點危險。其基本精神是正確的——不能像對待簡單文字檔那樣隨心所欲地生成與編輯 XML,但這種要求其實適用於所有有結構的文字格式。然而,說 XML 不是文字,恰恰背離了 XML 最重要的特點之一,而這一點在 XML 規範中被奉為圭臬(「文字物件是結構良好的 XML 文件」)。他的說法也容易造成混淆,因為「XML 文字」本就有技術上的定義,大致是指 XML 中的字元序列。文字不僅是葉節點或屬性中的主要成分(技術上稱為字元資料),更是所有 XML 實體的主要成分,因此說 XML 不是文字其實自相矛盾。我認為,強調 XML 與開發者熟悉的文字格式之間的差異,會更有意義。
上述評析顯示,Henri 的建議或許因為過度在意「生成結構良好的 Web 提要」這一問題而顯得偏激。他警告:單純堆疊字串、指望它成為結構良好的 XML,這種做法很危險——這一點他是對的,我也曾建議大家使用成熟的 XML 工具箱,而非用簡單的文字工具來建立 XML。我存疑的是他描述這條建議的方式有些混亂,在更廣泛的 XML 處理情境中容易造成誤解。他在〈Don't use text-based templates〉與〈Don't print〉兩節中反覆重申這個觀點。我認為可以把它歸納為:「不要使用無法保證產生結構良好 XML 的機制」,這確實是一條很重要的建議。正如 Henri 提到的,安全建立 XML 的一種方法是發送 SAX 事件,或使用樹/堆疊(或 XML 解析器)。但即便如此也未必能高枕無憂——所用的 SAX 工具不一定會執行所有必要的結構良好性檢查。舉例來說,XML 中禁止使用某些 Unicode 字元,為了解決這類問題,可能仍需額外檢查。
Henri 建議不要手工管理名域,這是正確的。我也曾在 developerWorks 上談過,處理 XML 名域必須格外小心。他建議開發者一般以「統一名(名域 URI 加上本地名)」來思考即可,但有時仍難以避免面對前綴或 XML 宣告。在 XSLT 這類規範中,QName(前綴/本地名的組合)可於屬性值中使用,並假定前綴依作用域內的名域宣告來解釋,這種模式稱為「上下文中的 QName」。此時開發者就必須掌控宣告的前綴,否則 XML 處理就會失敗;若由開發者自行管理名域宣告,由於名域的複雜性,結果往往會顯得雜亂無章。
由於經過 XML 處理管線之後,名域語法可能變得非常混亂,一種解法是在管線最後插入一個「正規化」步驟。XML 正規化會消除 XML 1.0 與 XML 名域所允許的各種語法變體,包括不同的名域宣告方式。正規化雖不能解決上下文 QName 問題(因為它不更動文件中使用的前綴),卻確實能減輕名域宣告的混亂程度,讓你更容易定位問題,甚至寫程式自動修正。GenX 庫便是 Henri 建議的 XML 建立工具之一,能自動生成正規的 XML,其他許多工具箱也把正規化列為可選功能。
Henri 關於 Unicode 與字元處理的建議基本上完全正確,不過我認為〈Avoid adding pretty-printing white space in character data〉一節略嫌誇大。多數情況下,在元素之間(而非帶有字元資料的元素內部)做美化打印是安全的。如他所言,把下面這份文件改寫成另一種形式,通常並不安全:
<foo>bar</foo>
改成:
<foo> bar </foo>
但通常以下面這種方式打印 XML 是安全的,輸出結果如下:
<doc><foo>bar</foo></doc>
會變成:
<doc> <foo>bar</foo> </doc>
許多 XML 序列化工具能理解相對安全與不安全的打印格式。必須留意的是,如果在混合內容中增加空格,上述美化打印可能造成資料扭曲。若採用「模式引導的序列化」,便能避免這類問題;實務上,多數使用混合內容的詞彙對空白正規化並不那麼敏感,因此不必過度擔心美化打印。你應該充分了解這個問題,並知道關掉美化打印的方法(最好預設就不用美化打印)。Henri 提出了另一種美化打印方式,但我並不贊同,因為那種難看的標記不易閱讀。
換個話題,本文要探討的第二份資料是 Simon St. Laurent 撰寫的〈Monastic XML〉。這是一組短文,圍繞如何善用 XML,就處理與思考 XML 提出了若干建議。Simon 以修道院與禁欲主義為比喻,提醒人們:為 XML 加上太多超出其「純文字根基」的負擔,其實很危險。在〈Marking-up at the foundation〉中,他探討了字元資料與標記(元素和屬性)的本質作用;在〈Naming things and reading names〉中,他說明為何一般標識符(即元素類型名)是關鍵概念,應作為標記資訊結構中唯一的辨識成分——理想情況下,若使用 XML 名域,關鍵便是統一名(名域 URI 加本地名),而這種複雜化正是 Simon 在〈Namespaces as opportunity〉中疾呼的原因之一。〈Accepting the discipline of trees〉則揭示了 XML 一個不幸的秘密:儘管 XML 的層次結構看起來很容易擴展成圖形,實務上卻相當難以 XML 為圖建模。而在〈Monastic XML〉站上,目前最重要的建議莫過於「對標記處理的過早優化,往往適得其反」。XML 是一種宣告式技術,關於它的強項與局限,坊間有許多不實之詞。那些急著把 XML 設計與處理細節硬湊在一起的開發者,長期而言通常讓處理變得更棘手。XML 成功的關鍵,在於聚焦於「需要以抽象方式表示的信息特點」,並把它與「處理這些資訊的系統技術設計」區隔開來。
談論 XML 最佳實踐時,總會有不同聲音,尤其在早期階段;但聽到不同意見其實是好事。關於這個主題的參考資料不多,我會繼續在本專欄探討它。若你有關於最佳實踐的資料、建議或觀點想分享,歡迎到 Thinking XML 論壇參與討論。