這個系列會帶你走進jQuery的世界,裡頭有不少作者的實戰心得與疑難排解方案,就算你早已上手jQuery,讀起來也往往能挖到幾個實用的小技巧。
本文介紹兩個最常用的jQuery外掛,分別用於表單驗證與自動完成提示(類似Google Suggest)。
研究別人的作品真是既費時又磨人的過程(當然也和我英文不好有關)。總覺得外掛作者寫了不少文檔卻不夠系統,往往要鑽研很多實例才能摸清作者的思路。所以學習、研究一個外掛的成本很高,若發現並修復Bug,成本更是未知數——這次我花較少時間就解決了自動完成外掛的一個中文Bug,但要是複雜的Bug就不會這麼輕鬆了。
簡單應用我首推上一篇中介紹的jQuery UI,但它能解決的問題有限。使用jQuery外掛是我們最後的好辦法——起碼比自己從頭開發強。很多jQuery外掛的代碼寫得極其優美,看看那些城市輸入框控件,除了要為輸入框手工掛一堆屬性(onkeyup、onkeydown等),還不夠通用,又佔用伺服器與網路資源,可當初也是花了不少時間才完成的。
站在巨人的肩膀上,讓我覺得寫腳本和寫C#設計一樣有深度可挖。除了用作者寫好的功能,還能學到如何開發、封裝JavaScript控件。看過優秀外掛作者的代碼與設計思路後,常自歎差距之大,那簡直是C#程序員與架構師之間的差距。
希望透過本章的兩個外掛,你不只學會怎麼用,還能略微體會如何封裝、設計JavaScript控件。
提交表單前常要校驗使用者輸入。ASP.NET的驗證控件就是為此而生,能同時做客戶端與伺服器端驗證,但它並沒被所有專案採用,而且在MVC專案裡人們常用自己的客戶端驗證框架。比較若干表單驗證外掛後,我選了validate,因為它簡單又靈活。
外掛首頁:https://bassistance.de/jquery-plugins/jquery-plugin-validation/
外掛文檔:https://docs.jquery.com/Plugins/Validation
配置說明:https://docs.jquery.com/Plugins/Validation/validate#options
實例效果:

實例代碼:
<form id="commentForm" method="get" action="">
<fieldset style="width:500px;"><legend>表單驗證</legend>
<p><label for="cname" class="slabel"><em class="textred">*</em> 姓名:</label>
<input id="cname" name="name" size="25" class="required" minlength="2" /></p>
<p><label for="cemail" class="slabel"><em class="textred">*</em> E-Mail:</label>
<input id="cemail" name="email" size="25"/></p>
<p><label for="curl" class="slabel">網址:</label>
<input id="curl" name="url" size="25" class="url" value="" /></p>
<p><label for="ccomment" class="slabel"><em class="textred">*</em> 內容:</label>
<textarea rows="2" id="ccomment" name="comment" cols="20" class="required"></textarea></p>
<p style="text-align:center;"><input class="submit" type="submit" value="提交" /></p>
</fieldset>
</form>
<script type="text/javascript">
$(function() {
$("#commentForm").validate({
errorClass: "error",
submitHandler: function(form) {
//若想提交表單,需用form.submit()而非$(form).submit()
alert("submitted!");
},
rules: {
email: { required: true, email: true }
},
messages: {
email: { required:"需要輸入電子郵箱", email:"電子郵箱格式不正確" }
}
});
});
</script>
驗證方法用來判斷某個控件是否滿足某些規則,回傳boolean值。比如email()方法驗證內容是否符合email格式,符合回傳true。所有內建驗證方法列在官方文檔的List of built-in Validation methods一節;外掛還附帶additional-methods.js,引入後即可啟用更多驗證方法。
驗證消息就是驗證失敗後顯示的文字,它一定關聯在某個驗證方法上,全局驗證消息保存在jQuery.validator.messages屬性中。validate預設自帶英文消息:
messages: { required: "This field is required." });
也就是說required驗證失敗時顯示"This field is required."。下載包的localization資料夾裡包含了各國語言的基本驗證消息,像本實例那樣引入不同語言檔即可切換語言:
<script type="text/javascript" src=".../localization/messages_cn.js"></script>
語言檔內容示例:
jQuery.extend(jQuery.validator.messages, { required: "必選字段" });
這樣必填項的提示就變成中文了。除了全局預設消息,也能為某個表單元素設置專屬消息,如本實例為email元素設定了專屬提示:
messages: { email: { required:"需要輸入電子郵箱", email:"電子郵箱格式不正確" } }
options的messages屬性可針對某個元素設置驗證消息,第一個email代表email元素,其值是個集合,裡頭required代表required驗證函數、email代表email驗證函數。
驗證規則的語意是:在元素A上,用驗證方法A和驗證方法B來驗證。它把元素與驗證方法關聯起來,而驗證方法又關聯了驗證消息,於是元素與消息也掛上了鉤。為元素添加規則有多種方式:
本實例的「姓名」元素同時用了CSS樣式規則與元素屬性規則:
<input id="cname" name="name" size="25" class="required" minlength="2" />
class裡含required類,於是和required()驗證函數關聯,這叫CSS樣式規則;minlength屬性會自動和minlength()驗證函數關聯,這叫元素屬性規則。此外還能透過編程方式關聯:
rules: { email: { required: true, email: true } },
這句為email表單物件添加了required()和email()兩個驗證函數。
預設情況下,驗證失敗時表單不會提交。但可以透過添加class="cancel"讓提交按鈕跳過驗證:
<input type="submit" class="cancel" name="cancel" value="Cancel" />
表單提交時,會觸發options中submitHandler設置的函數:
submitHandler: function(form) {
//若想提交表單,需用form.submit()而非$(form).submit()
alert("submitted!");
},
可以在這個函數裡編寫表單提交前的業務邏輯。要特別注意:最後以編程方式提交表單時,千萬別用jQuery物件的submit()方法,因為它會觸發表單驗證並再次調用submitHandler,導致遞歸調用。此函數的參數form就是表單物件,用它的原生form.submit()才能不經驗證直接提交。
開發階段我們通常不希望表單被真正提交。除了在submitHandler裡動手腳,還有更好的方式——設置options的debug屬性,即使驗證通過也不會提交表單:
$(".selector").validate({ debug: true })
有時一個頁面會有多個Form。由於validate是針對form物件包裝的,我們能自主控制哪些form需要驗證。為方便一次性設置頁面上所有應用了validate的form,還提供了jQuery.validator.setDefaults函數:
jQuery.validator.setDefaults({ debug: true });
autocomplete外掛能幫我們做出類似Google Suggest的效果:

