萬盛學電腦網

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

通用表單驗證器封裝:聲明式規則、非空/正則/下拉/複選框驗證、回調擴展

設計目標

  • 零侵入 HTML:僅靠 class/data-* 屬性聲明規則
  • 多表單隔離:單頁多表單互不干擾
  • 擴展性:支援自定義正則、異步驗證、提交/確認回調
  • 無依賴核心:核心邏輯原生 JS,jQuery 僅作 DOM 便利(可替換)

HTML 聲明式規範

<form class="js-form" novalidate>
  <!-- 容器標記 -->
  <div class="form-group">
    <label for="username">用戶名</label>
    <input type="text" id="username" name="username"
           class="js-validate"
           data-rule-required="true"
           data-msg-required="用戶名不能為空"
           data-rule-pattern="^[a-zA-Z0-9_]{3,16}$"
           data-msg-pattern="用戶名只能字母數字下劃線,3-16位">
    <span class="form-error" aria-live="polite"></span>
  </div>

  <div class="form-group">
    <label for="email">郵箱</label>
    <input type="email" id="email" name="email"
           class="js-validate"
           data-rule-required="true"
           data-msg-required="郵箱不能為空"
           data-rule-pattern="^[^@\s]+@[^@\s]+\.[^@\s]+$"
           data-msg-pattern="郵箱格式不正確">
    <span class="form-error" aria-live="polite"></span>
  </div>

  <div class="form-group">
    <label>角色</label>
    <select name="role" class="js-validate"
            data-rule-required="true"
            data-msg-required="請選擇角色">
      <option value="">請選擇角色</option>
      <option value="admin">管理員</option>
      <option value="user">普通用戶</option>
    </select>
    <span class="form-error" aria-live="polite"></span>
  </div>

  <div class="form-group">
    <label>協議</label>
    <label><input type="checkbox" name="agree" value="1"
           class="js-validate"
           data-rule-required="true"
           data-msg-required="必須同意協議"> 我已閱讀並同意</label>
    <span class="form-error" aria-live="polite"></span>
  </div>

  <button type="submit" class="js-submit">提交</button>
  <button type="button" class="js-confirm" title="確定刪除?">刪除</button>
</form>

核心驗證器實現

var Validator = (function () {
  var DEFAULT_MSG = {
    required: '此欄位為必填',
    pattern: '格式不正確',
    email: '郵箱格式不正確',
    url: '網址格式不正確',
    number: '請輸入數字',
    minlength: '長度不足',
    maxlength: '超過最大長度',
    min: '數值過小',
    max: '數值過大'
  };

  function getMsg(el, rule) {
    return el.dataset['msg' + rule.charAt(0).toUpperCase() + rule.slice(1)] || DEFAULT_MSG[rule];
  }

  function validateField(el) {
    var $el = $(el);
    var rules = [];

    // 收集 data-rule-* 屬性
    $.each(el.attributes, function () {
      if (this.name.indexOf('data-rule-') === 0) {
        var rule = this.name.slice(10); // 去掉 'data-rule-'
        rules.push({ name: rule, value: this.value });
      }
    });

    for (var i = 0; i < rules.length; i++) {
      var rule = rules[i];
      var ok = true;

      switch (rule.name) {
        case 'required':
          ok = $.trim($el.val()).length > 0 &&
               ($el.is(':checkbox,:radio') ? $el.prop('checked') : true);
          break;
        case 'pattern':
          ok = new RegExp(rule.value).test($.trim($el.val()));
          break;
        case 'email':
          ok = /^[^@\s]+@[^@\s]+\.[^@\s]+$/.test($.trim($el.val()));
          break;
        case 'url':
          ok = /^https?:\/\//.test($.trim($el.val()));
          break;
        case 'number':
          ok = !isNaN($.trim($el.val())) && $.trim($el.val()) !== '';
          break;
        case 'minlength':
          ok = $.trim($el.val()).length >= parseInt(rule.value, 10);
          break;
        case 'maxlength':
          ok = $.trim($el.val()).length <= parseInt(rule.value, 10);
          break;
        case 'min':
          ok = parseFloat($el.val()) >= parseFloat(rule.value);
          break;
        case 'max':
          ok = parseFloat($el.val()) <= parseFloat(rule.value);
          break;
        default:
          // 自定義規則:data-rule-custom="fnName" → window.fnName(val, el)
          if (typeof window[rule.value] === 'function') {
            ok = window[rule.value]($.trim($el.val()), el);
          }
      }

      if (!ok) {
        return { valid: false, message: getMsg(el, rule.name) };
      }
    }
    return { valid: true };
  }

  function showError($form, message) {
    $form.find('.form-error').first().text(message).show();
  }

  function clearErrors($form) {
    $form.find('.form-error').text('').hide();
  }

  return {
    validateForm: function ($form) {
      var valid = true;
      clearErrors($form);
      $form.find('.js-validate').each(function () {
        var res = validateField(this);
        if (!res.valid) {
          showError($form, res.message);
          $(this).focus().select();
          valid = false;
          return false; // break each
        }
      });
      return valid;
    },
    validateField: validateField
  };
})();

