如何編寫可維護(hù)的JavaScript代碼?
PS:本人非前端開發(fā)人員,此文為業(yè)余興趣之作
JavaScript這門編程語言發(fā)展至今已經(jīng)非常流行了,各種名詞也層出不窮,我們隨便列舉下就有一大堆,比如Node.js、jQuery、 JavaScript MVC、Backbone.js、AMD、CommonJS、RequireJS、CoffeScript、Flexigrid、Highchart、 Script Loader、Script Minifier、JSLint、JSON、Ajax......這么多的東西席卷我們的腦海,無疑讓人頭暈?zāi)垦?。但本質(zhì)的東西總是不變的,而所謂本質(zhì)就是一些核心的基礎(chǔ)概念。這里的基礎(chǔ)不是指JavaScript的表達(dá)式、數(shù)據(jù)類型、函數(shù)API等基礎(chǔ)知識(shí),而是指支撐上面這么一大堆JavaScript 名詞背后東西的基礎(chǔ)。我知道這樣會(huì)讓我這篇文章很難寫下去,因?yàn)槟菍嘀黝},所以本文只打算管中窺豹:本文將先講一些概念,然后講一些實(shí)踐指導(dǎo)原則,***涉及一些工具的討論。
在正式開始這篇博客之前,我們需要問自己為什么代碼可維護(hù)性值得我們關(guān)注。相信只要你寫過相當(dāng)量的代碼后,都已經(jīng)發(fā)現(xiàn)了這點(diǎn):Fix Bug比寫代碼困難得多?;ㄈ齻€(gè)小時(shí)寫的代碼,而之后為了Fix其中的一個(gè)Bug花兩三天時(shí)間,這種情況并不少見。再加上Fix Bug的人很可能不是代碼原作者,這無疑更雪上加霜。所以代碼可維護(hù)性是一個(gè)非常值得探討的話題,提高代碼可維護(hù)性就一定程度上能節(jié)省Fix Bug的時(shí)間,節(jié)省Fix Bug的時(shí)間進(jìn)而就節(jié)省了人力成本。
No 1. 將代碼組織成模塊
基本任何一門編程語言都認(rèn)為模塊化能提升代碼可維護(hù)性。我們知道軟件工程的核心在于控制復(fù)雜度,而模塊化本質(zhì)上是分離關(guān)注點(diǎn),從而分解復(fù)雜度。
IIFE模塊模式
當(dāng)我們最開始學(xué)習(xí)編寫JavaSript代碼時(shí),基本都會(huì)寫下面這樣的代碼:
- var myVar = 10;
- var myFunc = function() {
- // ...
- };
這樣的代碼本身沒有什么問題,但是當(dāng)這樣的代碼越來越多時(shí),會(huì)給代碼維護(hù)帶來沉重的負(fù)擔(dān)。原因是這樣導(dǎo)致myVar和myFunc暴露給全局命名空間,從而污染了全局命名空間。以我個(gè)人經(jīng)驗(yàn)來看,一般當(dāng)某個(gè)頁面中的JavaScript代碼達(dá)到200行左右時(shí)就開始要考慮這個(gè)問題了,尤其是在企業(yè)項(xiàng)目中。那么我們該怎么辦呢?
最簡單的解決方法是采用IIFE(Immediate Invoked Function Expression,立即執(zhí)行函數(shù)表達(dá)式)來解決(注意這里是函數(shù)表達(dá)式,而不是函數(shù)聲明,函數(shù)聲明類似 var myFunc = function() { // ... }),如下:
- (function() {
- var myVar = 10;
- var myFunc = function() {
- // ...
- };
- }) ();
現(xiàn)在myVar和myFunc的作用域范圍就被鎖定在這個(gè)函數(shù)表達(dá)式內(nèi)部,而不會(huì)污染全局命名空間了。這有點(diǎn)類似”沙盒機(jī)制“(也是提供了一個(gè)安全的執(zhí)行上下文)。我們知道JavaScript中沒有塊級(jí)作用域,能產(chǎn)生作用域只能借助函數(shù),正如上面這個(gè)例子一樣。
但是現(xiàn)在myVar、myFunc只能在函數(shù)表達(dá)式內(nèi)部被使用,如果它需要向外提供一些借口或功能(像大部分JavaScript框架或JavaScript庫一樣),那么該怎么辦呢?我們會(huì)采用下面的做法:
- (function(window, $, undefined) {
- var myFunc = function() {
- // ...
- }
- window.myFunc = myFuc;
- }) (window, jQuery);
我們來簡單分析下,代碼很簡單:首先將window對(duì)象和jQuery對(duì)象作為立即執(zhí)行函數(shù)表達(dá)式的參數(shù),$只是傳入的jQuery對(duì)象的別名;其次我們并未傳遞第三個(gè)參數(shù),但是函數(shù)卻有一個(gè)名為undefined的參數(shù),這是一個(gè)小技巧,正因?yàn)闆]有傳第三個(gè)參數(shù),所以這里第三個(gè)參數(shù)undefined的值始終是undefined,就保證內(nèi)部能放心使用undefined,而不用擔(dān)心其他地方修改undefined的值;***通過 window.myFunc導(dǎo)出要暴露給外部的函數(shù)。
比如我們看一個(gè)實(shí)際JavaScript類庫的例子,比如 Validate.js,我們可以看到它是這樣導(dǎo)出函數(shù)的:
- (function(window, document, undefined) {
- var FormValidator = function(formName, fields, callback) {
- // ...
- };
- window.FormValidator = FormValidator;
- }) (window, document);
是不是與前面說的基本一樣?另一個(gè)例子是jQuery插件的編寫范式中的一種,如下:
- (function($) {
- $.fn.pluginName = function() {
- // plugin implementation code
- };
- })(jQuery);
既然jQuery插件都來了,那再來一個(gè)jQuery源碼的例子也無妨:
- (function( window, undefined ) {
- var jQuery = function( selector, context ) { // The jQuery object is actually just the init constructor 'enhanced'
- return new jQuery.fn.init( selector, context, rootjQuery );
- },
- // Expose jQuery to the global object
- window.jQuery = window.$ = jQuery;
- })( window );
上面這樣寫使得我們調(diào)用jQuery函數(shù)既可以用$("body"),又可以用jQuery("body")。
命名空間(Namespace)
雖然使用IIEF模塊模式讓我們的代碼組織成一個(gè)個(gè)模塊,維護(hù)性提升了,但如果代碼規(guī)模進(jìn)一步增大,比如達(dá)到2000-10000級(jí)別,這時(shí)前面方法的局限性又體現(xiàn)出來了?
怎么說呢?觀察下前面的代碼,所有函數(shù)都是通過作為window對(duì)象屬性的方式導(dǎo)出的,這樣如果有很多個(gè)開發(fā)人員同時(shí)在開發(fā),那么就顯得不太優(yōu)雅了。尤其是有的模塊與模塊之間可能存在層級(jí)關(guān)系,這時(shí)候我們需要借助“命名空間”了,命名空間可以用來對(duì)函數(shù)進(jìn)行分組。
我們可以這樣寫:
- (function(myApp, $, undefined) {
- // ...
- }) (window.myApp = window.myApp || {}, jQuery);
或者這樣:
- var myApp = (function(myApp, $, undefined) {
- ...
- return myApp;
- }) (window.myApp || {}, jQuery);
現(xiàn)在我們不再往立即執(zhí)行函數(shù)表達(dá)式傳遞window對(duì)象,而是傳遞掛載在window對(duì)象上的命名空間對(duì)象。第二段代碼中的 || 是為了避免在多個(gè)地方使用myApp變量時(shí)重復(fù)創(chuàng)建對(duì)象。
Revealing Module Pattern
這種模塊模式的主要作用是區(qū)分出私有變量/函數(shù)和公共變量/函數(shù),達(dá)到將私有變量/函數(shù)隱藏在函數(shù)內(nèi)部,而將公有變量/函數(shù)暴露給外部的目的。
代碼示例如下:
- var myModule = (function(window, $, undefined) {
- var _myPrivateVar1 = "";
- var _myPrivateVar2 = "";
- var _myPrivateFunc = function() {
- return _myPrivateVar1 + _myPrivateVar2;
- };
- return {
- getMyVar1: function() { return _myPrivateVar1; },
- setMyVar1: function(val) { _myPrivateVar1 = val; },
- someFunc: _myPrivateFunc
- };
- }) (window, jQuery);
myPrivateVar1、 myPrivateVar2是私有變量,myPrivateFunc是私有函數(shù)。而getMyVar1(public getter)、getMyVar1(public setter)、someFunc是公共函數(shù)。是不是有點(diǎn)類似普通的Java Bean?
或者我們可以寫成這種形式(換湯不換藥):
- var myModule = (function(window, $, undefined) {
- var my= {};
- var _myPrivateVar1 = "";
- var _myPrivateVar2 = "";
- var _myPrivateFunc = function() {
- return _myPrivateVar1 + _myPrivateVar2;
- };
- my.getMyVar1 = function() {
- return _myPrivateVar1;
- };
- my.setMyVar1 = function(val) {
- _myPrivateVar1 = val;
- };
- my.someFunc = _myPrivateFunc;
- return my;
- }) (window, jQuery);
模塊擴(kuò)展(Module Augmentation)
有時(shí)候我們想為某個(gè)已有模塊添加額外功能,可以像下面這樣:
- var MODULE = (function (my) {
- my.anotherMethod = function () {
- // added method...
- };
- return my;
- }(MODULE || {}));
Tight Augmentation
上面的例子傳入的MODULE可能是undefined,也就是說它之前可以不存在。與之對(duì)應(yīng)Tight Augmentation模式要求傳入的MODULE一定存在并且已經(jīng)被加載進(jìn)來。
- var MODULE = (function (my) {
- var old_moduleMethod = my.moduleMethod;
- my.moduleMethod = function () {
- // method override, has access to old through old_moduleMethod...
- };
- return my;
- }(MODULE));
代碼意圖很明顯:實(shí)現(xiàn)了重寫原模塊的moduleMethod函數(shù),并且可以在重寫的函數(shù)中調(diào)用od_moduleMethod。但這種寫法不夠靈活,因?yàn)樗俣艘粋€(gè)先決條件:MODULE模塊一定存在并且被加載進(jìn)來了,且它包含moduleMethod函數(shù)。
子模塊模式
這個(gè)模式非常簡單,比如我們?yōu)楝F(xiàn)有模塊MODULE創(chuàng)建一個(gè)子模塊如下:
- MODULE.sub = (function () {
- var my = {};
- // ...
- return my;
- }());
#p#
No 2. 利用OO
構(gòu)造函數(shù)模式(Constructor Pattern)
JavaScript沒有類的概念,所以我們不可以通過類來創(chuàng)建對(duì)象,但是可以通過函數(shù)來創(chuàng)建對(duì)象。比如下面這樣:
- var Person = function(firstName, lastName, age) {
- this.firstName = firstName;
- this.lastName = lastName;
- this.age = age;
- };
- Person.prototype.country = "China";
- Person.prototype.greet = function() {
- alert("Hello, I am " + this.firstName + " " + this.lastName);
- };
這里firstName、lastName、age可以類比為Java類中的實(shí)例變量,每個(gè)對(duì)象有專屬于自己的一份。而country可以類比為Java類中的靜態(tài)變量,greet函數(shù)類比為Java類中的靜態(tài)方法,所有對(duì)象共享一份。我們通過下面的代碼驗(yàn)證下(在Chrome的控制臺(tái)輸):
- var Person = function(firstName, lastName, age) {
- this.firstName = firstName;
- this.lastName = lastName;
- this.age = age;
- };
- Person.prototype.country = "China";
- Person.prototype.greet = function() {
- alert("Hello, I am " + this.firstName + " " + this.lastName);
- };
- var p1 = new Person("Hub", "John", 30);
- var p2 = new Person("Mock", "William", 23);
- console.log(p1.fistName == p2.firstName); // false
- console.log(p1.country == p2.country); // true
- console.log(p1.greet == p2.greet); // true
但是如果你繼續(xù)測下面的代碼,你得不到你可能預(yù)期的p2.country也變?yōu)閁K:
- p1.country = "UK";
- console.log(p2.country); // China
這與作用域鏈有關(guān),后面我會(huì)詳細(xì)闡述。繼續(xù)回到這里。既然類得以通過函數(shù)模擬,那么我們?nèi)绾文M類的繼承呢?
比如我們現(xiàn)在需要一個(gè)司機(jī)類,讓它繼承Person,我們可以這樣:
- var Driver = function(firstName, lastName, age) {
- this.firstName = firstName;
- this.lastName = lastName;
- this.age = age;
- };
- Driver.prototype = new Person(); // 1
- Driver.prototype.drive = function() {
- alert("I'm driving. ");
- };
- var myDriver = new Driver("Butter", "John", 28);
- myDriver.greet();
- myDriver.drive();
代碼行1是實(shí)現(xiàn)繼承的關(guān)鍵,這之后Driver又定義了它擴(kuò)展的只屬于它自己的函數(shù)drive,這樣它既可以調(diào)用從Person繼承的greet函數(shù),又可以調(diào)用自己的drive函數(shù)了。
#p#
No3. 遵循一些實(shí)踐指導(dǎo)原則
下面是一些指導(dǎo)編寫高可維護(hù)性JavaScript代碼的實(shí)踐原則的不完整總結(jié)。
盡量避免全局變量
JavaScript使用函數(shù)來管理作用域。每個(gè)全局變量都會(huì)成為Global對(duì)象的屬性。你也許不熟悉Global對(duì)象,那我們先來說說Global對(duì)象。ECMAScript中的Global對(duì)象在某種意義上是作為一個(gè)***的“兜底兒”對(duì)象來定義的:即所有不屬于任何其他對(duì)象的屬性和方法最終都是它的屬性和方法。所有在全局作用域中定義的變量和函數(shù)都是Global對(duì)象的屬性。像escape()、encodeURIComponent()、 undefined都是Global對(duì)象的方法或?qū)傩浴?/p>
事實(shí)上有一個(gè)我們更熟悉的對(duì)象指向Global對(duì)象,那就是window對(duì)象。下面的代碼演示了定義全局對(duì)象和訪問全局對(duì)象:
- myglobal = "hello"; // antipattern
- console.log(myglobal); // "hello"
- console.log(window.myglobal); // "hello"
- console.log(window["myglobal"]); // "hello"
- console.log(this.myglobal); // "hello"
使用全局變量的缺點(diǎn)是:
全局變量被應(yīng)用中所有代碼共享,所以很容易導(dǎo)致不同頁面出現(xiàn)命名沖突(尤其是包含第三方代碼時(shí))
全局變量可能與宿主環(huán)境的變量沖突
- function sum(x, y) {
- // antipattern: implied global
- result = x + y;
- return result;
- }
result現(xiàn)在就是一個(gè)全局變量。要改正也很簡單,如下:
- function sum(x, y) {
- var result = x + y;
- return result;
- }
另外通過var聲明創(chuàng)建的全局變量與未通過var聲明隱式創(chuàng)建的全局變量有下面的不同之處:
通過var聲明創(chuàng)建的全局變量無法被delete
而隱式創(chuàng)建的全局變量可以被delete
delete操作符運(yùn)算后返回true或false,標(biāo)識(shí)是否刪除成功,如下:
- // define three globals
- var global_var = 1;
- global_novar = 2; // antipattern
- (function () {
- global_fromfunc = 3; // antipattern
- }());
- // attempt to delete
- delete global_var; // false
- delete global_novar; // true
- delete global_fromfunc; // true
- // test the deletion
- typeof global_var; // "number"
- typeof global_novar; // "undefined"
- typeof global_fromfunc; // "undefined"
推薦使用Single Var Pattern來避免全局變量如下:
- function func() {
- var a = 1,
- b = 2,
- sum = a + b,
- myobject = {},
- i,
- j;
- // function body...
- }
上面只用了一個(gè)var關(guān)鍵詞就讓a、b、sum等變量全部成為局部變量了。并且為每個(gè)變量都設(shè)定了初始值,這可以避免將來可能出現(xiàn)的邏輯錯(cuò)誤,并提高可讀性(設(shè)定初始值意味著能很快看出變量保存的到底是一個(gè)數(shù)值還是字符串或者是一個(gè)對(duì)象)。
局部變量相對(duì)于全局變量的另一個(gè)優(yōu)勢在于性能,在函數(shù)內(nèi)部從函數(shù)本地作用域查找一個(gè)變量毫無疑問比去查找一個(gè)全局變量快。
避免變量提升(hoisting)陷阱
你很可能已經(jīng)看到過很多次下面這段代碼,這段代碼經(jīng)常用來考察變量提升的概念:
- myName = "global";
- function func() {
- console.log(myName); // undefined
- var myName = "local";
- console.log(myName); // local
- }
- func();
這段代碼輸出什么呢?JavaScript的變量提升會(huì)讓這段代碼的效果等價(jià)于下面的代碼:
- myName = "global";
- function func() {
- var myName;
- console.log(myName); // undefined
- myName = "local";
- console.log(myName); // local
- }
- func();
所以輸出為undefined、local就不難理解了。變量提升不是ECMAScript標(biāo)準(zhǔn),但是卻被普遍采用
對(duì)非數(shù)組對(duì)象用for-in,而對(duì)數(shù)組對(duì)象用普通for循環(huán)
雖然技術(shù)上for-in可以對(duì)任何對(duì)象的屬性進(jìn)行遍歷,但是不推薦對(duì)數(shù)組對(duì)象用for-in,理由如下:
如果數(shù)組對(duì)象包含擴(kuò)展函數(shù),可能導(dǎo)致邏輯錯(cuò)誤
for-in不能保證輸出順序
for-in遍歷數(shù)組對(duì)象性能較差,因?yàn)闀?huì)沿著原型鏈一直向上查找所指向的原型對(duì)象上的屬性
所以推薦對(duì)數(shù)組對(duì)象用普通的for循環(huán),而對(duì)非數(shù)組對(duì)象用for-in。但是對(duì)非數(shù)組對(duì)象使用for-in時(shí)常常需要利用hasOwnProperty()來濾除從原型鏈繼承的屬性(而一般不是你想要列出來的),比如下面這個(gè)例子:
- // the object
- var man = {
- hands: 2,
- legs: 2,
- heads: 1
- };
- // somewhere else in the code
- // a method was added to all objects
- if (typeof Object.prototype.clone === "undefined") {
- Object.prototype.clone = function () {};
- }
- for(var i in man) {
- console.log(i, ": ", man[i]);
- }
輸出如下:
- hands : 2
- legs : 2
- heads : 1
- clone : function () {}
即多了clone,這個(gè)可能是另外一個(gè)開發(fā)者在Object的原型對(duì)象上定義的函數(shù),卻影響到了我們現(xiàn)在的代碼,所以規(guī)范的做法有兩點(diǎn)。***堅(jiān)決不允許在原生對(duì)象的原型對(duì)象上擴(kuò)展函數(shù)或者屬性 。 第二將代碼改寫為類似下面這種:
- for(var i in man) {
- if(man.hasOwnProperty(i)) {
- console.log(i, ": ", man[i]);
- }
- }
進(jìn)一步我們可以改寫代碼如下:
- for(var i in man) {
- if(man.hasOwnProperty(i)) {
- console.log(i, ": ", man[i]);
- }
- }
這樣有啥好處呢?***點(diǎn)防止man對(duì)象重寫了hasOwnProperty函數(shù)的情況;第二點(diǎn)性能上提升了,主要是原型鏈查找更快了。
進(jìn)一步緩存Object.prototype.hasOwnProperty函數(shù),代碼變成下面這樣:
- var i, hasOwn = Object.prototype.hasOwnProperty;
- for (i in man) {
- if (hasOwn.call(man, i)) { // filter
- console.log(i, ":", man[i]);
- }
- }
避免隱式類型轉(zhuǎn)換
隱式類型轉(zhuǎn)換可能導(dǎo)致一些微妙的邏輯錯(cuò)誤。我們知道下面的代碼返回的是true:
- 0 == false
- 0 == ""
建議做法是始終使用恒等于和恒不等于,即===和!===。
而對(duì)于下面的代碼:
- null == false
- undefined == false
我們常常期望它返回true的,但卻返回的是false。
那么我們可以用下面的代碼來將其強(qiáng)制轉(zhuǎn)換為布爾類型后比較:
- !!null === false
- !!undefined === false
避免eval()
eval()接受任意字符串并將其作為JavaScript代碼進(jìn)行執(zhí)行,最初常用于執(zhí)行動(dòng)態(tài)生成的代碼,但是eval()是有害的,比如可能導(dǎo)致XSS漏洞,如果根據(jù)某個(gè)可變屬性名訪問屬性值,可以用[]取代eval(),如下:
- // antipattern
- var property = "name";
- alert(eval("obj." + property));
- // preferred
- var property = "name";
- alert(obj[property]);
注意傳遞字符串給setTimeout()、setInterval()和Function()也類似eval(),也應(yīng)該避免。比如下面:
- // antipatterns
- setTimeout("myFunc()", 1000);
- setTimeout("myFunc(1, 2, 3)", 1000);
- // preferred
- setTimeout(myFunc, 1000);
- setTimeout(function () {
- myFunc(1, 2, 3);
- }, 1000);
如果你遇到非要使用eval()不可的場景,用new Function()替代,因?yàn)閑val()的字符串參數(shù)中即使通過var聲明變量,它也會(huì)成為一個(gè)全局變量,而new Function()則不會(huì),如下:
- eval("var myName='jxq'");
則myName成了全局變量,而用newFunction()如下:
- var a = new Function("firstName, lastName", "var myName = firstName+lastName");
實(shí)際上a現(xiàn)在是一個(gè)匿名函數(shù):
- function anonymous(firstName, lastName) {
- var myName = firstName+lastName
- }
則myName現(xiàn)在就不是全局變量了。當(dāng)然如果還堅(jiān)持用eval(),可以用一個(gè)立即執(zhí)行函數(shù)表達(dá)式將eval()包起來:
- (function() {
- eval("var myName='jxq';");
- }) (); // jxq
- console.log(typeof myName); // undefined
另外一個(gè)eval()和Function()的區(qū)別是前者會(huì)影響作用域鏈,而后者不會(huì),如下:
- (function() {
- var local = 1;
- eval("console.log(typeof local);");
- })(); // number
- (function() {
- var local = 1;
- Function("console.log(typeof local);");
- })(); // undefined
使用parseInt()時(shí),指定第二個(gè)進(jìn)制參數(shù)
這個(gè)不用多提,相信大家也都知道了
使用腳本引擎,讓JavaScript解析數(shù)據(jù)生成HTML
傳說中的12306在查詢車票時(shí)返回的是下面這么一大串(我已無力吐槽,這個(gè)是我今天剛截的,實(shí)際大概100來行):
- <span id='id_240000G13502' class='base_txtdiv' onmouseover=javascript:onStopHover('240000G13502#VNP#AOH') onmouseout='onStopOut()'>G135</span>,<img src='/otsweb/images/tips/first.gif'> 北京南
- <br>
- 12:40,<img src='/otsweb/images/tips/last.gif'> 上海虹橋
- <br>
- 18:04,05:24,8,--,<font color='#008800'>有</font>,<font color='#008800'>有</font>,--,--,--,--,--,--,--,<a name='btn130_2' class='btn130_2' style='text-decoration:none;' onclick=javascript:getSelected('G135#05:24#12:40#240000G13502#VNP#AOH#18:04#北京南#上海虹橋#01#08#O*****0072M*****00629*****0008#8A72A4AD8B70A5E0FF02AC9290DDB39C6E0B6D***0F8A9A8FB305FB11#P2')>預(yù) 訂</a>\n1,<span id='id_240000G13705' class='base_txtdiv' onmouseover=javascript:onStopHover('240000G13705#VNP#AOH') onmouseout='onStopOut()'>G137</span>,<img src='/otsweb/images/tips/first.gif'> 北京南
- <br>
- 12:45,<img src='/otsweb/images/tips/last.gif'> 上海虹橋
為什么不能只返回?cái)?shù)據(jù)(比如用JSON),然后利用JavaScript模板引擎解析數(shù)據(jù)呢?比如下面這樣(使用了jQuery tmpl模板引擎,詳細(xì)參考我的代碼 JavaScript模板引擎使用):
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>JavaScript tmpl Use Demo</title>
- <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
- <script src="./tmpl.js" type="text/javascript"></script>
- <!-- 下面是模板user_tmpl -->
- <script type="text/html" id="user_tmpl">
- <% for ( var i = 0; i < users.length; i++ ) { %>
- <li><a href="<%=users[i].url%>"><%=users[i].name%></a></li>
- <% } %>
- </script>
- <script type="text/javascript">
- // 用來填充模板的數(shù)據(jù)
- var users = [
- { url: "http://baidu.com", name: "jxq"},
- { url: "http://google.com", name: "william"},
- ];
- $(function() {
- // 調(diào)用模板引擎函數(shù)將數(shù)據(jù)填充到模板獲得最終內(nèi)容
- $("#myUl").html(tmpl("user_tmpl", users));
- });
- </script>
- </head>
- <body>
- <div>
- <ul id="myUl">
- </ul>
- </div>
- </body>
- </html>
使用模板引擎可以將數(shù)據(jù)和HTML內(nèi)容完全分離,這樣有幾個(gè)好處:
修改HTML結(jié)構(gòu)時(shí)幾乎可以不修改返回的數(shù)據(jù)的結(jié)構(gòu)
只返回純粹的數(shù)據(jù),節(jié)省了網(wǎng)絡(luò)帶寬(網(wǎng)絡(luò)帶寬就是錢)
采用一致的命名規(guī)范
構(gòu)造函數(shù)首字母大寫。
而非構(gòu)造函數(shù)的首字母小寫,標(biāo)識(shí)它們不應(yīng)該通過new操作符被調(diào)用。
常量名稱應(yīng)該全大寫。
私有變量或似有函數(shù)名稱前帶上下劃線,如下:
- var person = {
- getName: function () {
- return this._getFirst() + ' ' + this._getLast();
- },
- _getFirst: function () {
- // ...
- },
- _getLast: function () {
- // ...
- }
- };
不吝嗇注釋,但也不要胡亂注釋
為一些相對(duì)艱澀些的代碼(比如算法實(shí)現(xiàn))添加注釋。
為函數(shù)的功能、參數(shù)和返回值添加注釋。
不要對(duì)一些常識(shí)性的代碼進(jìn)行注釋,也不要像下面這樣多此一舉地注釋:
- var myName = "jxq"; // 聲明字符串變量myName,其值為"jxq"
#p#
No4. 合理高效地使用工具
這里的工具包括JavaScript框架、JavaScript類庫以及一些平時(shí)自己積累的Code Snippet。
使用JavaScript框架的好處是框架為我們提供了一種合理的組織代碼方式,比如Backbone.js、Knockout.js這種框架能讓我們更好地將代碼按MVC或者M(jìn)VP模式分離。
而使用JavaScript類庫可以避免重復(fù)造輪子(而且往往造出一些不那么好的輪子),也可以讓我們更專注于整體業(yè)務(wù)流程而不是某個(gè)函數(shù)的具體實(shí)現(xiàn)。一些通用的功能如日期處理、金額數(shù)值處理***用現(xiàn)有的成熟類庫。
***使用自己平時(shí)積累的Code Snippet可以提高我們的編碼效率,并且最重要的是可以提供多種參考解決方案。
下面是一些流行的工具列表。
它提供了完全自定制功能,支持選項(xiàng)組、回調(diào)函數(shù)等等。另外一個(gè)擴(kuò)展Select控件的插件是jQuery Chosen,可以參考我分享的代碼:美化Select下拉框
它提供了表單離線存儲(chǔ)功能,能夠自動(dòng)保存用戶未提交的表單數(shù)據(jù)。而當(dāng)提交表單后會(huì)清除數(shù)據(jù)。
這個(gè)類庫允許我們將HTML文本轉(zhuǎn)換成輸入域。
這是一個(gè)輕量級(jí)表單驗(yàn)證類庫,它預(yù)定義了一系列驗(yàn)證規(guī)則(通過正則表達(dá)式),并且支持定制驗(yàn)證回調(diào)函數(shù)和驗(yàn)證失敗消息,兼容所有主流瀏覽器(包括IE 6),更詳細(xì)的信息有興趣的話可以參考我的博客 Validate.js框架源碼完全解讀
jQuery文件上傳插件,支持多文件上傳
Handsontables: Excel-Like Tables For The Web
提供Web Excel功能的jQuery插件
通過Pivot我們可以很方便地展現(xiàn)大量數(shù)據(jù)。數(shù)據(jù)源可以是CSV或者JSON
一個(gè)很方便的日期處理類庫。
使用很簡單,下面是兩個(gè)小實(shí)例:
- // What date is next thursday?
- Date.today().next().thursday();
- // Add 3 days to Today
- Date.today().add(3).days();
- ...
RequireJS是一個(gè)JavaScript文件和模塊加載器。使用RequireJS可以顯著提高代碼的運(yùn)行效率。據(jù)說百度音樂盒利用RequireJS后加載速度提高了好幾秒(按需加載),號(hào)稱神器。
Grunt.js是一個(gè)基于任務(wù)的命令行工具,可以用于JavaScript項(xiàng)目構(gòu)建。它預(yù)包含幾十個(gè)內(nèi)置的任務(wù):文件合并、項(xiàng)目腳手架(基于一個(gè)預(yù)定義的模板)、JSLint驗(yàn)證、UglifyJS代碼壓縮、qUnit單元測試、啟動(dòng)服務(wù)器等。
參考資料:
http://www.codethinked.com/preparing-yourself-for-modern-javascript-development
http://www.adequatelygood.com/JavaScript-Module-Pattern-In-Depth.html
http://net.tutsplus.com/tutorials/javascript-ajax/the-essentials-of-writing-high-quality-javascript/