jQuery中文入門指南,翻譯加實例,jQuery的起點教程

  轉載http://hi.baidu.com/wolftotem1984/blog/item/4335a618aa097ab44aedbcc5.html  

中文版譯者:Keel

此文以實例爲基礎一步步說明了jQuery的工作方式。現以中文翻譯(添加我的補充說明)如下。如有相關意見或建議請麻煩到我的 BLOG 寫個回覆或者 EMAIL 告知。

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

本文發佈已徵求原作者同意。

另外我認爲在學習過程中,有兩個API文檔你要打開隨時查看:
http://jquery.com/api/
http://visualjquery.com/
以下部分爲原文翻譯:
jQuery入門指南教程

這個指南是一個對jQuery庫的說明,要求讀者瞭解HTML(DOM)和CSS的一些常識。它包括了一個簡單的Hello World的例子,選擇器和事件基礎,AJAX、FX的用法,以及如何製作jQuery的插件。 這個指南包括了很多代碼,你可以copy它們,並試着修改它們,看看產生的效果。
內容提要
安裝
Hello jQuery
Find me:使用選擇器和事件
Rate me:使用AJAX
Animate me(讓我生動起來):使用FX
Sort me(將我有序化):使用tablesorter插件(表格排序)
Plug me:製作您自己的插件
Next steps(下一步)
安裝

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

下載:jQuery Starterkit

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

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

現在,我們就已經做好了一切準備來進行這個著名的"Hello world"例子.
本章的相關鏈接:
Starterkit
jQuery Downloads
Hello jQuery

在做所有事情之前,我們要讓jQuery讀取和處理文檔的DOM,必須儘可能快地在DOM載入後開始執行事件,所以,我們用一個ready事件作爲處理HTML文檔的開始.看看我們打開的custom.js這個文件,裏面已經準備好了:
$(document).ready(function() {
// do stuff when DOM is ready
});

放一個簡單的alert事件在需要等DOM完成載入,所以我們把任務稍稍變複雜一點:在點擊任何一個鏈接時顯示一個alert.
$(document).ready(function() {
$("a").click(function() {
alert("Hello world!");
});
});

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

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

讓我們看一下這些修改是什麼含義。$("a") 是一個jQuery選擇器(selector),在這裏,它選擇所有的a標籤(譯者Keel注:即),$ 號是 jQuery “類”(jQuery "class")的一個別稱,因此$()構造了一個新的jQuery 對象(jQuery object)。函數 click() 是這個jQuery對象的一個方法,它綁定了一個單擊事件到所有選中的標籤(這裏是所有的a標籤),並在事件觸發時執行了它所提供的alert方法.

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

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

下面我們會更多地瞭解到選擇器與事件.
本章的相關鏈接:
jQuery Base
jQuery Expressions
jQuery Basic Events
Find me:使用選擇器和事件

jQuery 提供兩種方式來選擇html的 elements,第一種是用CSS和Xpath選擇器聯合起來形成一個字符串來傳送到jQuery的構造器(如:$("div > ul a"));第二種是用jQuery對象的幾個methods(方法)。這兩種方式還可以聯合起來混合使用。

爲了測試一下這些選擇器,我們來試着在我們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 )背景色變成了紅色,而第二個有序列表沒有變化.

現在,讓我們添加一些新的樣式到list的子節點.
$(document).ready(function() {
$("#orderedlist > li").addClass("blue");
});

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

現在我們再做個複雜一點的,當把鼠標放在li對象上面和移開時進行樣式切換,但只在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,也提供了相應的方法。

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

用這些選擇器和事件你已經可以做很多的事情了,但這裏有一個更強的好東東!
$(document).ready(function() {
$("#orderedlist").find("li").each(function(i) {
$(this).html( $(this).html() + " BAM! " + i );
});
});

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

另一個經常碰到的任務是在沒有被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,源文件有
Rate me:使用AJAX

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

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