// 全域回調掛載點
window.FormCallbacks = {
  onSubmit: null,   // function(form, e) { return true/false; }
  onConfirm: null   // function(btn, e) { return true/false; }
};

統一事件綁定入口

$(function () {
  // 1. 表單提交
  $('.js-form').on('click', '.js-submit', function (e) {
    var $form = $(this).closest('.js-form');
    var ok = Validator.validateForm($form);
    if (ok && window.FormCallbacks.onSubmit) {
      ok = window.FormCallbacks.onSubmit.call($form[0], e) !== false;
    }
    if (!ok) e.preventDefault();
    return ok;
  });

  // 2. 確認對話框
  $('.js-form').on('click', '.js-confirm', function (e) {
    var $btn = $(this);
    var msg = $btn.attr('title') || '確定執行此操作?';
    var ok = confirm(msg);
    if (ok && window.FormCallbacks.onConfirm) {
      ok = window.FormCallbacks.onConfirm.call($btn[0], e) !== false;
    }
    if (!ok) e.preventDefault();
    return ok;
  });

  // 3. 即時清除錯誤(輸入時)
  $('.js-form').on('input change', '.js-validate', function () {
    var res = Validator.validateField(this);
    var $group = $(this).closest('.form-group');
    $group.find('.form-error').text(res.valid ? '' : res.message).toggle(!res.valid);
  });
});

使用示例:業務回調

<script>
window.FormCallbacks.onSubmit = function (e) {
  var $form = $(this);
  var data = $form.serializeArray();
  console.log('提交數據:', data);

  // AJAX 提交示例
  $.ajax({
    url: $form.attr('action') || '/api/submit',
    method: 'POST',
    data: data,
    success: function (res) {
      alert('提交成功:' + JSON.stringify(res));
    },
    error: function () {
      alert('網絡錯誤,請重試');
    }
  });

  return false; // 阻止原生提交,由 AJAX 接管
};

window.FormCallbacks.onConfirm = function (e) {
  var $btn = $(this);
  var id = $btn.data('id');
  $.post('/api/delete', { id: id }, function () {
    $btn.closest('tr').fadeOut();
  });
  return false; // 阻止默認行為
};
</script>

擴展:異步驗證(如檢查用戶名唯一性)

<input name="username" class="js-validate"
       data-rule-required="true"
       data-rule-async="checkUsernameUnique"
       data-msg-async="用戶名已存在">

<script>
window.checkUsernameUnique = function (val, el) {
  var $el = $(el);
  var deferred = $.Deferred();

  // 防抖
  clearTimeout($el.data('asyncTimer'));
  $el.data('asyncTimer', setTimeout(function () {
    $.get('/api/check-username', { username: val })
      .done(function (res) {
        deferred.resolve(!res.exists); // false = 已存在
      })
      .fail(function () {
        deferred.resolve(true); // 網絡錯誤時放行,避免阻塞
      });
  }, 300));

  return deferred.promise();
};

// 驗證器擴展:支援 Promise 返回
// 在 validateField 中增加:
// case 'async':
//   var promise = window[rule.value]($.trim($el.val()), el);
//   if (promise && typeof promise.then === 'function') {
//     return promise.then(function (ok) {
//       return { valid: ok, message: getMsg(el, rule.name) };
//     });
//   }
</script>

無 jQuery 版本核心邏輯(現代專案可直接用)

// 原生實現核心思路:
// 1. document.querySelectorAll('.js-form') 遍歷表單
// 2. form.querySelectorAll('.js-validate') 獲取待驗證元素
// 3. element.dataset.ruleRequired, element.dataset.msgRequired 讀取規則
// 4. element.checkValidity() 結合 HTML5 原生驗證
// 5. element.setCustomValidity() 設置自定義錯誤
// 6. form.addEventListener('submit', ...) 統一攔截
// 7. 使用 FormData + fetch 異步提交
// 完整代碼約 80 行,建議參考上述邏輯重寫。

結語

聲明式驗證器將規則從 JS 邏輯剝離到 HTML 屬性,實現「寫一次規則,到處生效」。核心優勢在於:業務邏輯與驗證規則解耦、新增欄位零 JS 修改、統一錯誤提示體驗。建議根據專案技術棧選擇 jQuery 版或原生版,核心設計模式通用。

copyright © 萬盛學電腦網 all rights reserved