中文版譯者：Keel

此文以實例為基礎(chǔ)一步步說明了jQuery的工作方式。現(xiàn)以中文翻譯（添加我的補(bǔ)充說明）如下。如有相關(guān)意見或建議請麻煩到我的 BLOG 寫個回復(fù)或者 EMAIL 告知。

英文原版：http://jquery./jquery-getting-started.html ，感謝原文作者 Jörn Zaefferer

本文發(fā)布已征求原作者同意。

另外我認(rèn)為在學(xué)習(xí)過程中,有兩個API文檔你要打開隨時查看:

• http:///api/
• http://visual/

jQuery入門指南教程

這個指南是一個對jQuery庫的說明，要求讀者了解HTML(DOM)和CSS的一些常識。它包括了一個簡單的Hello World的例子，選擇器和事件基礎(chǔ)，AJAX、FX的用法，以及如何制作jQuery的插件。 這個指南包括了很多代碼，你可以copy它們，并試著修改它們，看看產(chǎn)生的效果。

內(nèi)容提要

1. 安裝
2. Hello jQuery
3. Find me:使用選擇器和事件
4. Rate me:使用AJAX
5. Animate me(讓我生動起來):使用FX
6. Sort me(將我有序化):使用tablesorter插件(表格排序)
7. Plug me:制作您自己的插件
8. Next steps(下一步)

安裝

一開始,我們需要一個jQuery的庫,最新的下載可以到這里找到。這個指南提供一個基本包含實例的包供下載.

下載：jQuery Starterkit

(譯者Keel注:一定要下載這個包，光看文章不實踐肯定是不行的。)

下載后解壓縮，然后用你最喜歡的文本編輯器打開starterkit.html和custom.js這兩個文件。(譯者Keel注:這兩個就是例子文件,所有的例子都用這兩個例子作出,custom.js寫jQuery代碼,starterkit.html觀察效果.建議用editPlus打開)

現(xiàn)在,我們就已經(jīng)做好了一切準(zhǔn)備來進(jìn)行這個著名的"Hello world"例子.

本章的相關(guān)鏈接:

• Starterkit
• jQuery Downloads

Hello jQuery

在做所有事情之前,我們要讓jQuery讀取和處理文檔的DOM,必須盡可能快地在DOM載入后開始執(zhí)行事件,所以,我們用一個ready事件作為處理HTML文檔的開始.看看我們打開的custom.js這個文件,里面已經(jīng)準(zhǔn)備好了:

$(document).ready(function() {
// do stuff when DOM is ready
});

放一個簡單的alert事件在需要等DOM完成載入,所以我們把任務(wù)稍稍變復(fù)雜一點:在點擊任何一個鏈接時顯示一個alert.

$(document).ready(function() {
$("a").click(function() {
alert("Hello world!");
});
});

這樣在你點擊頁面的一個鏈接時都會觸發(fā)這個"Hello world"的提示。

(譯者Keel注:請照此代碼修改custom.js并保存,然后用瀏覽器打開starterkit.html觀察效果。)

讓我們看一下這些修改是什么含義。$("a") 是一個jQuery選擇器(selector),在這里，它選擇所有的a標(biāo)簽（譯者Keel注：即<a></a>），$ 號是 jQuery “類”(jQuery "class")的一個別稱，因此$()構(gòu)造了一個新的jQuery 對象(jQuery object)。函數(shù) click() 是這個jQuery對象的一個方法，它綁定了一個單擊事件到所有選中的標(biāo)簽(這里是所有的a標(biāo)簽),并在事件觸發(fā)時執(zhí)行了它所提供的alert方法.

這里有一個擬行相似功能的代碼:

<a href="#" onclick="alert(‘Hello world‘)">Link</a>

不同之處很明顯,用jQuery不需要在每個a標(biāo)簽上寫onclick事件,所以我們擁有了一個整潔的結(jié)構(gòu)文檔(HTML)和一個行為文檔(JS),達(dá)到了將結(jié)構(gòu)與行為分開的目的,就像我們使用CSS追求的一樣.

下面我們會更多地了解到選擇器與事件.

本章的相關(guān)鏈接:

• jQuery Base
• jQuery Expressions
• jQuery Basic Events

