DIV CSS 佈局教程網

jQuery 表單驗證外掛 formValidator 改進版:樣式解耦與效能優化實錄
編輯:JQuery特效代碼     

本文記錄我對 formValidator 表單驗證外掛所做的幾項主要改進。整體架構與設計思路仍沿用原版,重點放在可讀性、效能與易用性上。

改進一:用列舉物件取代魔法字串

原版散落在各處的標籤名稱與驗證型別字串,改以列舉物件集中管理,並新增 sustainType 方法,用來判斷某種驗證方式是否支援該標籤型別:

//各種驗證方式支持的標簽類型
sustainType: function (elem, setting) {
var srcTag = elem.tagName;
var stype = elem.type;
switch (setting.validatetype) {
case _validTypeEnum.InitValidator:
return true;
case _validTypeEnum.InputValidator:
if (srcTag == _validTagEnum.INPUT || srcTag == _validTagEnum.TEXTAREA || srcTag == _validTagEnum.SELECT) {
return true;
} else {
return false;
}
case _validTypeEnum.CompareValidator:
if (srcTag == _validTagEnum.INPUT || srcTag == _validTagEnum.TEXTAREA) {
if (stype == _validTagTypeEnum.checkbox || stype == _validTagTypeEnum.radio) {
return false;
} else {
return true;
}
}
return false;
case _validTypeEnum.AjaxValidator:
if (stype == _validTagTypeEnum.text || stype == _validTagTypeEnum.textarea || stype == _validTagTypeEnum.file || stype == _validTagTypeEnum.password || stype == _validTagTypeEnum.select_one) {
return true;
} else {
return false;
}
case _validTypeEnum.RegexValidator:
if (srcTag == _validTagEnum.INPUT || srcTag == _validTagEnum.TEXTAREA) {
if (stype == _validTagTypeEnum.checkbox || stype == _validTagTypeEnum.radio) {
return false;
} else {
return true;
}
}
return false;
case _validTypeEnum.FunctionValidator:
return true;
}
}

另新增 getLength,依標籤型別以不同方式計算「長度」:

//獲取指定字串的長度
getLength: function (jqObj) {
var elem = _GetDomObj(jqObj);
var sType = elem.type;
var len = 0;
switch (sType) {
case _validTagTypeEnum.text:
case _validTagTypeEnum.hidden:
case _validTagTypeEnum.password:
case _validTagTypeEnum.textarea:
case _validTagTypeEnum.file:
var val = jqObj.val();
var initConfig = $.formValidator.getInitConfig(elem.settings[0].validatorgroup);
len = initConfig.wideword ? String.getCharLength(val) : val.length;
break;
case _validTagTypeEnum.checkbox:
case _validTagTypeEnum.radio:
len = $("input[type='" + sType + "'][name='" + jqObj.attr("name") + "']:checked").length;
break;
case _validTagTypeEnum.select_one:
case _validTagTypeEnum.select_multiple:
len = jqObj.children(":selected").length;
break;
}
return len;
}

當 wideword 為 true 時,中英文字元會被視為等寬,全形字元以 2 計算,這對中文輸入場景是必要的。

改進二:改傳物件而非 id

原版在各方法之間傳遞的是驗證標籤的 id,每個方法內部都得再用 id 反查一次物件。改為直接傳遞驗證標籤物件後,省下了重複查詢,程式執行速度與效能都有改善。

改進三:把樣式名稱交還給使用者

原版把提示樣式名稱寫死在外掛裡,例如錯誤提示就叫 onError。這會逼得美工必須去記外掛內部的樣式名稱,還得處處閃避樣式重複或衝突,用起來非常綁手。

我認為一個好的外掛,應該讓 JS 與樣式完全分離——這近似於程式設計裡的「鬆耦合」。於是各提示樣式改為可由使用者自行配置:

//提示樣式枚舉
var _tipCssEnum =
{
//(ajax)加載處理
loadCss: "loadCss",
//獲得焦點時的樣式
focusCss: "focusCss",
//提示[用於 為空提示] ---如果此項未設置,則使用 errorCss
noticeCss: "noticeCss",
//失敗or錯誤[用於格式錯誤,正則表達式驗證]---必須設置
errorCss: "errorCss",
//成功---必須設置
successCss: "successCss",
//默認狀態 ---必須設置
defaultCss: "defaultCss"
};

初始化設定中新增 tipcss 物件,並以深度拷貝合併使用者傳入的設定:

