作者:Dethe Elza,高級技術架構師,Blast Radius
文件物件模型(Document Object Model,DOM)是操作 XML 與 HTML 最常用的工具之一,但它的潛力很少被真正挖出來。DOM 是標準、被廣泛實作、且內建於眾多其他標準之中——這既是它的優勢,也讓許多人停在「能用就好」的階段,忍受著它出了名的冗長。
本文要談的不是 DOM 的缺點,而是怎麼讓它變好用。透過一些小巧的工具函式,你能把囉嗦的 DOM 程式碼壓縮成自解釋的、優雅的片段。
DOM 提供了兩個把子節點加入容器的方法:appendChild(node) 與 insertBefore(node, referenceNode)。乍看之下似乎少了什麼——如果想在某個參考節點之後插入,或者想把新節點放到清單最前面(prepend),該怎麼辦?
我曾經這樣寫:
// 麻煩但常見的寫法
function insertAfter(parent, node, referenceNode) {
if (referenceNode.nextSibling) {
parent.insertBefore(node, referenceNode.nextSibling);
} else {
parent.appendChild(node);
}
}
function prependChild(parent, node) {
if (parent.firstChild) {
parent.insertBefore(node, parent.firstChild);
} else {
parent.appendChild(node);
}
}
但其實 insertBefore() 早就定義為:當參考節點為 null 時,等同於 appendChild()。所以那些 if-else 判斷全是多餘的:
function insertAfter(parent, node, referenceNode) {
parent.insertBefore(node, referenceNode.nextSibling);
}
function prependChild(parent, node) {
parent.insertBefore(node, parent.firstChild);
}
更乾脆的做法是直接用內建函式,連包裝都省了。這個「以為要補的洞其實規格裡已經處理了」的情況,在 DOM 中屢見不鮮,值得在動手包裝前先翻一次規格。
這條規則初學時容易忽略,懂了之後卻很方便:你可以讓多個變數指向同一個節點,但該節點在 DOM 樹中永遠只占一個位置。因此想把某節點移到新位置,不必先從舊位置移除——呼叫 insertBefore 時它就會自動被摘下來。
據此,交換兩個相鄰節點(node1 與 node2)的順序,任寫一種即可:
node1.parentNode.insertBefore(node2, node1); // 或 node1.parentNode.insertBefore(node1.nextSibling, node1);
DOM 用 nodeType 屬性表示節點類型,規格定義了一組對應常數。但 Internet Explorer 並未提供 Node 介面,直接寫 Node.ELEMENT_NODE 會出錯。若要在跨瀏覽器環境中使用這些常數,得自己補上:
if (!window['Node']) {
window.Node = new Object();
Node.ELEMENT_NODE = 1;
Node.ATTRIBUTE_NODE = 2;
Node.TEXT_NODE = 3;
Node.CDATA_SECTION_NODE = 4;
Node.ENTITY_REFERENCE_NODE = 5;
Node.ENTITY_NODE = 6;
Node.PROCESSING_INSTRUCTION_NODE = 7;
Node.COMMENT_NODE = 8;
Node.DOCUMENT_NODE = 9;
Node.DOCUMENT_TYPE_NODE = 10;
Node.DOCUMENT_FRAGMENT_NODE = 11;
Node.NOTATION_NODE = 12;
}
補上之後,就能寫出像這樣的遞迴工具,取出節點底下所有的文字:
function innerText(node) {
if (node.nodeType == 3 || node.nodeType == 4) { // 文字節點或 CDATA
return node.data;
}
var returnValue = [];
for (var i = 0; i < node.childNodes.length; i++) {
returnValue.push(innerText(node.childNodes[i]));
}
return returnValue.join('');
}
人們抱怨 DOM 囉嗦不是沒有道理。想建立一個帶文字、帶 class、帶 inline style 的 div,得寫成這樣:
function handle_button() {
var parent = document.getElementById('myContainer');
var div = document.createElement('div');
div.className = 'myDivCSSClass';
div.id = 'myDivId';
div.style.position = 'absolute';
div.style.left = '300px';
div.style.top = '200px';
var textNode = document.createTextNode("這段文字會出現在 div 裡");
div.appendChild(textNode);
parent.appendChild(div);
}
偶爾寫一次還好,頻繁建立節點時,鍵入這些樣板程式碼很快就讓人疲憊。與其如此,不如做一個萬用工具——除了元素名稱,其餘參數都是選填的:
function elem(name, attrs, style, text) {
var e = document.createElement(name);
if (attrs) {
for (key in attrs) {
if (key == 'class') {
e.className = attrs[key];
} else if (key == 'id') {
e.id = attrs[key];
} else {
e.setAttribute(key, attrs[key]);
}
}
}
if (style) {
for (key in style) {
e.style[key] = style[key];
}
}
if (text) {
e.appendChild(document.createTextNode(text));
}
return e;
}
有了它,同樣的 div 可以壓成一段幾乎能當口語讀的程式:
function handle_button() {
var parent = document.getElementById('myContainer');
parent.appendChild(elem('div',
{class: 'myDivCSSClass', id: 'myDivId'},
{position: 'absolute', left: '300px', top: '200px'},
'這段文字會出現在 div 裡'));
}
attrs 與 style 兩個參數直接利用了 JavaScript 的物件字面值語法,寫起來幾乎像在描述 HTML。需要快速產生大量 DHTML 物件時,這個小工具能省下可觀的時間,也少了重複剪貼所帶來的錯誤。
DOM 有個惱人的特徵:它不太告訴你「依文件順序,下一個節點是誰」。節點只知道自己的 firstChild、nextSibling 這些局部關係,要按順序遍歷整棵樹,得自己遞迴:
// 回傳文件順序中的下一個節點
function nextNode(node) {
if (!node) return null;
if (node.firstChild) {
return node.firstChild;
} else {
return nextWide(node);
}
}
function nextWide(node) { // nextNode 的輔助函式
if (!node) return null;
if (node.nextSibling) {
return node.nextSibling;
} else {
return nextWide(node.parentNode);
}
}
// 回傳文件順序中的上一個節點
function prevNode(node) {
if (!node) return null;
if (node.previousSibling) {
return previousDeep(node.previousSibling);
}
return node.parentNode;
}
function previousDeep(node) { // prevNode 的輔助函式
if (!node) return null;
while (node.childNodes.length) {
node = node.lastChild;
}
return node;
}
nextNode 的邏輯是「有子先看子,沒子看兄弟,兄弟也沒有就往上找長輩的兄弟」;prevNode 則相反,先鑽到前一個兄弟的最深處。兩者一組,就能像走鏈結串列一樣走遍整棵 DOM 樹。
有了 nextNode 與 prevNode,就能組出更抽象的工具。DOM Level 2 其實已經定義了 Traversal and Range 擴充來處理這類需求,但當時 Internet Explorer 並未實作,因此自建一套反而實際。
// 從 startNode 起,回傳其後所有節點組成的陣列
function listNodes(startNode) {
var list = new Array();
var node = startNode;
while (node) {
list.push(node);
node = nextNode(node);
}
return list;
}
// 反向版本。注意這不等於把 listNodes 的結果反轉
function listNodesReversed(startNode) {
var list = new Array();
var node = startNode;
while (node) {
list.push(node);
node = prevNode(node);
}
return list;
}
// 對清單中每個元素套用 func,回傳結果組成的新清單
function map(list, func) {
var result_list = new Array();
for (var i = 0; i < list.length; i++) {
result_list.push(func(list[i]));
}
return result_list;
}
// 保留 test(node) 為 true 的元素
function filter(list, test) {
var result_list = new Array();
for (var i = 0; i < list.length; i++) {
if (test(list[i])) result_list.push(list[i]);
}
return result_list;
}
這四個工具中,listNodes 可以再加上起止範圍參數,效果類似陣列的 slice;而 map 與 filter 是完全通用的,任何清單都能用,不限於節點清單。把它們組起來,威力就顯現了:
function isElement(node) { return node.nodeType == Node.ELEMENT_NODE; }
function nodeName(node) { return node.nodeName; }
// 依文件順序列出所有元素名稱
var elementNames = map(filter(listNodes(document), isElement), nodeName);
function isText(node) { return node.nodeType == Node.TEXT_NODE; }
function nodeValue(node) { return node.nodeValue; }
// 取出文件中所有文字(不含 CDATA)
var allText = map(filter(listNodes(document), isText), nodeValue);
同一套工具稍作變化,就能用來萃取所有 ID、批次修改樣式、找出特定節點並移除。熟悉函數式編程的人會覺得這套寫法很親切——把簡單的小工具用不同方式組合,去達成各種目的。
解析與序列化不在核心 API 中。把 XML 字串解析成 DOM、或把 DOM 序列化回 XML,這兩件事並未定義在核心 DOM 裡,而是屬於 DOM Level 3 的 Load and Save 擴充,當時尚未普遍實作。各平台(瀏覽器或其他 DOM 應用)都有自己的轉換方法,跨平台的統一寫法不在本文範圍。
不要混用 Level 1 與 Level 2 的 API。在同一份程式中同時使用非命名空間的 createElement 與命名空間感知的 createElementNS,很容易產生無法序列化的樹。若使用命名空間,請在根元素一次宣告完整,並避免覆寫命名空間前綴,否則事後會非常難收拾。
某些 Unicode 字元不能放進 XML。大多數控制字元以及 Unicode 代理對中的單一半個字元都不在 XML 允許範圍內。DOM 的實作通常不阻止你加入它們,但一旦加入,該樹就再也無法序列化為合法 XML。這通常只在你嘗試把二進位資料硬塞進 XML 時才會遇到。
別把 innerHTML 與 DOM API 混著用。如果你已習慣 IE 的 innerText 與 innerHTML,可以試著改用 elem() 這類工具函式,並逐步建立屬於自己的實用函式庫,好處是程式碼能跨平台。把兩種風格摻在一起寫,是最糟的選擇。
DOM 能做的事遠多於本文所列。仔細研讀這些範例,想想它們如何解決那些原本需要客戶端腳本、伺服器端範本或專用 API 才能處理的問題。
DOM 確實有它的侷限與缺點,但優點同樣紮實:它內建於眾多應用程式之中;無論使用 Java、Python 或 JavaScript,它的行為都一致;它與 SAX 搭配起來相當順手;而透過上述這些模板,它既簡潔又強大。支援 DOM 的應用持續增加——Mozilla 系列、OpenOffice、XMetaL 都在其中;需要 DOM 並對它加以擴充的規範也不斷出現,SVG 就是例子。這麼樣一個無處不在的工具,值得你花時間把它用熟。