首先要記住一件事:jQuery 就是 JavaScript。這意味著我們應該沿用相同的編碼慣例、風格指南與最佳實踐。如果你是 JavaScript 新手,建議先把語言基礎打穩,再回頭研究 jQuery,會事半功倍。以下 19 條指南,每一條都能直接改善你的程式碼品質。
DOM 遍歷成本高昂,凡是會重複使用的元素都應該快取起來。
// 糟糕
h = $('#element').height();
$('#element').css('height', h - 20);
// 建議
$element = $('#element');
h = $element.height();
$element.css('height', h - 20);
與 JavaScript 一樣,盡量確保變數都在函式作用域內。
// 糟糕
$element = $('#element');
h = $element.height();
// 建議
var $element = $('#element');
var h = $element.height();
這種匈牙利命名法的變體,能讓人一眼分辨出哪些是 jQuery 物件。
// 糟糕
var first = $('#first');
var second = $('#second');
var value = $first.val();
// 建議
var $first = $('#first'),
$second = $('#second'),
value = $first.val();
把多條 var 合併成一句,未賦值的變數放在最後。
var $first = $('#first'),
$second = $('#second'),
value = $first.val(),
k = 3,
cookiestring = 'SOMECOOKIESPLEASE',
i,
j,
myArray = {};
新版 jQuery 中,on("click") 已取代 click() 這類簡寫。1.7 之後,on() 就是附加事件處理器的首選方法;為了風格一致,可以全部改用 on()。
// 糟糕
$first.click(function(){
$first.css('border', '1px solid red');
$first.css('color', 'blue');
});
// 建議
$first.on('click', function(){
$first.css('border', '1px solid red');
$first.css('color', 'blue');
});
能合併的設定就合併,例如一次傳入物件給 css()。
// 糟糕
$first.click(function(){
$first.css('border', '1px solid red');
$first.css('color', 'blue');
});
// 建議
$first.on('click', function(){
$first.css({
'border': '1px solid red',
'color': 'blue'
});
});
// 糟糕
$second.html(value);
$second.on('click', function(){ alert('hello everybody'); });
$second.fadeIn('slow');
$second.animate({height: '120px'}, 500);
// 建議
$second.html(value)
.on('click', function(){ alert('hello everybody'); })
.fadeIn('slow')
.animate({height: '120px'}, 500);
精簡與鏈式寫法容易犧牲可讀性,適度換行與縮進就能救回來。
// 糟糕
$second.html(value);
$second.on('click', function(){ alert('hello everybody'); }).fadeIn('slow').animate({height:'120px'},500);
// 建議
$second.html(value)
.on('click', function(){ alert('hello everybody'); })
.fadeIn('slow')
.animate({height: '120px'}, 500);
// 糟糕
function initVar($myVar) {
if(!$myVar) {
$myVar = $('#selector');
}
}
// 建議
function initVar($myVar) {
$myVar = $myVar || $('#selector');
}
if(collection.length > 0){ ... } // 糟糕
if(collection.length){ ... } // 建議
要對 DOM 元素連續設定大量屬性或樣式時,先 detach 再 append 回去,能大幅減少重排。
// 糟糕
var $container = $("#container"),
$containerLi = $("#container li"),
$element = null;
$element = $containerLi.first();
// ... 許多複雜的操作
// 建議
var $container = $("#container"),
$containerLi = $container.find("li"),
$element = null;
$element = $containerLi.first().detach();
// ... 許多複雜的操作
$container.append($element);
多查官方文件,往往有更快或更好的寫法。
$('#id').data(key, value); // 糟糕
$.data('#id', key, value); // 建議(更高效)
// 糟糕
var $container = $('#container'),
$containerLi = $('#container li'),
$containerLiSpan = $('#container li span');
// 建議
var $container = $('#container'),
$containerLi = $container.find('li'),
$containerLiSpan = $containerLi.find('span');
$('.container > *'); // 糟糕
$('.container').children(); // 建議
避免隱式通用選擇符:
$('.someclass :radio'); // 糟糕
$('.someclass input:radio'); // 建議
優化選擇符:ID 本來就唯一,不需要額外加上標籤或祖先。
$('div#myid'); // 糟糕
$('div#footer a.myLink'); // 糟糕
$('#myid'); // 建議
$('#footer .myLink'); // 建議
$('#outer #inner'); // 糟糕
$('#inner'); // 建議
新版本通常更輕、更有效率,但務必權衡你要支援的瀏覽器範圍(例如 2.0 不支援 IE 6/7/8)。同時要關注每個版本的 deprecated 清單。
// 糟糕 - live 已廢棄
$('#stuff').live('click', function() {
console.log('hooray');
});
// 建議
$('#stuff').on('click', function() {
console.log('hooray');
});
大型 CDN 能挑選離使用者最近的節點並快速回應,同時提高快取命中率。建議直接採用 jQuery 官網提供的 CDN 位址。
既然 jQuery 就是 JavaScript,用 jQuery 能做的事,原生也能做。原生寫法可讀性可能較差、程式碼較長,但通常更高效——沒有任何框架能比原生程式碼更小、更輕、更快。理想的做法是取兩者精華:在效能關鍵路徑上使用等效的原生寫法。
寫這篇文章的目的是想幫你把 jQuery 寫得更好。但也請記住:jQuery 並非不可或缺,它只是一個選項。先想清楚自己為什麼需要它——DOM 操作?AJAX?模板?CSS 動畫?還是選擇器引擎?說不定一個輕量的微型框架或 jQuery 客製版會更合適。