很多人習慣直接在 HTML 標籤上自刻屬性來存資料,但這種做法有兩個隱憂:一是無法保證未來不會被其他腳本覆蓋掉,二是不符合 HTML 規範,還可能帶來一些意料之外的副作用。HTML5 因此正式納入了自訂 data 屬性,讓這件事有了標準做法。
用法非常簡單:你可以在任何標籤上加任意以 data- 開頭的屬性,這些屬性不會顯示在頁面上,不影響布局與樣式,但可讀可寫。下面這段就是完全合法的 HTML5 標記:
<div id="awesome" data-myid="3e4ae6c4e">Some awesome data</div>
那要怎麼讀取?你当然可以遍歷 DOM 自己找屬性,但 jQuery 已經內建了方法。自 1.4.3 版起,.data(obj) 可以直接取得對應的 data 屬性值:
var myid = jQuery("#awesome").data('myid');
console.log(myid);
更有意思的是,data-* 屬性裡可以放 JSON。例如:
<div id="awesome-json" data-awesome='{"game":"on"}'></div>
取值時直接用 key 就能拿到對應的 value:
var gameStatus = jQuery("#awesome-json").data('awesome').game;
console.log(gameStatus);
寫入則用 .data(key, value):
jQuery("#awesome").data('myid', 'new-value');
不過有一點要放在心上:data-* 屬性應該和它所在的元素有實際關聯,別把它當成四處塞資料的通用倉庫,否則後續維護會很痛苦。
補充:雖然 data-* 是 HTML5 才有的規格,但 jQuery 的 .data() 是通用方法。所以在非 HTML5 的頁面或舊瀏覽器裡,你一樣可以用它來操作 data 資料。