Find me:使用選擇器和事件

jQuery提供兩種方式來選擇html的 elements，第一種是用CSS和Xpath選擇器聯(lián)合起來形成一個字符串來傳送到j(luò)Query的構(gòu)造器（如：$("div > ul a")）；第二種是用jQuery對象的幾個methods(方法)。這兩種方式還可以聯(lián)合起來混合使用。

為了測試一下這些選擇器，我們來試著在我們starterkit.html中選擇并修改第一個ordered list.

一開始，我們需要選擇這個list本身，這個list有一個ID叫“orderedlist”，通常的javascript寫法是document.getElementById("orderedlist").在jQuery中，我們這樣做：

$(document).ready(function() {
$("#orderedlist").addClass("red");
});

這里將starterkit中的一個CSS樣式red附加到了orderedlist上(譯者Keel注：參考測試包中的css目錄下的core.css，其中定義了red樣式)。因此，在你刷新了starterkit.html后，你將會看到第一個有序列表(ordered list )背景色變成了紅色，而第二個有序列表沒有變化.

現(xiàn)在，讓我們添加一些新的樣式到list的子節(jié)點.

$(document).ready(function() {
$("#orderedlist > li").addClass("blue");
});

這樣，所有orderedlist中的li都附加了樣式"blue"。

現(xiàn)在我們再做個復(fù)雜一點的，當(dāng)把鼠標(biāo)放在li對象上面和移開時進(jìn)行樣式切換，但只在list的最后一個element上生效。

$(document).ready(function() {
$("#orderedlist li:last").hover(function() {
$(this).addClass("green");
}, function() {
$(this).removeClass("green");
});
});

還有大量的類似的CSS和XPath例子，更多的例子和列表可以在這里找到。（譯者Keel注：入門看此文，修行在個人，要想在入門之后懂更多，所以這段話的幾個鏈接遲早是要必看的！不會又要翻譯吧...^_^!）

每一個onXXX事件都有效，如onclick,onchange,onsubmit等，都有jQuery等價表示方法（譯者Keel注：jQuery不喜歡onXXX，所以都改成了XXX，去掉了on）。其他的一些事件，如ready和hover,也提供了相應(yīng)的方法。

你可以在Visual jQuery找到全部的事件列表，在Events欄目下.

用這些選擇器和事件你已經(jīng)可以做很多的事情了，但這里有一個更強(qiáng)的好東東！

$(document).ready(function() {
$("#orderedlist").find("li").each(function(i) {
$(this).html( $(this).html() + " BAM! " + i );
});
});

