萬盛學電腦網

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

JavaScript 精準檢測表單是否被修改:formIsDirty 完整實現與最佳實踐

核心需求

用戶編輯表單後未保存就嘗試離開頁面(關閉標籤、跳轉鏈接、點擊瀏覽器後退),需彈出確認提示:「您有未保存的更改,確定要離開嗎?」

通用檢測函數

/**
 * 檢測表單是否被用戶修改
 * @param {HTMLFormElement} form - 表單 DOM 元素
 * @returns {boolean} true=已修改,false=未修改
 */
function formIsDirty(form) {
  for (var i = 0; i < form.elements.length; i++) {
    var el = form.elements[i];
    var type = el.type;
    var tag = el.tagName.toLowerCase();
    
    // checkbox / radio:比較 checked vs defaultChecked
    if (type === 'checkbox' || type === 'radio') {
      if (el.checked !== el.defaultChecked) return true;
    }
    // input/textarea/select:比較 value vs defaultValue
    else if (type === 'text' || type === 'textarea' || type === 'password' || 
             type === 'hidden' || type === 'email' || type === 'number' || 
             type === 'search' || type === 'tel' || type === 'url' ||
             tag === 'select') {
      // select 需遍歷 options 比較 selected vs defaultSelected
      if (tag === 'select') {
        for (var j = 0; j < el.options.length; j++) {
          if (el.options[j].selected !== el.options[j].defaultSelected) return true;
        }
      } else if (el.value !== el.defaultValue) {
        return true;
      }
    }
    // file、button、reset、submit 等不參與髒值判斷
  }
  return false;
}

頁面離開攔截

window.addEventListener('beforeunload', function(e) {
  var form = document.forms['myForm']; // 或 document.querySelector('form')
  if (formIsDirty(form)) {
    // 標準寫法:設置 returnValue(舊瀏覽器)並返回字符串(部分瀏覽器)
    var msg = '您有未保存的更改,確定要離開嗎?';
    e.returnValue = msg;      // Chrome、Firefox、IE
    return msg;               // Safari、舊版 Firefox
  }
});

// 可選:表單提交後標記為「已保存」,避免誤觸發
form.addEventListener('submit', function() {
  // 重置 defaultValue/defaultChecked 為當前值
  Array.from(form.elements).forEach(function(el) {
    if (el.type === 'checkbox' || el.type === 'radio') {
      el.defaultChecked = el.checked;
    } else if (el.tagName === 'SELECT') {
      Array.from(el.options).forEach(function(opt) {
        opt.defaultSelected = opt.selected;
      });
    } else {
      el.defaultValue = el.value;
    }
  });
});

現代增強:原生 FormData 對比(更簡潔)

function formIsDirtyModern(form) {
  var current = new FormData(form);
  var initial = new FormData();
  
  // 構建初始值 FormData(需在頁面加載時捕獲)
  // 建議:頁面加載時保存初始 FormData 快照
  // var initialSnapshot = new FormData(form); // 在 DOMContentLoaded 時執行
  
  // 對比:此處為演示邏輯,實際需存儲 initialSnapshot
  for (var pair of current.entries()) {
    if (current.get(pair[0]) !== initialSnapshot.get(pair[0])) return true;
  }
  // 檢查是否有字段被刪除
  for (var pair of initialSnapshot.entries()) {
    if (!current.has(pair[0])) return true;
  }
  return false;
}

完整可運行示例

<!DOCTYPE html>
<html><head><meta charset="utf-8"><style>
form { max-width:400px; margin:20px auto; }
label { display:block; margin:10px 0; }
</style></head><body>

<form name="demoForm">
  <label>文本: <input type="text" name="txt" value="初始值"></label>
  <label>多行: <textarea name="ta">初始文本</textarea></label>
  <label>單選: 
    <label><input type="radio" name="sex" value="m" checked>男</label>
    <label><input type="radio" name="sex" value="f">女</label>
  </label>
  <label>複選: <input type="checkbox" name="agree" checked>同意</label>
  <label>下拉: 
    <select name="city">
      <option value="bj" selected>北京</option>
      <option value="sh">上海</option>
    </select>
  </label>
  <button type="button" onclick="alert(formIsDirty(document.demoForm) ? '已修改' : '未修改')">檢測狀態</button>
  <button type="submit">提交(重置檢測基準)</button>
</form>

<script>
// 上方 formIsDirty 函數代碼

// 頁面加載時捕獲初始快照(用於現代方案對比)
var initialSnapshot = new FormData(document.demoForm);

// 提交時更新快照
document.demoForm.addEventListener('submit', function(e) {
  e.preventDefault();
  initialSnapshot = new FormData(this);
  alert('已提交,檢測基準已更新');
});

// 離開頁面攔截
window.addEventListener('beforeunload', function(e) {
  if (formIsDirty(document.demoForm)) {
    e.returnValue = '您有未保存的更改,確定要離開嗎?';
    return e.returnValue;
  }
});
</script>
</body></html>

進階場景處理

場景處理策略
動態新增/刪除字段維護字段名白名單,僅檢測白名單內字段
富文本編輯器調用編輯器 API 獲取內容,納入檢測範圍
文件上傳 inputfiles 屬性無 defaultValue,需自定義標記
嵌套表單/字段集遞歸遍歷 form.elements 或 form.querySelectorAll
防抖檢測輸入時延遲 500ms 更新「已修改」標記,減少 beforeunload 判斷開銷

總結

formIsDirty 核心在於對比 當前值 vs 初始默認值。原生 defaultValue/defaultChecked/defaultSelected 提供了零成本的基準線,無需額外存儲。配合 beforeunload 事件與表單提交時的基準線重置,即可構建健壯的「未保存提醒」體驗。現代項目中,FormData 對比法語義更清晰,但需手動管理快照生命週期。

copyright © 萬盛學電腦網 all rights reserved