萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript 操作 HTML 自訂屬性完整指南:getAttribute/setAttribute/dataset 最佳實踐

HTML 範例



建議使用 data-* 前綴(HTML5 標準),避免未來屬性衝突,並自動對應 dataset API。

原生 DOM API 三種寫法

1. getAttribute / setAttribute(通用、含非 data-*)


var el = document.getElementById('txtBox');

// 讀取
var displayName = el.getAttribute('data-display-name'); // "123456"
var userId = el.getAttribute('data-user-id');           // "42" (字串)

// 寫入
el.setAttribute('data-display-name', 'new-value');
el.setAttribute('data-new-attr', 'hello'); // 新增屬性

2. dataset 屬性(僅 data-*、自動駝峰轉換、效能較好)


// 讀取
var displayName = el.dataset.displayName; // "123456" (自動 kebab-case → camelCase)
var userId = el.dataset.userId;           // "42"

// 寫入
el.dataset.displayName = 'new-value';
el.dataset.newAttr = 'hello'; // 自動轉為 data-new-attr

// 刪除
delete el.dataset.displayName; // 移除屬性

// 列舉所有 data-* 屬性
console.log(el.dataset); // DOMStringMap { displayName: "new-value", userId: "42", newAttr: "hello" }

3. attributes 集合(底層、罕用)


var attrs = el.attributes; // NamedNodeMap
var displayName = attrs['data-display-name'].nodeValue; // "123456"
attrs['data-display-name'].nodeValue = 'new-value';     // 寫入

jQuery 封裝方法


var $el = $('#txtBox');

// .attr():操作 HTML 屬性(含 data-*),回傳字串
$el.attr('data-display-name');        // "123456"
$el.attr('data-display-name', 'new'); // 設定

// .data():操作 jQuery 內部資料快取(不寫入 DOM)、自動型別轉換
$el.data('display-name');             // "123456" (字串)
$el.data('user-id');                  // 42 (數值!自動 parse)
$data = $el.data();                   // 取得所有 data 快取物件

// 重要差異:
$el.attr('data-foo', 'bar'); // 更新 DOM 屬性
$el.data('foo', 'baz');      // 僅更新記憶體快取,DOM 不變
$el.data('foo');             // 回傳 'baz' (優先讀快取)
$el.attr('data-foo');        // 回傳 'bar' (讀 DOM)

型別轉換陷阱與對策

API回傳型別數值/布林/JSON 自動轉換適用場景
getAttributeString否需原始字串、非 data-* 屬性
datasetString否現代標準、data-* 專用、效能佳
jQuery .attr()String否舊專案、非 data-*、需 DOM 同步
jQuery .data()Any (自動解析)是 (Number/Boolean/Object/Array)應用層資料儲存、效能敏感、不需 DOM 同步

最佳實踐建議

  1. 優先使用 dataset:原生、無依賴、語意明確、效能最佳。
  2. 區分「設定屬性」與「儲存資料」:需 CSS 選擇器 [data-x]、SEO、SSR 同步 → setAttribute/dataset;純邏輯狀態、複雜物件 → .data()。
  3. 布林屬性:<div data-enabled> → dataset.enabled === ''(空字串),判斷用 'enabled' in dataset。
  4. 命名規範:data-user-id、data-api-url(kebab-case),JS 存取自動轉 camelCase。

結語

HTML5 data-* + dataset API 是現代標準,搭配 jQuery .data() 內部快取機制,能優雅區分「DOM 屬性」與「應用狀態」,避免型別轉換驚喜與效能浪費。

copyright © 萬盛學電腦網 all rights reserved