覺得 MooTools 不可思議?想知道 Dojo 怎麼運作?對 jQuery 的設計感到好奇?最理解一個工具的方式,就是自己把它做一遍。本文從零打造一個名為 dome 的迷你 DOM 框架,逐步走完選擇器、鏈式呼叫、類別操作、屬性、元素建立、插入與事件處理。
先說清楚目標與界線:這不是 jQuery,功能上刻意精簡;我們只針對 Internet Explorer 8+、Firefox 5+、Opera 10+、Chrome 與 Safari;append 與 prepend 只接受我們框架的實例,不處理原生節點與 NodeList。
用立即執行函式(IIFE)把整個框架包起來,避免污染全域:
window.dome = (function () {
function Dome(els) {}
var dome = {
get: function (selector) {}
};
return dome;
}());
Dome 是建構函式,用來包裝我們選到的元素;dome 是對外暴露的框架物件,最後被賦值給 window.dome。
get 的參數可以是字串、DOM 節點,或節點清單:
get: function (selector) {
var els;
if (typeof selector === "string") {
els = document.querySelectorAll(selector);
} else if (selector.length) {
els = selector;
} else {
els = [selector];
}
return new Dome(els);
}
字串就當 CSS 選擇器處理;否則檢查 length,有就是節點清單,沒有就包成單元素陣列。
function Dome(els) {
for (var i = 0; i < els.length; i++) {
this[i] = els[i];
}
this.length = els.length;
}
把元素依序掛到以數字為索引的屬性上,並記下長度。為什麼不直接回傳元素就好?因為包裝成物件之後,我們才能掛上方法——而這些方法要能對集合裡的每個元素一起作用。這正是 jQuery 的核心思路,只是濃縮到了十行以內。
Dome.prototype.map = function (callback) {
var results = [], i = 0;
for (; i < this.length; i++) {
results.push(callback.call(this, this[i], i));
}
return results;
};
Dome.prototype.forEach = function (callback) {
this.map(callback);
return this; // 回傳 this 以支援鏈式呼叫
};
callback.call(this, ...) 讓回呼在 Dome 實例的上下文中執行,並收到「目前元素」與「索引」兩個參數。forEach 借用 map 的走訪邏輯、丟掉回傳值,改回傳 this,於是:
Dome.prototype.someMethod = function (callback) {
return this.forEach(callback); // 自動回傳 Dome 實例
};
Dome.prototype.mapOne = function (callback) {
var m = this.map(callback);
return m.length > 1 ? m : m[0];
};
這裡藏著一個「函式庫哲學」問題。假設我們要寫 text():當集合裡有多個元素時該回傳什麼?jQuery 的 $("li").text() 會把全部文字直接串接成一個字串,這樣做簡單,但很少真的有用。我們的選擇是:多元素時回傳陣列,單元素時直接回傳字串——因為實務上取單一元素的文字遠比取全部的機會多,那就把常見情況優化好。
Dome.prototype.text = function (text) {
if (typeof text !== "undefined") {
return this.forEach(function (el) { el.innerText = text; });
}
return this.mapOne(function (el) { return el.innerText; });
};
Dome.prototype.html = function (html) {
if (typeof html !== "undefined") {
this.forEach(function (el) { el.innerHTML = html; });
return this;
}
return this.mapOne(function (el) { return el.innerHTML; });
};
兩者結構一樣:有參數就設定並回傳 this 以便鏈式呼叫,沒參數就取值。注意判斷用的是 typeof !== "undefined" 而非 if (text),否則傳入空字串會被誤判成「要取值」。
Dome.prototype.addClass = function (classes) {
var className = "";
if (typeof classes !== "string") {
for (var i = 0; i < classes.length; i++) { className += " " + classes[i]; }
} else {
className = " " + classes;
}
return this.forEach(function (el) { el.className += className; });
};
Dome.prototype.removeClass = function (clazz) {
return this.forEach(function (el) {
var cs = el.className.split(" "), i;
while ((i = cs.indexOf(clazz)) > -1) {
cs = cs.slice(0, i).concat(cs.slice(++i));
}
el.className = cs.join(" ");
});
};
IE8 沒有 Array.prototype.indexOf,而 removeClass 用得到它,所以補一個:
if (typeof Array.prototype.indexOf !== "function") {
Array.prototype.indexOf = function (item) {
for (var i = 0; i < this.length; i++) {
if (this[i] === item) { return i; }
}
return -1;
};
}
這不是完整實作(不支援第二個 offset 參數),但足夠用。順帶一提,如今 classList 已是原生標準,上面兩段方法都可以縮成 el.classList.add(...) 與 remove()。
Dome.prototype.attr = function (attr, val) {
if (typeof val !== "undefined") {
return this.forEach(function (el) { el.setAttribute(attr, val); });
}
return this.mapOne(function (el) { return el.getAttribute(attr); });
};
var dome = {
get: function (selector) { /* 前面寫過 */ },
create: function (tagName, attrs) {
var el = new Dome([document.createElement(tagName)]);
if (attrs) {
if (attrs.className) { el.addClass(attrs.className); delete attrs.className; }
if (attrs.text) { el.text(attrs.text); delete attrs.text; }
for (var key in attrs) {
if (attrs.hasOwnProperty(key)) { el.attr(key, attrs[key]); }
}
}
return el;
}
};
className 與 text 走專屬方法,其餘屬性一律用 attr。用完就 delete,避免稍後的 for-in 又處理一次。
Dome.prototype.append = function (els) {
return this.forEach(function (parEl, i) {
els.forEach(function (childEl) {
if (i > 0) { childEl = childEl.cloneNode(true); }
parEl.appendChild(childEl);
});
});
};
這裡有個關鍵細節:把同一個子元素插進多個父元素時,第一次之後必須複製,否則節點會被從上一個位置搬走。外層 forEach 的索引 i 代表父元素的序號,i > 0 時就 clone,因此單對單的情況不會產生多餘的複本。
Dome.prototype.prepend = function (els) {
return this.forEach(function (parEl, i) {
for (var j = els.length - 1; j > -1; j--) {
var childEl = (i > 0) ? els[j].cloneNode(true) : els[j];
parEl.insertBefore(childEl, parEl.firstChild);
}
});
};
prepend 要用倒序迴圈,因為每個元素都插在頭部,正序會讓最終順序反過來。
Dome.prototype.remove = function () {
return this.forEach(function (el) {
return el.parentNode.removeChild(el);
});
};
移除之後這個 Dome 物件依然存在,你還能對它呼叫其他方法——包括把節點再插回去。
Dome.prototype.on = (function () {
if (document.addEventListener) {
return function (evt, fn) {
return this.forEach(function (el) { el.addEventListener(evt, fn, false); });
};
} else if (document.attachEvent) {
return function (evt, fn) {
return this.forEach(function (el) { el.attachEvent("on" + evt, fn); });
};
} else {
return function (evt, fn) {
return this.forEach(function (el) { el["on" + evt] = fn; });
};
}
}());
Dome.prototype.off = (function () {
if (document.removeEventListener) {
return function (evt, fn) {
return this.forEach(function (el) { el.removeEventListener(evt, fn, false); });
};
} else if (document.detachEvent) {
return function (evt, fn) {
return this.forEach(function (el) { el.detachEvent("on" + evt, fn); });
};
} else {
return function (evt, fn) {
return this.forEach(function (el) { el["on" + evt] = null; });
};
}
}());
這裡的巧妙之處是用 IIFE 做一次性特性偵測:偵測在定義時執行一次,之後回傳真正要用的函式並掛到 prototype 上。比起每次呼叫都重新 if 判斷,這在事件大量綁定時差很多。
這個框架不到兩百行,卻涵蓋了四個關鍵概念:用建構函式包裝集合以承載方法、用回傳 this 打造鏈式 API、用 IIFE 做一次性特性偵測、用 getter/setter 共存的單一方法降低 API 數量。
最後強烈建議你做兩件事:一是去讀幾套你喜歡的框架原始碼,你會發現它們的核心比想像中樸素;二是為自己的框架寫測試——本文沒示範,但我第一次實作時就寫了,那才是讓你敢動手重構的底氣。當然,正式專案請直接用原生 API 或成熟函式庫;動手做一遍的價值,在於從此你看每一段 DOM 程式碼的眼神都會不一樣。