外掛首頁:https://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/
外掛文檔:https://docs.jquery.com/Plugins/Autocomplete
配置說明:https://docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions
本實例示範用autocomplete對城市輸入做自動提示:

實例代碼:
<input id="inputCityName" name="inputCityName" type="text" />
<input id="inputCityId" name="inputCityId" type="text" />
<script type="text/javascript">
//城市數據
var cityList;
//autocomplete選項
var options = {
minChars: 1, max: 500, width: 250, matchContains: true,
formatItem: function(row, i, max) {
return i + "/" + max + ": \"" + row.CityNameEn + "\" [" + row.CityName + "]";
},
formatMatch: function(row, i, max) {
return row.CityNameEn + " " + row.CityName;
},
formatResult: function(row) {
return row.CityName;
}
};
function initAutoComplete(data) {
cityList = data;
$("#inputCityName").autocomplete(cityList, options);
$("#inputCityName").result(function(event, data, formatted) {
$("#inputCityId").val(data.ElongCityId);
});
}
$(function() {
//加載城市數據,並在回調函數中用返回的數據初始化autocomplete
$.getJSON("cityinfo.htm", null, initAutoComplete)
});
</script>
先要準備自動建議的數據源,本實例透過Ajax請求獲取JSON物件。autocomplete()有兩個參數:第一個是data,第二個是options。data可以是像本實例這樣的數據變數,也可以是一個url;若是url,則每次都会調用Ajax獲取數據。為了效率,我傾向在數據量允許時,於頁面加載後一次性用Ajax取回全部數據,再把變數傳給組件;除非數據特別龐大無法在客戶端加載,才每次向伺服器請求部分數據,但這會加重伺服器負擔。
雖然options是可選項,但當數據源是像cityList這樣的多屬性物件時,必須設置下面幾個關鍵配置項才能正常使用:
formatItem:對匹配的每一行數據做格式化,回傳值就是顯示給使用者的內容。簽名為function(row, rowNum, rowCount, searchItem)。其中row是當前行,rowNum是當前行號(從1開始),rowCount是結果總行數,searchItem是查詢用的數據(即formatMatch回傳的格式)。
formatMatch:對每行數據格式化出需要查詢的數據格式,回傳值供內部搜索算法使用。使用者看到的是formatItem設置的格式,但內部其實只搜索城市英文與中文名稱:
return row.CityNameEn + " " + row.CityName;
formatResult:使用者選中後回傳的數據格式。本實例只把城市名回傳給input:
return row.CityName;
上面三個函數無法滿足這樣的需求:只回傳城市名稱,但查詢時用城市ID,選中後還要把城市ID存進隱藏域。為此autocomplete提供了result事件,會在使用者選中某項後觸發:
$("#inputCityName").result(function(event, data, formatted) {
$("#inputCityId").val(data.ElongCityId);
});
簽名為function(event, data, formatted),三個參數分別是:event(事件物件,type為result)、data(選中的數據行)、formatted(實驗結果是formatMatch回傳的值,本實例為"Beijing 北京")。
當前版本的autocomplete對中文搜索存在Bug,因為它把搜索事件綁在keydown上,用中文輸入法打「北」字時不會有任何提示。我把原庫改動,將keydown改成keyup,就能正常對中文做智能提示了。另外記得把matchContains設為true,因為搜索格式是"Beijing 北京",預設只匹配開頭字符。
更多配置項請參考官方文檔。除了autocomplete()和result(),還有search()(激活search事件)、flushCache()(清空緩存)、setOptions(options)(設置配置項)等方法。
本文詳細介紹了表單驗證外掛與自動完成外掛。網路上能搜到大量外掛與上千的外掛清單,卻很難找到詳細的使用文檔。外掛用起來簡單,但要靈活應用並不容易,除了啃英文文檔學基本用法,還得花大把時間摸清各參數的作用與搭配方式;二次開發的難度更大,外掛核心代碼多無註釋又複雜,要在其中理出邏輯關係頗費心神。本文兩個外掛的更多細節,請參考一開始提供的官方文檔。
後續文章我打算先講解jQuery技巧與JavaScript必備知識,把外掛開發篇放到最後。本章代碼下載:https://xiazai.jb51.net/201101/yuanma/Code-jQueryStudy-11.rar