同樣是操作 XML,IE 與 Mozilla 系瀏覽器的 API 差異相當明顯。搞不清楚這些差別,寫出來的程式碼往往只在單一瀏覽器上跑得動。
微軟透過 ActiveX 的 MSXML 元件提供支援,最基本的建立方式如下(以 IE6 為例):
var oXMLDom = new ActiveXObject("MSXML2.DOMDocument.5.0");
若使用者裝的是較舊的 MSXML 版本,就得逐一嘗試不同的 ProgID。實務上比較保險的做法是寫成一個相容函數:
function createXMLDOM() {
var arrSignatures = [
"MSXML2.DOMDocument.5.0",
"MSXML2.DOMDocument.4.0",
"MSXML2.DOMDocument.3.0",
"MSXML2.DOMDocument",
"Microsoft.XMLDOM"
];
for (var i = 0; i < arrSignatures.length; i++) {
try {
return new ActiveXObject(arrSignatures[i]);
} catch (oError) {
// 忽略,繼續嘗試下一個
}
}
throw new Error("你的系統沒有安裝 MSXML");
}
如果你手邊有 prototype 函式庫,也可以直接用 Try.these 來達到同樣效果。
載入資料:IE 的 XML DOM 同時提供 load() 與 loadXML(),前者讀檔、後者讀字串:
oXMLDom.load("test.xml");
oXmlDom.loadXML("<root></root>");
載入完成後,就能使用標準 DOM 方法,例如 documentElement.tagName。
同步與非同步:預設是非同步載入,可透過 async 屬性切換:
oXMLDom.async = true;
readyState 狀態值:0 為準備載入、1 為載入中、2 為載入完成、3 為可用但部分資料可能尚未就緒、4 為完全載入且完全可用。對應的 onreadystatechange 事件會在狀態改變時觸發:
oXMLDom.onreadystatechange = function () {
if (oXMLDom.readyState == 4) {
alert("load test.xml done!");
alert("根元素名稱:" + oXMLDom.documentElement.tagName);
alert("根元素子節點數:" + oXMLDom.documentElement.childNodes.length);
}
};
xml 屬性:IE 提供 xml 屬性直接取得 XML 字串:
oXMLDom.async = false;
oXMLDom.load("test.xml");
alert(oXmlDom.xml);
// 輸出 <root><child/><child/></root>
錯誤處理:解析失敗時會產生 parseError 物件,errorCode 為 0 代表沒有錯誤:
oXMLDom.async = false;
oXMLDom.load("errors.xml");
if (oXMLDom.parseError != 0) {
var oError = oXMLDom.parseError;
alert("發生錯誤:\n錯誤碼:" + oError.errorCode +
"\n行數:" + oError.line +
"\n列數:" + oError.linepos +
"\n原因:" + oError.reason);
}
建立方式:Mozilla 走 DOM 標準,用 document.implementation.createDocument()。三個參數依序是命名空間、根元素標籤名與文件型別物件(固定傳 null):
var oXMLDom = document.implementation.createDocument("https://www.rubyeye.net", "root", null);
// 等同建立 <a0:root xmlns="https://www.rubyeye.net" />
載入:Mozilla 只有 load(),沒有 loadXML()。同步載入與 IE 相同:
oXMLDom.async = false;
oXMLDom.load("test.xml");
非同步載入則有明顯差異——Mozilla 不支援 readyState,也沒有 onreadystatechange,只有 onload 事件,相當於 IE 中 readyState 等於 4 的那一刻:
oXMLDom.onload = function () { alert("done"); };
oXMLDom.load("test.xml");
要把字串解析成 DOM,必須借助 DOMParser:
var oParser = new DOMParser();
var oXMLDom = oParser.parseFromString("<root><child/></root>", "text/xml");
兩個參數分別是要解析的字串與內容型別(僅接受 text/xml 或 application/xml)。既然少了 loadXML(),我們可以自己補一個:
Document.prototype.loadXML = function (sXML) {
var oParser = new DOMParser();
var oXmlDom = oParser.parseFromString(sXML, "text/xml");
// 清掉原有內容
while (this.firstChild) {
this.removeChild(this.firstChild);
}
// 匯入新內容
for (var i = 0; i < oXmlDom.childNodes.length; i++) {
this.appendChild(this.importNode(oXmlDom.childNodes[i], true));
}
};
取得 XML 字串:Mozilla 沒有 xml 屬性,得用 XMLSerializer:
var oSerializer = new XMLSerializer(); var sXml = oSerializer.serializeToString(oXMLDom, "text/xml");
同樣可以透過 __defineGetter__ 補上一個 xml 屬性,讓寫法與 IE 對齊:
Node.prototype.__defineGetter__("xml", function () {
var oSerializer = new XMLSerializer();
return oSerializer.serializeToString(this, "text/xml");
});
錯誤處理:這裡差最大。Mozilla 解析失敗時,會回傳一段以 <parsererror> 包住的說明文字,只能靠正則表達式把錯誤資訊抓出來:
var reError = />([\s\S]*?)Location:([\s\S]*?)Line Number (\d+), Column (\d+):<sourcetext>([\s\S]*?)(?:\-*\^)/;
if (oXMLDom.documentElement.tagName == "parsererror") {
reError.test(oXmlDom.xml);
alert("發生錯誤:\n描述:" + RegExp.$1 +
"\n檔案:" + RegExp.$2 +
"\n行數:" + RegExp.$3 +
"\n列數:" + RegExp.$4 +
"\n原因:" + RegExp.$5);
}
以下封裝來自《JavaScript 高級程序設計》,用物件/屬性偵測判斷環境,並替 Mozilla 補上 readyState、onreadystatechange、loadXML() 與 xml 屬性等介面,讓呼叫端不必再寫分支:
function XMLDom() {
// 物件/屬性偵測,判斷是 IE 還是 Mozilla
if (window.ActiveXObject) {
var arrSignatures = [
"MSXML2.DOMDocument.5.0",
"MSXML2.DOMDocument.4.0",
"MSXML2.DOMDocument.3.0",
"MSXML2.DOMDocument",
"Microsoft.XMLDOM"
];
for (var i = 0; i < arrSignatures.length; i++) {
try {
return new ActiveXObject(arrSignatures[i]);
} catch (oError) {
// 忽略
}
}
throw new Error("MSXML is not installed on your system.");
} else if (document.implementation && document.implementation.createDocument) {
var oXMLDom = document.implementation.createDocument("", "", null);
// 建立 Mozilla 版的 parseError 物件
oXMLDom.parseError = {
valueOf: function () { return this.errorCode; },
toString: function () { return this.errorCode.toString(); }
};
oXMLDom.__initError__();
oXMLDom.addEventListener("load", function () {
this.__checkForErrors__();
this.__changeReadyState__(4);
}, false);
return oXMLDom;
} else {
throw new Error("Your browser doesn't support an XML DOM object.");
}
}
// 以下用到該書的瀏覽器偵測 JS 檔,判斷是否為 Mozilla
if (isMoz) {
Document.prototype.readyState = 0;
Document.prototype.onreadystatechange = null;
Document.prototype.__changeReadyState__ = function (iReadyState) {
this.readyState = iReadyState;
if (typeof this.onreadystatechange == "function") {
this.onreadystatechange();
}
};
Document.prototype.__initError__ = function () {
this.parseError.errorCode = 0;
this.parseError.filepos = -1;
this.parseError.line = -1;
this.parseError.linepos = -1;
this.parseError.reason = null;
this.parseError.srcText = null;
this.parseError.url = null;
};
Document.prototype.__checkForErrors__ = function () {
if (this.documentElement.tagName == "parsererror") {
var reError = />([\s\S]*?)Location:([\s\S]*?)Line Number (\d+), Column (\d+):<sourcetext>([\s\S]*?)(?:\-*\^)/;
reError.test(this.xml);
this.parseError.errorCode = -999999;
this.parseError.reason = RegExp.$1;
this.parseError.url = RegExp.$2;
this.parseError.line = parseInt(RegExp.$3);
this.parseError.linepos = parseInt(RegExp.$4);
this.parseError.srcText = RegExp.$5;
}
};
// 定義 Mozilla 的 loadXML 方法
Document.prototype.loadXML = function (sXML) {
this.__initError__();
this.__changeReadyState__(1);
var oParser = new DOMParser();
var oXmlDom = oParser.parseFromString(sXML, "text/xml");
while (this.firstChild) {
this.removeChild(this.firstChild);
}
for (var i = 0; i < oXmlDom.childNodes.length; i++) {
this.appendChild(this.importNode(oXmlDom.childNodes[i], true));
}
this.__checkForErrors__();
this.__changeReadyState__(4);
};
Document.prototype.__load__ = Document.prototype.load;
Document.prototype.load = function (sURL) {
this.__initError__();
this.__changeReadyState__(1);
this.__load__(sURL);
};
Node.prototype.__defineGetter__("xml", function () {
var oSerializer = new XMLSerializer();
return oSerializer.serializeToString(this, "text/xml");
});
}
值得一提的是,如今各瀏覽器都已普遍支援 DOMParser 與標準 DOM 方法,這類相容封裝在現代專案中已很少需要;但在維護老系統時,理解背後的差異與補丁邏輯仍然很有價值。