雖然這些例子也可以不使用AJAX來實現,但顯示我們不會那麼做,我們用jQuery生成一個DIV容器,ID是"rating".
$(document).ready(function() {
// generate markup
var ratingMarkup = ["Please rate: "];
for(var i=1; i <= 5; i++) {
ratingMarkup[ratingMarkup.length] = "" + i + " ";
}
// 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"容器中,當其中一個鏈接被點擊時,該鏈接標明的分數就會以rating參數形式發送到rate.php,然後,結果將以XML形式會從服務器端傳回來,添加到容器中,替代這些鏈接。

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

不使用javascript實現的例子可以訪問 softonic.de 點擊 "Kurz bewerten!"

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

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

一個在使用AJAX載入內容時經常發生的問題是:當載入一個事件句柄到一個HTML文檔時,還需要在載入內容上應用這些事件,你不得不在內容加載完成後應用這些事件句柄,爲了防止代碼重複執行,你可能用到如下一個function:
// lets use the shortcut
$(function() {
var addClickHandlers = function() {
$("a.clickMeToLoadContent").click(function() {
$("#target").load(this.href, addClickHandlers);
});
};
addClickHandlers();
});

現在,addClickHandlers只在DOM載入完成後執行一次,這是在用戶每次點擊具有clickMeToLoadContent 這個樣式的鏈接並且內容加載完成後.

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

另一個常見的問題是關於回調(callback)的參數。你可以通過一個額外的參數指定回調的方法,簡單的辦法是將這個回調方法包含在一個其它的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').click( function(event) { handler(foobar); } );

// if you need the context of the original handler, use apply:
$('a').click( function(event) { handler.apply(this, [foobar]); } );

用到簡單的AJAX後,我們可以認爲已經非常之“web2.0”了,但是到現在爲止,我們還缺少一些酷炫的效果。下一節將會談到這些效果.
本章的相關鏈接:
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

一些動態的效果可以使用 show() 和 hide()來表現:
$(document).ready(function() {
$("a").toggle(function() {
$(".stuff").hide('slow');
}, function() {
$(".stuff").show('fast');
});
});

你可以與 animate()聯合起來創建一些效果,如一個帶漸顯的滑動效果:
$(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插件列表的前面的,當然也有很多其他的插件,比如我們下一章講到的表格排序插件。
本章的相關鏈接:
jQuery FX Module
Interface plugin
Sort me(將我有序化):使用tablesorter插件(表格排序)

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

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

然後可以這樣調用不着:
$(document).ready(function() {
$("#large").tableSorter();
});

現在點擊表格的第一行head區域,你可以看到排序的效果,再次點擊會按倒過來的順序進行排列。

這個表格還可以加一些突出顯示的效果,我們可以做這樣一個隔行背景色(斑馬線)效果:
$(document).ready(function() {
$("#large").tableSorter({
stripingRowClass: ['odd','even'], // Class names for striping supplyed as a array.
stripRowsOnStartUp: true // Strip rows on tableSorter init.
});
});

關於這個插件的更多例子和文檔可以在 tablesorter首頁找到.

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

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

當你更經常地使用jQuery時,你會發現將你自己的代碼打包成插件是很有用處的,它能方便地讓你的公司或者其他人進行重用.下一章我們將談到如何構建一個自己的插件.
本章的相關鏈接:
Plugins for jQuery
Tablesorter Plugin
Plug me:製作自己的插件

寫一個自己的jQuery插件是非常容易的,如果你按照下面的原則來做,可以讓其他人也容易地結合使用你的插件.
爲你的插件取一個名字,在這個例子裏面我們叫它"foobar".
創建一個像這樣的文件:jquery.[yourpluginname].js,比如我們創建一個jquery.foobar.js
創建一個或更多的插件方法,使用繼承jQuery對象的方式,如:
jQuery.fn.foobar = function() {
// do something
};
可選的:創建一個用於幫助說明的函數,如:
jQuery.fooBar = {
height: 5,
calculateBar = function() { ... },
checkDependencies = function() { ... }
};

你現在可以在你的插件中使用這些幫助函數了:
jQuery.fn.foobar = function() {
// do something
jQuery.foobar.checkDependencies(value);
// do something else
};
可選的l:創建一個默認的初始參數配置,這些配置也可以由用戶自行設定,如:
jQuery.fn.foobar = function(options) {
var settings = {
value: 5,
name: "pete",
bar: 655
};
if(options) {
jQuery.extend(settings, options);
}
};

現在可以無需做任何配置地使用插件了,默認的參數在此時生效:
$("...").foobar();

或者加入這些參數定義:
$("...").foobar({
value: 123,
bar: 9
});

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

現在你應該有了寫一個插件的基礎,讓我們試着用這些知識寫一個自己的插件.

很多人試着控制所有的radio或者checkbox是否被選中,比如:
$("input[@type='checkbox']").each(function() {
this.checked = true;
// or, to uncheck
this.checked = false;
// or, to toggle
this.checked = !this.checked;
});

無論何時候,當你的代碼出現each時,你應該重寫上面的代碼來構造一個插件,很直接地:
$.fn.check = function() {
return this.each(function() {
this.checked = true;
});
};

這個插件現在可以這樣用:
$("input[@type='checkbox']").check();

現在你應該還可以寫出uncheck()和toggleCheck()了.但是先停一下,讓我們的插件接收一些參數.
$.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;
}
});
};

這裏我們設置了默認的參數,所以將"on"參數省略也是可以的,當然也可以加上"on","off", 或 "toggle",如:
$("input[@type='checkbox']").check();
$("input[@type='checkbox']").check('on');
$("input[@type='checkbox']").check('off');
$("input[@type='checkbox']").check('toggle');

如果有多於一個的參數設置會稍稍有點複雜,在使用時如果只想設置第二個參數,則要在第一個參數位置寫入null.

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

作爲一個練習,你可以試着將 第四章 的功能重寫爲一個插件.這個插件的骨架應該是像這樣的:
$.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開發,建議你使用一個叫 FireBug的firefox插件. 它提供了斷點調試(比alert強多了)、觀察DOM變化等很多漂亮的功能

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

關於這個指南的任何事情,你可以寫mail給作者或者發表評論在他的日誌:blog.

關於這個指南的翻譯任何事情,你可以寫mail給我或者發表評論在我的日誌:blog.
還有什麼...

大大感謝John Resig創造了這麼好的library! 感謝jQuery community 爲John提供瞭如此多的咖啡和其他的一切!
© 2006, Jörn Zaefferer - last update: 2006-09-12
中文版翻譯:Keel
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章