jQuery 官方對 .data() 的描述是:在符合的元素上儲存任意相關資料,或回傳符合元素集合中第一個元素的指定名稱資料。
存入鍵值:
$("body").data("foo", 52);
$("body").data("bar", { myType: "test", count: 40 });
$("body").data({ baz: [1, 2, 3] });
取出鍵值:
$("body").data("foo"); // 52
$("body").data(); // { foo: 52, bar: { myType: "test", count: 40 }, baz: [1, 2, 3] }
這些都很直觀。但看 Bootstrap 的彈窗遮罩原始碼時,有一段讓人困惑:
$(document).on('click.modal.data-api', '[data-toggle="modal"]', function (e) {
alert($(this).data().toggle) // 這行是為了測試加的,印出的值是 modal
var $this = $(this),
href = $this.attr('href'),
$target = $($this.attr('data-target') || (href && href.replace(/.*(?=#[^\s]+$)/, ''))),
option = $target.data('modal') ? 'toggle' : $.extend({ remote: !/#/.test(href) && href }, $target.data(), $this.data());
e.preventDefault();
$target.modal(option).one('hide', function () { $this.focus(); });
});
奇怪的是,$(this).data() 明明是呼叫 jQuery 的方法,我們從來沒手動存過任何資料,它卻回傳了 {toggle: "modal"}。這個值是哪來的?
被綁定 click 的元素長這樣:
<a href="#myModal" role="button" class="btn" data-toggle="modal">Launch demo modal</a>
比對一下就發現:$(this).data() 的內容剛好和這個元素的 data-* 屬性一模一樣。所以問題變成「jQuery 什麼時候把它讀進來的」。翻原始碼,jQuery.fn.data 裡有這一段:
// Gets all values
if (key === undefined) {
if (this.length) {
data = jQuery.data(elem);
if (elem.nodeType === 1 && !jQuery._data(elem, "parsedAttrs")) {
attrs = elem.attributes;
for (; i < attrs.length; i++) {
name = attrs[i].name;
if (name.indexOf("data-") === 0) {
name = jQuery.camelCase(name.slice(5));
dataAttr(elem, name, data[name]);
}
}
jQuery._data(elem, "parsedAttrs", true);
}
}
return data;
}
也就是說:當 .data() 不帶參數呼叫時,jQuery 會遍歷元素的所有屬性,把名稱以 data- 開頭的挑出來,去掉前綴、轉成駝峰命名,然後放進資料物件裡。
所以 data-toggle="modal" 就變成了 { toggle: "modal" }。而 _data(elem, "parsedAttrs") 這個旗標確保這件事只做一次,不會每次呼叫都重新掃描。
jQuery 的說明文件裡有一段專門講這件事:
自 jQuery 1.4.3 起,HTML5 的 data- 屬性會自動被引用到 jQuery 的資料物件中。嵌入式破折號的處理方式在 jQuery 1.6 中有所調整,以符合 W3C HTML5 規範。
給定這樣的 HTML:
<div data-role="page"
data-last-value="43"
data-hidden="true"
data-options='{"name":"John"}'></div>
下面這些程式碼全部成立:
$("div").data("role") === "page"; // true
$("div").data("lastValue") === 43; // true,注意已轉為數字
$("div").data("hidden") === true; // true,注意已轉為布林
$("div").data("options").name === "John";// true,JSON 字串會被解析成物件
data-* 是 HTML 與 JavaScript 之間的資料通道。你可以把設定值直接寫在標籤上,JavaScript 用 .data() 讀取,不必再解析自訂屬性或用隱藏欄位傳遞。Bootstrap 正是靠這個機制做到「不用寫 JavaScript,光加 data-toggle="modal" 就能啟動元件」。
型別會被自動轉換。"43" 變成數字 43、"true" 變成布林、合法 JSON 字串變成物件。這很方便,但也要小心:如果你真的需要字串 "43",用 .data() 會拿到數字,這種情況請改用 .attr("data-last-value")。
駝峰轉換規則。data-last-value 對應 lastValue,data-myURL 對應 myURL(jQuery 1.6 之後依 HTML5 規範處理連續大寫)。自訂屬性時,用 kebab-case 寫 HTML、camelCase 讀 JavaScript,是最不容易出錯的組合。