find() 讓你在已經(jīng)選擇的element中作條件查找,因此 $("#orderedlist).find("li") 就像 $("#orderedlist li"). each()一樣迭代了所有的li，并可以在此基礎(chǔ)上作更多的處理。 大部分的方法,如addClass(), 都可以用它們自己的 each() 。在這個例子中, html()用來獲取每個li的html文本, 追加一些文字，并將之設(shè)置為li的html文本。（譯者Keel注：從這個例子可以看到.html()方法是獲取對象的html代碼，而.html(‘xxx‘)是設(shè)置‘xxx‘為對象的html代碼）

另一個經(jīng)常碰到的任務(wù)是在沒有被jQuery覆蓋的DOM元素上call一些方法，想像一個在你用AJAX方式成功提交后的reset：

$(document).ready(function() {
// use this to reset a single form
$("#reset").click(function() {
$("#form")[0].reset();
});
});

（譯者Keel注：這里作者將form的id也寫成了form，源文件有<form id="form">，這是非常不好的寫法，你可以將這個ID改成form1或者testForm，然后用$("#form1")或者$ ("#testForm")來表示它，再進(jìn)行測試。）

這個代碼選擇了所有ID為"form"的元素，并在其第一個上call了一個reset()。如果你有一個以上的form，你可以這樣做：

$(document).ready(function() {
// use this to reset several forms at once
$("#reset").click(function() {
$("form").each(function() {
this.reset();
});
});
});

（譯者Keel注：請注意一定要親自將這些代碼寫在custom.js中并在starterkit.html上測試效果才能有所體會！必要時要觀察starterkit.html的html代碼）

這樣你在點擊Reset鏈接后，就選擇了文檔中所有的form元素，并對它們都執(zhí)行了一次reset()。

還 有一個你可能要面對的問題是不希望某些特定的元素被選擇。jQuery 提供了filter() 和not() 方法來解決這個問題。 filter()以過濾表達(dá)式來減少不符合的被選擇項, not()則用來取消所有符合過濾表達(dá)式的被選擇項. 考慮一個無序的list，你想要選擇所有的沒有ul子元素的li元素。

$(document).ready(function() {
$("li").not("[ul]").css("border", "1px solid black");
});

這個代碼選擇了所有的li元素，然后去除了沒有ul子元素的li元素。刷新瀏覽器后，所有的li元素都有了一個邊框，只有ul子元素的那個li元素例外。

（譯 者Keel注：請注意體會方便之極的css()方法，并再次提醒請務(wù)必實際測試觀察效果，比方說換個CSS樣式呢？再加一個CSS樣式呢？像這樣：$ ("li").not("[ul]").css("border", "1px solid black").css("color","red");）

上面代碼中的[expression] 語法是從XPath而來，可以在子元素和屬性(elements and attributes)上用作過濾器，比如你可能想選擇所有的帶有name屬性的鏈接:

$(document).ready(function() {
$("a[@name]").background("#eee");
});

這個代碼給所有帶有name屬性的鏈接加了一個背景色。（譯者Keel注：這個顏色太不明顯了，建議寫成$("a[@name]").background("red");）

更常見的情況是以name來選擇鏈接，你可能需要選擇一個有特點href屬性的鏈接，這在不同的瀏覽器下對href的理解可能會不一致，所以我們的部分匹配("*=")的方式來代替完全匹配("=")：

$(document).ready(function() {
$("a[@href*=/content/gallery]").click(function() {
// do something with all links that point somewhere to /content/gallery
});
});

到現(xiàn)在為止，選擇器都用來選擇子元素或者是過濾元素。另外還有一種情況是選擇上一個或者下一個元素，比如一個FAQ的頁面，答案首先會隱藏，當(dāng)問題點擊時，答案顯示出來，jQuery代碼如下：

$(document).ready(function() {
$(‘#faq‘).find(‘dd‘).hide().end().find(‘dt‘).click(function() {
var answer = $(this).next();
if (answer.is(‘:visible‘)) {
answer.slideUp();
} else {
answer.slideDown();
}
});
});

這 里我們用了一些鏈?zhǔn)奖磉_(dá)法來減少代碼量，而且看上去更直觀更容易理解。像‘#faq‘ 只選擇了一次，利用end()方法，第一次find()方法會結(jié)束(undone)，所以我們可以接著在后面繼續(xù)find(‘dt‘)，而不需要再寫$ (‘#faq‘).find(‘dt‘)。

在點擊事件中的，我們用 $(this).next() 來找到dt下面緊接的一個dd元素，這讓我們可以快速地選擇在被點擊問題下面的答案。

（譯 者Keel注：這個例子真是太酷了，F(xiàn)AQ中的答案可以收縮！從利用next()的思路到實現(xiàn)這些效果都有很多地方需要我們消化，注意 if (answer.is(‘:visible‘))用法，注意answer.slideUp();不懂的地方趕緊查我在最開始提到的兩個必看API文檔）

除了選擇同級別的元素外，你也可以選擇父級的元素?？赡苣阆朐谟脩羰髽?biāo)移到文章某段的某個鏈接時，它的父級元素--也就是文章的這一段突出顯示，試試這個：

$(document).ready(function() {
$("a").hover(function() {
$(this).parents("p").addClass("highlight");
}, function() {
$(this).parents("p").removeClass("highlight");
});
});

測試效果可以看到，移到文章某段的鏈接時，它所在的段全用上highlight樣式，移走之后又恢復(fù)原樣。

在我們繼續(xù)之前我們先來看看這一步： jQuery會讓代碼變得更短從而更容易理解和維護(hù)，下面是$(document).ready(callback)的縮寫法：

$(function() {
// code to execute when the DOM is ready
});

應(yīng)用到我們的Hello world例子中，可以這樣:

$(function() {
$("a").click(function() {
alert("Hello world!");
});
});

