each() 是 jQuery 裡被使用最频繁的內部工具之一,從 addClass() 到 type 映射表都靠它。理解它的實作,也就理解了 jQuery 物件「為什麼像陣列又不是陣列」。
$('div').each(function (index, elem) {
$(this).addClass('red');
});
jQuery.fn.each 就是 $.fn.each,也就是我們在 jQuery 物件上呼叫的那個版本。官方文件只有兩個重點:
this 指的是當前正在處理的原生 DOM 元素false 時,跳出整個迴圈/**
* @description 對 jQuery 物件中匹配的每個 DOM 元素執行一個方法
* @param {Number} index 當前處理元素在集合中的位置
* @param {DOMElement} Element 當前處理的 DOM 元素
*/
.each(function (index, Element))
兩個實際例子:
// 給所有 div 加上 red 類
$('div').each(function (index, elem) {
$(this).addClass('red');
});
// 只給前 5 個 div 加上 red 類
$('div').each(function (index, elem) {
if (index >= 5) return false; // 跳出迴圈
$(this).addClass('red');
});
它的原始碼短到不像真的——只是把 this 轉交給 jQuery.each:
each: function (callback, args) {
return jQuery.each(this, callback, args);
}
$.each([52, 97], function (index, value) {
alert(index + ': ' + value + ':' + this);
});
輸出:
0: 52: 52
1: 97: 97
規格同樣是兩點:this 是集合中的元素(也就是第二個參數 valueOfElement);回呼回傳 false 可跳出迴圈。
/**
* @description 對集合(陣列或物件)中的每個元素執行某個操作
* @param {Number|String} indexInArray 元素在集合中對應的位置
* @param {AnyValue} valueOfElement 集合中的元素
*/
jQuery.each(collection, callback(indexInArray, valueOfElement))
// 陣列:遇到 index >= 2 就停止
$.each(['one', 'two', 'three', 'four'], function (index, value) {
if (index >= 2) return false;
alert("Index:" + index + ", value: " + value);
});
// 物件:key 與 value
$.each({ name: "John", lang: "JS" }, function (k, v) {
alert("Key: " + k + ", Value: " + v);
});
// args 僅供內部使用
each: function (obj, callback, args) {
var value,
i = 0,
length = obj.length,
isArray = isArraylike(obj); // 是否為「類陣列」物件
if (args) { // 內部呼叫用的分支
if (isArray) {
for (; i < length; i++) {
value = callback.apply(obj[i], args);
if (value === false) break;
}
} else {
for (i in obj) {
value = callback.apply(obj[i], args);
if (value === false) break;
}
}
} else {
// 最常見的用法走這裡,刻意寫成快速路徑
if (isArray) { // 處理陣列
for (; i < length; i++) {
value = callback.call(obj[i], i, obj[i]);
if (value === false) break;
}
} else { // 處理物件
for (i in obj) {
value = callback.call(obj[i], i, obj[i]);
if (value === false) break;
}
}
}
return obj;
}
幾個值得留意的設計決定:
用 call 而非 apply 綁 this。callback.call(obj[i], i, obj[i]) 把 obj[i] 當作 this,同時傳入索引與值。這正是 jQuery 集合裡 this 能指向原生 DOM 元素的原因。
isArraylike 是關鍵。jQuery 物件本身不是真陣列,它只是一個「有 length 屬性、用數字鍵存元素」的普通物件。靠 isArraylike() 判斷後走 for 迴圈,就能用索引快速取值;否則退回 for...in 遍歷鍵。
args 分支是內部用的。這條路徑存在是為了讓 jQuery.map()、jQuery.grep() 這些內部方法共用同一套遍歷邏輯,一般開發者不會用到。
回傳 obj 本身。所以 $.each() 的結果可以繼續被鏈式使用。
和 jQuery.extend 一樣,這兩支函式程式碼極短,卻撐起了整個框架。舉例來說,jQuery 用來建立型別映射表的程式就是靠它:
jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function (i, name) {
class2type["[object " + name + "]"] = name.toLowerCase();
});
把 each() 讀通,jQuery 大量「對集合做同一件事」的語法就都說得通了。