initConfig: function (controlOptions) {
var settings =
{
debug: false, //是否是調試模式
validatorgroup: "1", //驗證組
alertmessage: false, //是否直接彈出驗證提示
validobjectids: "", //驗證對象集合
focusvalid: false,
onsuccess: function () { return true; }, //驗證成功後的處理方法
onerror: function () { },
filterInputStrFun: function (str) { return FilterInputOper.FilterInputStr(str); }, //過慮輸入字串的方法[可設置]
isformpost: false, //是否是表單提交(false:非表單提交,一般為ajax提交;true:表單提交)
submitonce: false, //是否驗證通過後,表單立刻提交
submitbutton: null, //提交按鈕id或對象
getformdata: null, //(驗證通過後)獲得輸入的表單值——只有 isformpost=false 時才會被調用
//驗證提示顯示設置
tipshow: "default",
formid: "", //驗證表單的id或對象
tidymode: false, //精簡模式
errorfocus: true,
wideword: true,
//驗證提示樣式設置(全局)
tipcss:
{
loadCss: "",     //(ajax)加載處理
focusCss: "",    //獲得焦點時的樣式
noticeCss: "",   //提示
successCss: "",  //成功
errorCss: "",    //失敗
defaultCss: ""   //默認狀態
}
};
controlOptions = controlOptions || {};
controlOptions.tipcss = controlOptions.tipcss || {};
//合併整個配置(深度拷貝)
$.extend(true, settings, controlOptions);
if (!settings.isformpost) {
if (!settings.submitbutton) {
alert("submitbutton不能為空!");
return;
}
_GetJqObj(settings.submitbutton).click(function () {
var pageIsValid = $.formValidator.pageIsValid(settings.validatorgroup);
if (pageIsValid && _IsFunction(settings.getformdata)) {
var formData = _GetFormData(settings.filterInputStrFun);
settings.getformdata(formData);
}
});
}
settings.tipshow = settings.tipshow || "default";
//如果是精簡模式,發生錯誤的時候,第一個錯誤的控件就不獲得焦點
if (settings.tidymode) {
settings.errorfocus = false;
}
if (settings.formid) {
_GetNodeById(settings.formid).submit(function () {
//如果不是表單提交,則阻止表單提交
return settings.isformpost ? $.formValidator.pageIsValid(settings.validatorgroup) : false;
});
}
if (_jQuery_formValidator_initConfig_Array == null) {
_jQuery_formValidator_initConfig_Array = new Array();
}
_jQuery_formValidator_initConfig_Array.push(settings);
}

提示狀態的套用也一併抽成獨立方法:

//設置提示信息
setTipState: function (elem, showCssEnum, showmsg) {
var setting0 = elem.settings[0];
var initConfig = $.formValidator.getInitConfig(setting0.validatorgroup);
if (initConfig.alertmessage && showmsg) {
alert(showmsg);
return
}
var jq_tipObj = setting0.tipJqObj;
var tip_IsNull = Object.isNull(jq_tipObj);
if (!tip_IsNull) {
showmsg = showmsg || "";
if (initConfig.tidymode) {
//保存提示信息
elem.Tooltip = showmsg;
if (showCssEnum != _tipCssEnum.errorCss && showCssEnum != _tipCssEnum.noticeCss)
jq_tipObj.hide();
}
jq_tipObj.removeClass();
//設置提示樣式
var showClass = setting0.tipcss[showCssEnum];
//如果 noticeCss 未設置,則使用 errorCss
if (String.isNullOrEmpty(showClass) && showCssEnum == _tipCssEnum.noticeCss) {
showCssEnum = _tipCssEnum.errorCss;
showClass = setting0.tipcss[showCssEnum];
}
if (!String.isNullOrEmpty(showClass)) {
//保存當前提示標簽顯示的樣式(枚舉值)
elem.showcssenum = showCssEnum;
jq_tipObj.addClass(showClass);
}
jq_tipObj.html(showmsg);
}
}

改進四:擴充 initConfig 以滿足更多場景

  • filterInputStrFun:可自訂輸入字串的過濾方法,滿足特殊字元處理需求。
  • isformpost:區分 Ajax 提交與傳統表單提交兩種流程。
  • getformdata:驗證通過後回傳表單資料,僅在 isformpost=false 時觸發。
  • tipshow:可切換提示標籤的查找方式,除了依 id 定位,也支援自訂 jQuery find 查找。

使用示範:三步驟表單驗證

頁面結構(節錄關鍵欄位與提示容器):