現(xiàn)在，我們手上有了這些基礎(chǔ)的知識，我們可以更進(jìn)一步的探索其它方面的東西，就從AJAX開始！

本章的相關(guān)鏈接:

• jQuery API documentation
• Visual jQuery - A categorized browsable API documentation
• jQuery Expressions: CSS
• jQuery Expressions: XPath
• jQuery Expressions: Custom
• jQuery Special Events
• jQuery DOM Traversing

Rate me:使用AJAX

在這一部分我們寫了一個小小的AJAX應(yīng)用，它能夠rate一些東西（譯Keel注：就是對某些東西投票），就像在youtube.com上面看到的一樣。

首先我們需要一些服務(wù)器端代碼，這個例子中用到了一個PHP文件，讀取rating參數(shù)然后返回rating總數(shù)和平均數(shù)。看一下rate.php代碼.

雖然這些例子也可以不使用AJAX來實現(xiàn)，但顯示我們不會那么做，我們用jQuery生成一個DIV容器，ID是"rating".

$(document).ready(function() {
// generate markup
var ratingMarkup = ["Please rate: "];
for(var i=1; i <= 5; i++) {
ratingMarkup[ratingMarkup.length] = "<a href=‘#‘>" + i + "</a> ";
}
// add markup to container and applier click handlers to anchors
$("#rating").append( ratingMarkup.join(‘‘) ).find("a").click(function(e) {
e.preventDefault();
// send requests
$.post("rate.php", {rating: $(this).html()}, function(xml) {
// format result
var result = [
"Thanks for rating, current average: ",
$("average", xml).text(),
", number of votes: ",
$("count", xml).text()
];
// output result
$("#rating").html(result.join(‘‘));
} );
});
});

這段代碼生成了5個鏈接，并將它們追加到id為"rating"容器中，當(dāng)其中一個鏈接被點擊時，該鏈接標(biāo)明的分?jǐn)?shù)就會以rating參數(shù)形式發(fā)送到rate.php，然后，結(jié)果將以XML形式會從服務(wù)器端傳回來，添加到容器中，替代這些鏈接。

如果你沒有一個安裝過PHP的webserver，你可以看看這個在線的例子.

不使用javascript實現(xiàn)的例子可以訪問 點擊 "Kurz bewerten!"

更多的AJAX方法可以從這里 找到，或者看看API文檔 下面的AJAX filed under AJAX.

（譯者Keel注：這個在線實例從國內(nèi)訪問還是比較慢的，點擊后要等一會兒才能看到結(jié)果，可以考慮對它進(jìn)行修改，比如加上loading，投票后加上再投票的返回鏈接等。此外，這個例子中還是有很多需要進(jìn)一步消化的地方，看不懂的地方請參考API文檔。）

一個在使用AJAX載入內(nèi)容時經(jīng)常發(fā)生的問題是：當(dāng)載入一個事件句柄到一個HTML文檔時，還需要在載入內(nèi)容上應(yīng)用這些事件，你不得不在內(nèi)容加載完成后應(yīng)用這些事件句柄，為了防止代碼重復(fù)執(zhí)行，你可能用到如下一個function:

// lets use the shortcut
$(function() {
var addClickHandlers = function() {
$("a.clickMeToLoadContent").click(function() {
$("#target").load(this.href, addClickHandlers);
});
};
addClickHandlers();
});

現(xiàn)在，addClickHandlers只在DOM載入完成后執(zhí)行一次，這是在用戶每次點擊具有clickMeToLoadContent 這個樣式的鏈接并且內(nèi)容加載完成后.

請注意addClickHandlers函數(shù)是作為一個局部變量定義的，而不是全局變量(如：function addClickHandlers() {...})，這樣做是為了防止與其他的全局變量或者函數(shù)相沖突.

另一個常見的問題是關(guān)于回調(diào)(callback)的參數(shù)。你可以通過一個額外的參數(shù)指定回調(diào)的方法，簡單的辦法是將這個回調(diào)方法包含在一個其它的function中:

// get some data
var foobar = ...;
// specify handler, it needs data as a paramter
var handler = function(data) {
...
};
// add click handler and pass foobar!
$(‘a(chǎn)‘).click( function(event) { handler(foobar); } );
// if you need the context of the original handler, use apply:
$(‘a(chǎn)‘).click( function(event) { handler.apply(this, [foobar]); } );

