事件檢測要回答的問題是:某一事件在這個瀏覽器上到底存不存在。這在實作時經常是必要的一步,例如 mouseenter/mouseleave 雖然好用,卻不是所有瀏覽器都提供標準支援,因此得自己模擬:
function addEvent(element, name, handler) {
if (name == 'mouseenter' && !hasEvent(name, element)) {
// 透過其他手段模擬 mouseenter
}
// 正常的事件註冊
}
本文要談的就是 hasEvent 的實作,以及它在真實瀏覽器上遭遇的一連串意外。
出發點來自事件的註冊方式。最直觀的是內聯式,在 HTML 中直接寫屬性:
<button onclick="alert('CLICKED!');">CLICK ME</button>
另一種是直接賦值:
document.getElementById('myButton').onclick = function() { alert('CLICKED!'); };
從這兩種寫法可以看出:onclick 其實就是元素的一個屬性,對它賦值即完成註冊。因此最基本的檢測方案,就是看 on[事件名] 這個屬性是否存在于元素上:
function hasEvent(name, element) {
name = name.indexOf('on') ? 'on' + name : name;
element = element || document.createElement('div');
var supported = name in element;
}
兩個細節:事件是以 on[事件名] 形式存在的,所以要視情況補上 'on' 前綴;作為通用函式,未指定元素時用最廣泛支援的 div 作為替代。
有些事件是特定元素獨有的:
用 div 檢測這些會得到錯誤結果,因此替代元素的標籤名要查表決定:
var hasEvent = (function() {
var tags = {
onsubmit: 'form', onreset: 'form',
onselect: 'input', onchange: 'input',
onerror: 'img', onload: 'img', onabort: 'img'
};
return function(name, element) {
name = name.indexOf('on') ? 'on' + name : name;
element = element || document.createElement(tags[name] || 'div');
supported = name in element;
}
})();
用閉包把 tags 作為靜態字典,避免每次呼叫都重建物件。
DOM 元素之所以有 onclick 屬性,是因為它的 __proto__ 上有這個屬性。而 JavaScript 的弱型別機制允許外部程式任意往 __proto__ 添加屬性,進而污染 hasEvent 的結果。以下程式在 Firefox 與 Chrome 上都會得到錯誤答案:
document.createElement('div').__proto__.ontest = function() {};
var supported = hasEvent('test', document.createElement('div')); // true(錯誤)
雖然修改與檢測用的是不同的 div 物件,但 __proto__ 本質上是原型鏈上的同一個物件,因此影響到所有 div。
處理方式是嘗試把原型上該屬性刪掉再測一次。由於原生類型的屬性帶有 DontDelete 標記無法用 delete 移除,所以要包在條件判斷裡:
var temp;
if (supported && (temp = proto[name]) && delete proto[name]) {
supported = name in element; // 刪掉後重測
proto[name] = temp; // 記得還原
}
邏輯很簡單:把可能被掛上去的屬性暫時移開,測完再放回去。
遺憾的是,上面的函式在 Firefox 上仍不完美。以下程式在 Firefox 會回傳 false:
alert('onclick' in document.documentElement); // Firefox 顯示 false
繞道方法是利用另一個事實:多數瀏覽器中,元素以內聯方式註冊事件後,可以透過 element.on[事件名] 取得該函式物件:
<button id="test" onclick="alert('CLICKED!');" ontest="alert('TEST!');">CLICK ME</button>
<script>
var button = document.getElementById('test');
alert(typeof button.onclick); // function
alert(typeof button.ontest); // string
</script>
因此只要把一個表示函式的字串掛到 on[事件名] 屬性上,再看取出的值是否為函式物件即可。在原本的方法回傳 false 時補上這段:
if (!supported) {
element.setAttribute(name, 'return;');
supported = typeof element[name] == 'function';
}
到目前為止,多數 DOM 元素的事件都能檢測,但 window 對象還缺一個完整方案。
IE 系列、Chrome、Safari 都可以用 on[事件名] in window 檢測,只有 Firefox 給出錯誤結果:
alert('onload' in window); // Firefox: false
alert('onunload' in window); // Firefox: false
alert('onerror' in window); // Firefox: false
值得慶幸也值得氣惱的是,Firefox 竟然可以在 div 等元素上檢測到這三個事件。這既造成了對普通元素的誤判,也正好提供了一條出路——把 window 的事件導向 div 去測:
if (!supported) {
if (!element.setAttribute || !element.removeAttribute) {
element = document.createElement('div');
}
element.setAttribute(name, 'return;');
supported = typeof element[name] == 'function';
element.removeAttribute(name);
}
至此一個較完整的 hasEvent 誕生了。它仍有邊界情況(例如 hasEvent('unload', document.createElement('div')) 在 Firefox 會誤回 true),但在絕大多數場景中運作正確。
DOM 規範定義的事件數量有限,而通用檢測(不指定元素)的結果不會變,因此可以快取:
var hasEvent = (function () {
var tags = {
onsubmit: 'form', onreset: 'form',
onselect: 'input', onchange: 'input',
onerror: 'img', onload: 'img', onabort: 'img'
}, cache = {};
return function(name, element) {
name = name.indexOf('on') ? 'on' + name : name;
// 命中快取(僅通用檢測才快取)
if (!element && name in cache) { return cache[name]; }
element = element || document.createElement(tags[name] || 'div');
var proto = element.__proto__ || {},
supported = name in element,
temp;
// 處理在 __proto__ 上掛屬性的情況
if (supported && (temp = proto[name]) && delete proto[name]) {
supported = name in element;
proto[name] = temp;
}
// 處理 Firefox 不給力的情況
if (!supported) {
if (!element.setAttribute || !element.removeAttribute) {
element = document.createElement('div');
}
element.setAttribute(name, 'return;');
supported = typeof element[name] == 'function';
element.removeAttribute(name);
}
cache[name] = supported;
return supported;
};
})();
注意快取只在 !element 時生效——指定了特定元素的檢測結果因人而異,不能快取。
Mutation Event 由 DOM Level 2 定義,在該元素為根的 DOM 樹發生變化時觸發。遺憾的是 hasEvent 無法檢測它們,需要另一套思路。
關鍵線索在於「發生變化時才觸發」這個特性,因此可以反過來操作:
function hasMutationEvent(name, tag, change) {
var element = document.createElement(tag),
supported = false;
function handler() { supported = true; }
// IE9 才開始支援 addEventListener
// 而 IE6-8 確定不支援 Mutation Event,所以這個判斷同時完成了兩件事
if (!element.addEventListener) { return false; }
element.addEventListener(name, handler, false);
change(element); // 觸發變化
element.removeEventListener(name, handler, false);
return supported;
}
例如檢測 DOMAttrModified:
var isDOMAttrModifiedSupported = hasMutationEvent('DOMAttrModified', 'div', function (div) {
div.id = 'new';
});
其他 Mutation Event 只要換一個對應的 change 函式即可。
DOMContentLoaded 在文件載入完成時觸發,但不必等圖片等資源下載完畢,多數框架的 document.ready 都試圖用它。hasEvent 與 hasMutationEvent 都測不到它,但問題不大,因為:這事件和 onload 一樣在頁面生命週期中只觸發一次,不會頻繁使用;且所有支援 addEventListener 的瀏覽器(含 IE9)都支援它,判斷極為簡單。
非標準事件如 mouseenter、mousewheel 等,本來就不在規範中,只能各自處理。
這篇文章的價值已經不在實用性——那些 Firefox 的怪異行為、IE 的 hasLayout、原型鏈污染的防禦,在今日的專案中幾乎都用不到了。但它示範了一套仍然有效的思維方式:
不要問「這是什麼瀏覽器」,要問「這個能力存不存在」。版本號是實作的代理指標,而能力檢測檢驗的是事實本身。當代理指標失準(使用者改了 UA、企業客製版本、新型裝置),事實仍然可靠。
這套思維在今天的寫法是:
// 事件能力檢測——仍然一模一樣
var supportsTouch = 'ontouchstart' in window;
// 其他 API
var hasIO = 'IntersectionObserver' in window;
var hasResizeObs = 'ResizeObserver' in window;
var hasDialog = typeof HTMLDialogElement === 'function';
// CSS 能力檢測——從 JS 搬到了 CSS
@supports (display: grid) { /* ... */ }
其中 @supports 規則的出現尤其值得注意:它把特性檢測從 JavaScript 還原到了 CSS 自己的領域,比用 JS 判斷再動態加 class 乾淨得多。這在某種意義上是「特性檢測」這個概念成熟後的自然歸宿。
哪位無聊的話,可以把所有 Mutation Event 的檢測函式都寫出來……(當然,Mutation Events 早已被標示為 deprecated,取而代之的是 MutationObserver,這又是另一個故事了。)