<div class="jy_fcadminright" id="stepDiv1">
<div class="jy_fcadmintil02">添加棟號 >> <span>第一步</span></div>
<div class="jy_fcadminme">
<div class="jy_fcscrtbox03">
<label><font color="#ff0000">* </font>棟號:</label>
<span class="s1"><input type="text" maxlength="10" class="jy_fcadmin02" id="txtBuildingName" /></span>
<div class="uuu1"><p id="tipBuildingName" class="box001" style="display: none;"></p></div>
</div>
<div class="jy_fcscrtbox03">
<label><font color="#ff0000">* </font>狀態:</label>
<div class="jy_fcscrtboxs1">
<input name="rd_SaleState" type="radio" value="1" />待售
<input name="rd_SaleState" type="radio" value="2" />期房
<input name="rd_SaleState" type="radio" value="3" />現房
</div>
<div class="uuu2"><p id="tipSaleState" class="box001" style="display: none;"></p></div>
</div>
<div class="jy_fcscrtbox03">
<label><font color="#ff0000">*</font> 用途:</label>
<div class="jy_fcmu"><ul>
<li><input type="checkbox" name="ckUsage" value="1" />普通住宅</li>
<li><input type="checkbox" name="ckUsage" value="2" />單身公寓</li>
<li><input type="checkbox" name="ckUsage" value="3" />復式</li>
</ul></div>
<div class="uuu2"><p id="tipUsage" class="box001" style="display: none;"></p></div>
</div>
<div class="jy_fcscrtbox03">
<p class="c2">
<input id="btnSubmit_Step1" type="button" class="jy_fcadminbottom02" value="下一步" />
<input id="btnCancel_Step1" type="button" class="jy_fcadminbottom02" value="取 消" />
</p>
</div>
</div>
</div>

引入外掛與規則檔:

<script src="js/formValidator.js" type="text/javascript"></script>
<script src="js/formValidatorRegex.js" type="text/javascript"></script>

設定與驗證腳本:

function GetInitConfigOptions(validatorgroup, onsuccess, submitbutton, getformdata) {
return {
validatorgroup: validatorgroup,
formid: "form1",
onerror: function (msg) { alert("onerror is " + msg) },
onsuccess: onsuccess,
submitbutton: submitbutton,
tipcss: {
//(ajax)加載處理
loadCss: "",
//獲得焦點時的樣式
focusCss: "",
//提示
noticeCss: "box001",
//成功
successCss: "box002",
//失敗
errorCss: "box003",
//默認狀態
defaultCss: "box004"
},
getformdata: getformdata
};
}
//顯示指定的(步)容器
function _ShowStepContainer(showNum) {
for (var i = 1; i <= 3; i++) {
$("div#stepDiv" + i).css("display", (i == showNum ? "block" : "none"));
}
}
$(document).ready(function () {
$("p").show();
$.formValidator.initConfig(
GetInitConfigOptions(1, function () {
_ShowStepContainer(2);
}, "btnSubmit_Step1")
);
$("#txtBuildingName").formValidator(
{
validatorgroup: "1",
tipid: "tipBuildingName",
onshow: "請輸入棟號",
onfocus: "棟號不能為空",
oncorrect: "",
tipcss: //此對象中的屬性繼承(extend)其對應的 initConfig.tipcss 的屬性
{
//失敗
//errorCss: "onNotice"
}
})
.inputValidator({ min: 2, max: 10, onerror: "你輸入的棟號(長度錯誤),請確認" });
$("#txtfloornum").formValidator({ tipid: "tipfloornum", onshow: "請輸入層數", onfocus: false, oncorrect: "層數輸入正確" }).inputValidator({ min: 1, max: 30, type: "value", empty: { leftempty: false, rightempty: false, emptyerror: "層數兩邊不能有空符號" }, onerror: "層數不能為空,值介於1-30之間" })
.regexValidator({ regexp: RegexEnum.integer_Z, onerror: "你輸入的層數格式不正確,必須為數字" });
$('input[name="rd_SaleState"]:radio').formValidator({ tipid: "tipSaleState", onshow: "請選擇售樓狀態", onfocus: "棟號的售樓狀態", oncorrect: "" }).inputValidator({ min: 1, onerror: "售樓狀態必選!" });
$('input[name="ckUsage"]:checkbox').formValidator({ tipid: "tipUsage", forcevalid: true, onshow: "請選擇用途", onfocus: false, oncorrect: "用途已選擇" }).inputValidator({ min: 1, onerror: "請選擇用途,必填" });
$("#txtShareBili").formValidator({ tipid: "tipShareBili", onshow: "請輸入公攤比率", oncorrect: "" }).inputValidator({ min: 1, onerror: "公攤比率不能為空" }).regexValidator({ regexp: RegexEnum.decmal_Z, onerror: "你輸入的公攤比率格式不正確,必須為數字" });
$.formValidator.initConfig(
GetInitConfigOptions(3, function () {
alert("驗證通過"); return true;
}, "btnSubmit_Step3", function (formdata) {
alert("要提交的表單值:"+$.param(formdata));
for (var key in formdata) {
$("#showMes_P").html($("#showMes_P").html() + "<br/>key:" + key + " | val:" + formdata[key]);
}
})
);
});

待解的題目:驗證規則的自由組合

還有一項想完成但尚未滿意的功能:讓驗證規則能自由組合。例如「電話」與「手機」只要其中一項通過驗證即可。我自己試著實作過,效果並不理想,一直沒想到比較漂亮的解法,歡迎有思路的朋友一起討論。

外掛與 Demo 下載:FromVaild

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved