寫 jQuery 寫久了,難免會累積一些坏习惯。以下把載入方式、變數命名、選擇器、DOM 操作、事件、AJAX、動畫與插件等各個層面的實務建議整理成一份清單,每一條都能直接落到你的專案裡。
1. 優先使用 CDN。 別人的伺服器免費幫你托管檔案,還能分享瀏覽器快取,這種便宜沒理由不佔。
<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
<script>window.jQuery || document.write('<script src="js/jquery-1.11.0.min.js" type="text/javascript"><\/script>')</script>
2. 一定要有本地備份。 為了安全起見,遠端 CDN 掛掉時網站仍要能運作,寫法如上。
3. 使用裸協定 URL(拿掉 http: 或 https:),如上例所示,可避免混合內容問題。
4. 盡量把 JavaScript 與 jQuery 程式碼放到頁面底部。
5. 該選哪個版本?
6. 與其他框架共存時避開 $ 衝突。 若同時使用 Prototype、MooTools、Zepto 等也會佔用 $ 的函式庫,請改用 jQuery 全名撰寫,並呼叫 $.noConflict() 確保不衝突。
7. 用 Modernizr 偵測瀏覽器是否支援新特性,而不是去判斷瀏覽器版本。
1. jQuery 類型的變數建議加上 $ 前綴,一眼就能辨識。
2. 把選擇器回傳的結果存進變數以便重複使用。
var $products = $("div.products"); // 慢
var $products = $(".products"); // 快
3. 採用駝峰式命名(camelCase)。
1. 優先使用 ID 選擇器。 它背後呼叫的是原生 document.getElementById(),速度遠快於其他選擇器。
2. 使用 class 選擇器時不要指定元素類型。
var $products = $("div.products"); // 慢
var $products = $(".products"); // 快
3. 在 ID 父容器下尋找子元素請用 .find()。 以 id 選元素不會啟動 Sizzle 引擎,因此更快。
4. 多層查找時,右邊寫得具體一點,左邊盡量簡單。
$("div.data .gonzalez"); // 不夠好
$(".data td.gonzalez"); // 優化後
5. 刪掉冗餘的層級。
$(".data table.attendees td.gonzalez"); // 中間有冗餘
$(".data td.gonzalez"); // 好的寫法
6. 明確指定搜尋的上下文。
$('.class'); // 需要遍歷整個 DOM
$('.class', '#class-container'); // 只在指定容器內查找
7. 避免使用萬用選擇器。
$('div.container > *'); // 差
$('div.container').children(); // 好
8. 注意隱式的萬用選擇器。 省略時其實就是用 * 通配。
$('div.someclass :radio'); // 差
$('div.someclass input:radio'); // 好
9. ID 本身已保證唯一,不要再與其他選擇器混搭。
$('#outer #inner'); // 髒
$('div#inner'); // 亂
$('.outer-container #inner'); // 差
$('#inner'); // 乾淨,後台只需 getElementById()
1. 大量操作前先把元素從文件卸載,處理完再貼回去。
var $myList = $("#list-container > ul").detach();
// ... 一大堆對 $myList 的處理
$myList.appendTo("#list-container");
2. 在記憶體中把 HTML 組裝好,再一次性插入 DOM。
// 不好
var $myList = $("#list");
for(var i = 0; i < 10000; i++){
$myList.append("<li>" + i + "</li>");
}
// 好
var $myList = $("#list");
var list = "";
for(var i = 0; i < 10000; i++){
list += "<li>" + i + "</li>";
}
$myList.html(list);
// 更好
var array = [];
for(var i = 0; i < 10000; i++){
array[i] = "<li>" + i + "</li>";
}
$myList.html(array.join(''));
3. 不要對不存在的元素做操作。
// 不建議:jQuery 要跑完三個函式才發現元素根本不存在
$("#nosuchthing").slideUp();
// 應該這樣
var $mySelection = $("#nosuchthing");
if ($mySelection.length) {
$mySelection.slideUp();
}
1. 一個頁面只寫一個 ready 處理器。 程式碼清楚、好除錯,也更容易追蹤執行流程。
2. 不要用匿名函式當事件回呼。 匿名函式不利除錯、維護、測試與複用。
$("#myLink").on("click", function(){ ... }); // 不建議
function myLinkClickHandler(){ ... }
$("#myLink").on("click", myLinkClickHandler); // 建議
3. ready 的回呼同樣不要用匿名函式。
$(function(){ ... }); // 糟糕:無法複用也無法寫測試
$(initPage); // 好的做法,或 $(document).ready(initPage);
function initPage(){
// 在這裡進行初始化
}
4. 進一步,把 ready 處理器抽到外部檔案,頁面只負責呼叫。
<script src="my-document-ready.js"></script> <script> // 初始化一些必要的全域變數 $(document).ready(initPage); </script>
5. 千萬不要寫內嵌於 HTML 的 JS,那是除錯惡夢。 一律用 jQuery 綁定事件,隨時都能動態解除。
<a id="myLink" href="#" onclick="myEventHandler();">my link</a> <!-- 不好 -->
$("#myLink").on("click", myEventHandler); <!-- 好 -->
6. 綁定時加上命名空間,方便日後精準解除而不影響其他綁定。
$("#myLink").on("click.mySpecialClick", myEventHandler);
$("#myLink").unbind("click.mySpecialClick"); // 優雅地解除綁定
1. 直接使用 $.ajax(),不必繞道 .getJSON() 或 .get(),因為 jQuery 內部最終還是轉成前者。
2. 不要對 HTTPS 站點用 HTTP 發請求,最乾脆的做法是協定留空。
3. 別把參數嵌在網址裡,改用 data 設定傳遞。
// 不易閱讀
$.ajax({ url: "something.php?param1=test1¶m2=test2", ... });
// 更易閱讀
$.ajax({ url: "something.php", data: { param1: test1, param2: test2 } });
4. 明確指定 dataType,讓自己清楚要處理什麼格式的資料。
5. 動態載入的內容請用事件代理綁定。 這樣之後才插入的元素也同樣有效。
$("#parent-container").on("click", "a", delegatedClickHandlerForAjax);
6. 善用 Promise 風格。
$.ajax({ ... }).then(successHandler, failureHandler);
// 或
var jqxhr = $.ajax({ ... });
jqxhr.done(successHandler);
jqxhr.fail(failureHandler);
7. 一份標準的 Ajax 模板:
var jqxhr = $.ajax({
url: url,
type: "GET", // 預設 GET,可依需求調整
cache: true, // 預設 true;script、jsonp 類型為 false
data: {}, // 請求參數
dataType: "json", // 指定想要的資料類型
jsonp: "callback", // JSONP 的 callback 參數名
statusCode: {
404: handler404,
500: handler500
}
});
jqxhr.done(successHandler);
jqxhr.fail(failureHandler);
1. 全站維持一致的動畫風格。
2. 尊重使用者體驗,不要濫用特效。多用簡潔的顯示隱藏、狀態切換、滑入滑出等效果;速度使用 'fast'、'slow' 或 400(中等)等預設值。
1. 一律挑選支援良好、文件完整、測試齊全且社群活躍的插件。
2. 留意插件與目前 jQuery 版本的相容性。
3. 常用功能應該寫成 jQuery 插件,日後到處都能複用。
1. 除了用變數保存結果,也要善用鏈式呼叫。
$("#myDiv").addClass("error").show();
2. 當鏈式呼叫超過三次,或回呼讓程式碼變複雜時,用換行與縮進提高可讀性。
$("#myLink")
.addClass("bold")
.on("click", myClickHandler)
.on("mouseover", myMouseOverHandler)
.show();
3. 特別長的呼叫鏈,還是用變數保存中間結果來簡化程式碼。
1. 用物件字面量一次傳入多個參數。
$myLink.attr("href", "#").attr("title", "my link").attr("rel", "external"); // 呼叫三次 attr
$myLink.attr({ href: "#", title: "my link", rel: "external" }); // 只呼叫一次
2. 不要把 CSS 與 jQuery 糾纏在一起。
$("#mydiv").css({'color': 'red', 'font-weight': 'bold'}); // 不好
.error { /* 好 */
color: red;
font-weight: bold;
}
$("#mydiv").addClass("error");
3. 持續關注官方 Changelog,不要使用已廢棄的方法。
4. 適時改用原生 JavaScript——畢竟 jQuery 就是 JavaScript,有些操作原生寫法反而更快。