用到簡單的AJAX后，我們可以認(rèn)為已經(jīng)非常之“web2.0”了，但是到現(xiàn)在為止，我們還缺少一些酷炫的效果。下一節(jié)將會談到這些效果.

本章的相關(guān)鏈接:

• jQuery AJAX Module
• jQuery API: Contains description and examples for append and all other jQuery methods
• ThickBox: A jQuery plugin that uses jQuery to enhance the famous lightbox

Animate me(讓我生動起來):使用FX

一些動態(tài)的效果可以使用 show() 和 hide()來表現(xiàn):

$(document).ready(function() {
$("a").toggle(function() {
$(".stuff").hide(‘slow‘);
}, function() {
$(".stuff").show(‘fast‘);
});
});

你可以與 animate()聯(lián)合起來創(chuàng)建一些效果,如一個帶漸顯的滑動效果:

$(document).ready(function() {
$("a").toggle(function() {
$(".stuff").animate({
height: ‘hide‘,
opacity: ‘hide‘
}, ‘slow‘);
}, function() {
$(".stuff").animate({
height: ‘show‘,
opacity: ‘show‘
}, ‘slow‘);
});
});

很多不錯的效果可以訪問interface plugin collection. 這個站點提供了很多demos和文檔

這些效果插件是位于jQuery插件列表的前面的，當(dāng)然也有很多其他的插件，比如我們下一章講到的表格排序插件。

本章的相關(guān)鏈接:

• jQuery FX Module
• Interface plugin

Sort me(將我有序化):使用tablesorter插件(表格排序)

這個表格排序插件能讓我們在客戶端按某一列進(jìn)行排序，引入jQuery和這個插件的js文件，然后告訴插件你想要哪個表格擁有排序功能。

要測試這個例子，先在starterkit.html中加上像下面這一行的代碼：

<script src="lib/jquery.tablesorter.js" type="text/javascript"></script>

然后可以這樣調(diào)用不著:

$(document).ready(function() {
$("#large").tableSorter();
});

現(xiàn)在點擊表格的第一行head區(qū)域，你可以看到排序的效果，再次點擊會按倒過來的順序進(jìn)行排列。

這個表格還可以加一些突出顯示的效果，我們可以做這樣一個隔行背景色（斑馬線）效果:

$(document).ready(function() {
$("#large").tableSorter({
stripingRowClass: [‘odd‘,‘even‘],	// Class names for striping supplyed as a array.
stripRowsOnStartUp: true		// Strip rows on tableSorter init.
});
});

關(guān)于這個插件的更多例子和文檔可以在 tablesorter首頁找到.

幾乎所有的特件都是這樣用的:先include插件的js文件,然后在某些元素上使用插件定義的方法,當(dāng)然也有一些參數(shù)選項是可以配置的

經(jīng)常更新的插件列表可以從jQuery官方站 on the jQuery site找到.

當(dāng)你更經(jīng)常地使用jQuery時,你會發(fā)現(xiàn)將你自己的代碼打包成插件是很有用處的,它能方便地讓你的公司或者其他人進(jìn)行重用.下一章我們將談到如何構(gòu)建一個自己的插件.

本章的相關(guān)鏈接:

• Plugins for jQuery
• Tablesorter Plugin

Plug me:制作自己的插件

寫一個自己的jQuery插件是非常容易的,如果你按照下面的原則來做,可以讓其他人也容易地結(jié)合使用你的插件.

1. 為你的插件取一個名字,在這個例子里面我們叫它"foobar".
2. 創(chuàng)建一個像這樣的文件:jquery.[yourpluginname].js,比如我們創(chuàng)建一個jquery.foobar.js
3. 創(chuàng)建一個或更多的插件方法,使用繼承jQuery對象的方式,如:

   jQuery.fn.foobar = function() {
       // do something
       };

4. 可選的:創(chuàng)建一個用于幫助說明的函數(shù),如:

   jQuery.fooBar = {
       height: 5,
       calculateBar = function() { ... },
       checkDependencies = function() { ... }
       };

   你現(xiàn)在可以在你的插件中使用這些幫助函數(shù)了:

   jQuery.fn.foobar = function() {
       // do something
       jQuery.foobar.checkDependencies(value);
       // do something else
       };

5. 可選的l:創(chuàng)建一個默認(rèn)的初始參數(shù)配置,這些配置也可以由用戶自行設(shè)定,如:

   jQuery.fn.foobar = function(options) {
       var settings = {
       value: 5,
       name: "pete",
       bar: 655
       };
       if(options) {
       jQuery.extend(settings, options);
       }
       };

   現(xiàn)在可以無需做任何配置地使用插件了,默認(rèn)的參數(shù)在此時生效:

   $("...").foobar();

   或者加入這些參數(shù)定義:

   $("...").foobar({
       value: 123,
       bar: 9
       });

如果你release你的插件, 你還應(yīng)該提供一些例子和文檔,大部分的插件都具備這些良好的參考文檔.

現(xiàn)在你應(yīng)該有了寫一個插件的基礎(chǔ),讓我們試著用這些知識寫一個自己的插件.

很多人試著控制所有的radio或者checkbox是否被選中,比如:

$("input[@type=‘checkbox‘]").each(function() {
this.checked = true;
// or, to uncheck
this.checked = false;
// or, to toggle
this.checked = !this.checked;
});

無論何時候，當(dāng)你的代碼出現(xiàn)each時，你應(yīng)該重寫上面的代碼來構(gòu)造一個插件,很直接地:

$.fn.check = function() {
return this.each(function() {
this.checked = true;
});
};

這個插件現(xiàn)在可以這樣用:

$("input[@type=‘checkbox‘]").check();

現(xiàn)在你應(yīng)該還可以寫出uncheck()和toggleCheck()了.但是先停一下,讓我們的插件接收一些參數(shù).

$.fn.check = function(mode) {
var mode = mode || ‘on‘; // if mode is undefined, use ‘on‘ as default
return this.each(function() {
switch(mode) {
case ‘on‘:
this.checked = true;
break;
case ‘off‘:
this.checked = false;
break;
case ‘toggle‘:
this.checked = !this.checked;
break;
}
});
};

這里我們設(shè)置了默認(rèn)的參數(shù),所以將"on"參數(shù)省略也是可以的,當(dāng)然也可以加上"on","off", 或 "toggle",如:

$("input[@type=‘checkbox‘]").check();
$("input[@type=‘checkbox‘]").check(‘on‘);
$("input[@type=‘checkbox‘]").check(‘off‘);
$("input[@type=‘checkbox‘]").check(‘toggle‘);

如果有多于一個的參數(shù)設(shè)置會稍稍有點復(fù)雜,在使用時如果只想設(shè)置第二個參數(shù),則要在第一個參數(shù)位置寫入null.

從上一章的tablesorter插件用法我們可以看到,既可以省略所有參數(shù)來使用或者通過一個 key/value 對來重新設(shè)置每個參數(shù).

作為一個練習(xí),你可以試著將 第四章 的功能重寫為一個插件.這個插件的骨架應(yīng)該是像這樣的:

$.fn.rateMe = function(options) {
var container = this; // instead of selecting a static container with $("#rating"), we now use the jQuery context
var settings = {
url: "rate.php"
// put more defaults here
// remember to put a comma (",") after each pair, but not after the last one!
};
if(options) { // check if options are present before extending the settings
$.extend(settings, options);
}
// ...
// rest of the code
// ...
return this; // if possible, return "this" to not break the chain
});

Next steps(下一步)

如果你想做更好的javascript開發(fā),建議你使用一個叫 FireBug的firefox插件. 它提供了斷點調(diào)試(比alert強(qiáng)多了)、觀察DOM變化等很多漂亮的功能

如果你還有未解決的問題，或者新的想法與建議，你可以使用jQuery的郵件列表 jQuery mailing list.

關(guān)于這個指南的任何事情，你可以寫mail給作者或者發(fā)表評論在他的日志：blog.

關(guān)于這個指南的翻譯任何事情，你可以寫mail給我或者發(fā)表評論在我的日志：blog.

還有什么...

大大感謝John Resig創(chuàng)造了這么好的library! 感謝jQuery community 為John提供了如此多的咖啡和其他的一切!