萬盛學電腦網

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

JavaScript 檢查表單是否被修改 (Dirty Check) 完整實作

前言

在使用者離開頁面前,偵測表單是否有未儲存變更,可防止資料遺失。本文提供通用的 formIsDirty(form) 函數,支援所有表單控件類型,並示範整合 beforeunload 事件提示使用者。

核心檢查函數 (原生 JS,零依賴)

/**
 * 檢查表單是否有變更
 * @param {HTMLFormElement} form
 * @returns {boolean} true=有變更, false=無變更
 */
function formIsDirty(form) {
    for (const el of form.elements) {
        const type = el.type;
        const tag = el.tagName.toLowerCase();

        // 單選/複選框:比較 checked vs defaultChecked
        if (type === 'checkbox' || type === 'radio') {
            if (el.checked !== el.defaultChecked) return true;
        }
        // 輸入類:比較 value vs defaultValue
        else if (['hidden', 'password', 'text', 'textarea', 'email', 'number', 'tel', 'url', 'search', 'date', 'datetime-local', 'month', 'week', 'time', 'color'].includes(type)) {
            if (el.value !== el.defaultValue) return true;
        }
        // 下拉選單:比較每個 option 的 selected vs defaultSelected
        else if (tag === 'select') {
            for (const opt of el.options) {
                if (opt.selected !== opt.defaultSelected) return true;
            }
        }
        // file 輸入:有檔案即視為 dirty
        else if (type === 'file') {
            if (el.files.length > 0) return true;
        }
    }
    return false;
}

整合 beforeunload 事件

window.addEventListener('beforeunload', (e) => {
    const form = document.forms['someForm']; // 或 document.querySelector('form')
    if (form && formIsDirty(form)) {
        // 現代瀏覽器忽略自訂訊息,顯示預設提示
        e.preventDefault();
        e.returnValue = ''; // Chrome/FF 需要
        // return '您有未儲存的變更,確定離開嗎?'; // 舊版支援
    }
});

進階:支援動態表單、AJAX 存檔、忽略特定欄位

class FormDirtyChecker {
    constructor(form, options = {}) {
        this.form = form;
        this.ignoreNames = new Set(options.ignoreNames || []); // 如 ['_token', 'timestamp']
        this.initialSnapshot = this._snapshot();
        this.isSubmitting = false;

        // 表單提交時標記,避免觸發 beforeunload
        form.addEventListener('submit', () => this.isSubmitting = true);
        // AJAX 存檔後更新快照
        this.save = () => { this.initialSnapshot = this._snapshot(); };
    }

    _snapshot() {
        const data = {};
        for (const el of this.form.elements) {
            if (this.ignoreNames.has(el.name)) continue;
            if (el.type === 'checkbox' || el.type === 'radio') data[el.name] = el.checked;
            else if (el.type === 'select-multiple') data[el.name] = Array.from(el.selectedOptions).map(o => o.value);
            else data[el.name] = el.value;
        }
        return data;
    }

    isDirty() {
        if (this.isSubmitting) return false;
        const current = this._snapshot();
        return JSON.stringify(current) !== JSON.stringify(this.initialSnapshot);
    }

    bindBeforeUnload(message = '您有未儲存的變更。') {
        window.addEventListener('beforeunload', (e) => {
            if (this.isDirty()) {
                e.preventDefault();
                e.returnValue = message;
                return message;
            }
        });
    }
}

// 使用
const checker = new FormDirtyChecker(document.forms[0], { ignoreNames: ['_csrf'] });
checker.bindBeforeUnload();

// AJAX 存檔成功後
await saveFormData();
checker.save(); // 更新基準快照

現代替代:原生 FormData 比較

function formIsDirtyModern(form) {
    const initial = new FormData(form); // 頁面載入時建立
    // ...
    const current = new FormData(form);
    // 比較:需手動迭代,因 FormData 無直接比較方法
    for (const [key, val] of current) {
        if (initial.getAll(key).join(',') !== val) return true;
    }
    // 檢查是否有欄位被移除
    for (const key of initial.keys()) {
        if (!current.has(key)) return true;
    }
    return false;
}

注意事項

  • defaultValue/defaultChecked/defaultSelected 反映 **HTML 初始屬性值**,不會隨 JS 修改而變。若 JS 初始化設值,需手動同步 el.defaultValue = el.value。
  • beforeunload 事件在使用者未互動過頁面時可能不觸發 (Chrome 60+),建議在表單首次聚焦時才綁定。
  • 行動裝置瀏覽器對 beforeunload 支援度不一,需實測。
  • 富文本編輯器、自訂元件需自行實作 isDirty 介面整合。
copyright © 萬盛學電腦網 all rights reserved