jQuery開發(fā)者:你真的需要一個插件嗎?
jQuery的插件提供了一個很好的方法,節(jié)省了時間和簡化了開發(fā),避免程序員從頭開始編寫每個組件。但是,插件也將一個不穩(wěn)定因素引入代碼中。一個好的插件節(jié)省了無數(shù)的開發(fā)時間,一個質(zhì)量不好的插件會導(dǎo)致修復(fù)錯誤的時間比實際從頭 開始編寫組件的時間還長。
關(guān)于jQuery,51CTO推薦專題:jQuery從入門到精通
幸運的是,人們通常具有各種不同的插件可供選擇。但是,即使你只用一個,也要弄清楚它是否值得使用的。永遠不要在你的代碼庫中引入錯誤的代碼。
你需要一個插件嗎?
首先是要弄清楚究竟你是否需要一個插件。如果不需要,既可以節(jié)省文件大小,又可以節(jié)省自己的時間。
1.自己寫是不是更好?
如果功能很簡單,就自己寫。jQuery的插件經(jīng)常會捆綁各種功能,這可能矯枉過正。在這種情況下,手寫任何簡單的功能往往更有意義。當(dāng)然,要對所涉及的工作量有所衡量。
舉例來說,如果你需要更先進的功能,jQuery UI的手風(fēng)琴是很好的選擇。但如果你只需要打開和關(guān)閉面板。如果你還沒有在你的網(wǎng)站上使用jQuery UI上,考慮jQuery的 slideToggle()或animate()。
2.是不是你已經(jīng)在使用一個類似的插件?
在發(fā)現(xiàn)某個插件不能解決你需要的一切,尋找另一個插件來彌補,十分有誘惑。但在同一個應(yīng)用程式包括兩個類似的插件,肯定是一個臃腫的JavaScript。你能找到一個插件,包括你所有的需求么?如果沒有,你能擴展其中一個插件達到你所需要涵蓋的一切嗎?同樣,在決定是否擴展一個插件,權(quán)衡的是好處和開發(fā)時間。
舉例來說,jQuery的燈箱是在畫廊里顯示彈出的照片很好的方法, simpleModal是個很棒的方法向用戶顯示模式信息。但是,為什么這兩種方式你的網(wǎng)站都使用?你可以輕松地擴展一個覆蓋這兩種需求。更好的是,找到一個插件,它涵蓋一切,諸如Colorbox。
3.需要JavaScript?
在某些情況下,JavaScript是沒有必要的。CSS的偽選擇器,例如:hover和CSS3 transitios功能,可以涵蓋各種動態(tài)效果,速度遠遠超過了JavaScript的解決方案。此外,許多插件只提供樣式;感覺用markup和CSS的可能更好些。
如果你需要展示動態(tài)內(nèi)容,要求有條件的提示,jQuery Tooltip是必不可少的。但是,如果你需要提示的地方只有幾個,***是用純CSS(見本例)。靜態(tài)提示信息,你可以更進一步利用CSS3過渡進行動畫效果,但不要忘記在該動畫將只在某些瀏覽器有效。
當(dāng)審查任何插件,一系列的警告標(biāo)志表明了這款插件的質(zhì)量較差。在這里,我們將看看插件的方方面面,從JavaScript到CSS到mark-up。我們甚至?xí)紤]如何發(fā)布插件。插件中出現(xiàn)任何警告都會將你的插件排除在考慮之外。如果你很幸運,有多個插件供選擇,這些警告條例可以幫助你縮小選擇。但是,即使只有一個選擇,如果你看到太多的警示還是放棄的好??梢蕴崆皽p少自己的頭痛。
4.奇怪的選項或參數(shù)語法
在使用jQuery的時候,開發(fā)工程師關(guān)心的是函數(shù)如何接受參數(shù)。如果一個插件開發(fā)人員使用特殊的語法,有理由相信他們沒有太多的jQuery或JavaScript的編程經(jīng)驗。
有些插件接受一個jQuery對象作為一個參數(shù),但不允許鏈式使用該對象,例如,$.myPlugin( $('a') );,而不是$('a').myPlugin();這是一個很大的警告。
- jQuery代碼:
- $('.my-selector').myPlugin({
- opt1 : 75,
- opt2 : 'asdf'
- });
- $('.my-selector').myPlugin({
- opt1 : 75,
- opt2 : 'asdf'
- });
- jQuery代碼:
- $.myPlugin({
- opt1 : 75,
- opt2 : 'asdf'
- }, $('.my-selector'));
- $.myPlugin({
- opt1 : 75,
- opt2 : 'asdf'
- }, $('.my-selector'));
5.很少或幾乎沒有文檔
沒有文檔,一個插件的使用就非常困難,因為這是尋找問題答案想到的***個地方。文件有各種格式,適當(dāng)?shù)奈募?**的,但良好的代碼注釋可以一樣好。如果沒有文檔,或者僅僅是在博客發(fā)表的一個簡單例子,那么你可能要考慮其他選擇。良好的文檔表明該插件的作者關(guān)心你這樣的用戶。它還表明,他們已經(jīng)研究過其他插件,知道好文檔的價值。
6.可憐的支持記錄
缺乏支持,表示發(fā)現(xiàn)問題時將難以得到幫助。更引人關(guān)注的是,它表明該插件有段時間沒更新了。軟件開源的一個好處是它吸引很多眼球,幫助你調(diào)試和改進。如果作者沒有談到這些人,該插件將不會更新。
你考慮的插件***一次更新是在什么時候?***一次回答留言是什么時候?雖然不是所有的插件都需要像jQuery plug-ins 這個網(wǎng)站一樣有個強有力的支持系統(tǒng)。警惕那些從來沒有更新的插件。
擁有歷史技術(shù)支持記錄,作者回應(yīng)bug或者將強需求,是一個綠色標(biāo)志。擁有一個支持論壇進一步表示這個插件有很好的支持,即使不是作者至少有論壇給你解決問題。
7.沒有壓縮版本
雖然事一個相當(dāng)小的警示,如果插件的創(chuàng)建者并沒有根據(jù)源代碼提供一個壓縮版本,那么他們可能不會太關(guān)注表現(xiàn)。當(dāng)然,你可以自己去壓縮,但這個警示不是討論浪費時間的問題:這暗示了插件可能包含更為嚴重的性能問題。
另一方面,提供壓縮,打包和gzipped版本下載是一個跡象。
8.需要奇怪的Mark-up
如果一個插件需要mark-up,那么這個mark-up應(yīng)是高質(zhì)量的。它應(yīng)符合語義semantic sense而且足夠靈活。除了很爛的前端技術(shù),奇怪的mark-up也會使集成變得更加困難。一個好的插件插入幾乎任何涵蓋了任何你常用mark-up;使用一個壞插件還不如去跳火圈。
在某些情況下,嚴格的mark-up是必要的,所以應(yīng)該允許在一定范圍內(nèi)的使用。基本上,更具體的功能,更具體的mark-up需要。完全靈活的mark-up是從任何自然下降jQuery的選擇是最簡單的集成。
#p#
9.過度使用CSS
許多的jQuery插件包括了CSS,css的質(zhì)量和JavaScript重要是一樣的。過多的CSS肯定是一個壞標(biāo)志。但什么是“過度”取決于插件的目的。注重顯示,如燈箱或UI插件,比簡單動畫驅(qū)動的插件要更多的CSS。良好的CSS樣式,讓程序更容易修改以適應(yīng)你的主題風(fēng)格。
10.沒有其他人使用它
jQuery的用戶數(shù)量龐大,最體面的插件將可能對某事有他們寫的,即使它是一個“50 jQuery [fill in the blank]”。比如你做了一個簡單的谷歌搜索插件,你搜索結(jié)果很少,你可能要考慮其他選擇,除非該插件是全新的,或者你會找個專業(yè)寫插件的工程師來修改它。
11.使用和觀察
測試插件***的方式是簡單地在服務(wù)器上運行,看看結(jié)果。首先,它是否破壞了一些規(guī)則?請務(wù)必看看JavaScript的代碼段。如果插件包括一個樣式表,看看每個網(wǎng)頁的布局和樣式上的錯誤。
此外,請問該插件的效果如何?如果它運行速度很慢或網(wǎng)頁載入相當(dāng)滯后,還是考慮其他插件吧。
12.使用JSPerf進行績效考核
把你的插件展現(xiàn)效果提高到新的水平,使用JSPerf進行測試。Benchmarking會運行的一組操作多次,然后返回平均執(zhí)行時間。JSPerf提供了一個簡單的方法來測試一個插件運行的速度有多快。這是挑選兩個幾乎相同插件的重要的方式來。
13.跨瀏覽器測試
如果一個插件有很多CSS,一定要在所有你希望支持的瀏覽器測試樣式。記住CSS可以來自外部樣式表和內(nèi)部JavaScript。
即使插件沒有任何CSS,無論如何要在所有瀏覽器上檢查JavaScript錯誤(至少在你支持的IE瀏覽器的最早版本)。jQuery的核心已經(jīng)處理了大多數(shù)跨瀏覽器問題,但插件往往使用一些的數(shù)量純JavaScript,這往往會打破舊瀏覽器的規(guī)則。
運行中的jsPerf
14.單元測試
***,進一步考慮跨瀏覽器測試--單元測試。單元測試是測試組件插件的簡單方法,支持任何瀏覽器或平臺。如果該插件作者的下載包里已經(jīng)包括了單元測試,可以打賭,這款插件能在所有跨瀏覽器和平臺上工作。不幸的是,極少數(shù)插件才包括單元測試數(shù)據(jù),但這并不意味著你不能使用QUnit plug-in執(zhí)行自己的單元測試。
用最小的設(shè)置,測試是否該插件的方法返回了預(yù)期結(jié)果。只要有一個測試失敗,不要在這個插件上浪費你的時間。在大多數(shù)情況下,執(zhí)行單元測試有點浪費時間,但QUnit可以幫助你確定插件的質(zhì)量。
QUnit運行單元測試的一個例子
結(jié)論
當(dāng)評估一個jQuery插件的質(zhì)量,先評估代碼質(zhì)量。JavaScript是否有優(yōu)化、沒有錯誤?CSS是否已經(jīng)調(diào)整并有效?mark-up的命名是否有語義,足夠靈活?這些問題都歸結(jié)為最重要的問題:這個插件很容易使用?
jQuery的核心進行了優(yōu)化和錯誤檢查,支持它的不僅有核心團隊成員,還有整個jQuery社區(qū)。雖然用同樣的標(biāo)準衡量jQuery插件不公平,但至少應(yīng)該有一些相同的審查標(biāo)準。
原文作者:Jon Raasch
原文鏈接:http://www.smashingmagazine.com/2010/08/26/jquery-plugin-checklist-should-you-use-that-jquery-plug-in/
【編輯推薦】