前端優(yōu)秀實踐之可維護(hù)性
在早期網(wǎng)站中，JavaScript主要用于實現(xiàn)一些小型動效或表單驗證。今天的Web應(yīng)用則動輒成千上萬行JavaScript代碼，用于完成各種各樣復(fù)雜的處理。這些變化要求開發(fā)者把可維護(hù)能力放到重要位置上。正如更傳統(tǒng)意義上的軟件工程師一樣，JavaScript工程師受雇是要為公司創(chuàng)造價值的?，F(xiàn)代前端工程師的使命，不僅僅是要保證產(chǎn)品如期上線，更重要的是要隨著時間推移為公司不斷積累知識資產(chǎn)。
編寫可維護(hù)的代碼十分重要，因為很多開發(fā)者都會花大量時間去維護(hù)別人寫的代碼。實際開發(fā)中，從第一行代碼開始寫起的情況是非常少見的。通常都是要在別人的代碼之上來構(gòu)建自己的工作。讓自己的代碼容易維護(hù)，可以保證其他開發(fā)者更好地完成自己的工作。
注意：可維護(hù)代碼的概念并不止適用于JavaScript，其中很多概念適用于任何編程語言。當(dāng)然，有部分概念可能確實是特定于JavaScript的。
1. 什么是可維護(hù)的代碼
可維護(hù)的代碼有幾個特點。通常，說代碼可維護(hù)就意味著它具備如下特點。
- 容易理解：無需求助原始開發(fā)者，任何人一看代碼就知道是干什么的，怎么實現(xiàn)的。
- 符合常識：代碼中的一切都顯得自然而然，無論操作有多么復(fù)雜。
- 容易適配：即使數(shù)據(jù)發(fā)生變化也不用完全重寫。
- 容易擴(kuò)展：代碼架構(gòu)經(jīng)過認(rèn)真設(shè)計，支持未來擴(kuò)展核心功能。
- 容易調(diào)試：出問題時，代碼可以給出明確的信息，通過它能直接定位問題。
能夠?qū)懗隹删S護(hù)的JavaScript代碼是一項重要的專業(yè)技能。這個技能是一個周末就拼湊一個網(wǎng)站的業(yè)余愛好者和對自己所做的一切都深思熟慮的專業(yè)開發(fā)者的重要區(qū)別。
2. 編碼規(guī)范
編寫可維護(hù)代碼的第一步是認(rèn)真考慮編碼規(guī)范。編碼規(guī)范在多數(shù)編程語言中都會涉及，簡單上網(wǎng)一搜，就可以找到成千上萬的相關(guān)文章。專業(yè)組織都會有為開發(fā)者建立的編碼規(guī)范，旨在讓人寫出更容易維護(hù)的代碼。優(yōu)秀開源項目都有嚴(yán)格的編碼規(guī)范，能夠讓社區(qū)的所有人容易理解代碼的組織。
編碼規(guī)范對JavaScript而言非常重要，因為這門語言實在太靈活了。與多數(shù)面向?qū)ο笳Z言不同，JavaScript并不強(qiáng)迫開發(fā)者把任何東西都定義為對象。相反，JavaScript支持任何編程風(fēng)格，包括傳統(tǒng)的面向?qū)ο缶幊毯吐暶魇骄幊蹋约昂瘮?shù)式編程。簡單看幾個開源的JavaScript庫，就會發(fā)現(xiàn)有很多方式可以創(chuàng)建對象、定義方法和管理環(huán)境。
接下來的幾節(jié)會討論制定編碼規(guī)范的一些基礎(chǔ)方面。這些主題都很重要，當(dāng)然每個人的需求不同，實現(xiàn)方式也可以不同。
2.1 可讀性
要想讓代碼容易維護(hù)，首先必須讓人容易看懂?？勺x性必須考慮代碼是一種文本文件。為此，代碼縮進(jìn)是保證可讀性的重要基礎(chǔ)。如果所有人都使用相同的縮進(jìn)，整個項目的代碼就會更容易看懂?？s進(jìn)通常要使用空格數(shù)而不是Tab(制表符)來定義，因為后者在不同文本編輯器中的顯示會有差異。一般來說，縮進(jìn)都是以4個空格為單位，當(dāng)然具體多少個可以自己定。
可讀性的另一方面是代碼注釋。在多數(shù)編程語言中，廣泛接受的做法是為每個方法都編寫注釋。由于JavaScript可以在代碼中任何地方創(chuàng)建函數(shù)，所以這一點容易被忽視。正因為如此，可能給JavaScript中的每個函數(shù)都寫注釋才更重要。一般來說，以下這些地方都是應(yīng)該寫注釋的。
- 函數(shù)和方法。每個函數(shù)和方法都應(yīng)該有注釋來描述其用途，以及完成任務(wù)所用的算法。同時，也寫清使用這個函數(shù)或方法的前提(假設(shè))、每個參數(shù)的含義，以及函數(shù)是否返回值(因為通過函數(shù)定義看不出來)。
- 大型代碼塊。多行代碼但用于完成單一任務(wù)的，應(yīng)該在前面給出注釋，把要完成的任務(wù)寫清楚。
- 復(fù)雜的算法。如果使用了不同尋常的手法解決了問題，要通過注釋解釋明白。這樣不僅可以幫到別人，也可以讓自己今后再看的時候更快想起來。
- 使用黑科技。由于瀏覽器之間的差異，JavaScript代碼中通常都會包含一些黑科技。不要假設(shè)其他人一看就能明白某個黑科技是為了解決某個瀏覽器的什么問題。如果對某個瀏覽器不能使用正常方式達(dá)到目的，那要在注釋里把黑科技的用途寫出來。這樣可以避免別人誤以為黑科技沒有用而把它“修復(fù)”掉，結(jié)果你已經(jīng)修好的問題又會復(fù)現(xiàn)。
縮進(jìn)和注釋可以讓代碼更容易理解，將來也更容易維護(hù)。
2.2 變量和函數(shù)命名
變量和函數(shù)的適當(dāng)命名對于可讀性和可維護(hù)性也是至關(guān)重要的。由于很多JavaScript開發(fā)者都是“草莽”出身，所以很容易用foo、bar命名變量，用doSomething來命名函數(shù)。專業(yè)JavaScript開發(fā)者必須改掉這些積習(xí)，這樣才能寫出可維護(hù)的代碼。以下是關(guān)于命名的通用規(guī)則。
- 變量名應(yīng)該是名詞，例如car或person。
- 函數(shù)名應(yīng)該以動詞開始，例如getName()。返回布爾值的函數(shù)通常以is開頭，比如isEnabled()。
- 對變量和函數(shù)都使用符合邏輯的名字，不用擔(dān)心長度。長名字的問題可以通過后處理和壓縮解決。
- 變量、函數(shù)和方法應(yīng)該以小寫字母開頭，使用駝峰大小寫形式，如getName()和isPerson。類名應(yīng)該首字母大寫，比如Person、RequestFactory。常量值應(yīng)該全部大寫并以下劃線相接，比如REQUEST_TIMEOUT。
- 名字要盡量用描述性和直觀的詞匯，但不要過于冗長。getName()一看就知道會返回名字，而PersonFactory一看就知道會產(chǎn)生某個Person對象或?qū)嵗?/li>
要完全避免沒有用的變量名，比如不能表示所包含數(shù)據(jù)的類型。通過適當(dāng)命名，代碼讀起來就會像故事，因此更容易理解。
2.3 變量類型透明化
因為JavaScript是松散類型的語言，所以很容易忘記變量包含的數(shù)據(jù)類型。適當(dāng)命名可以在某種程度上解決這個問題，但還不夠。有三種方式可以表明變量的數(shù)據(jù)類型。
第一種方式是通過初始化。定義變量時，應(yīng)該立即將其初始化為一個將來要使用類型的值。例如，要保存布爾值的變量可以將其初始化為true或false，而要保存數(shù)值的變量可以將其初始化為一個數(shù)值。再看幾個例子：
- // 通過初始化表明變量類型
- let found = false; // Boolean
- let count = -1; // number
- let name = ""; // string
- let person = null; // object
初始化為特定數(shù)據(jù)類型的值可以明確表示變量的類型。在ES6之前，初始化方式不適合函數(shù)聲明中函數(shù)的參數(shù)。ES6之后，可以在函數(shù)聲明中為參數(shù)指定默認(rèn)值來表明參數(shù)類型。
第二種表示變量類型的方式是使用匈牙利表示法。匈牙利表示法指的是在變量名前面前綴一個或多個字符表示數(shù)據(jù)類型。這種表示法曾經(jīng)在腳本語言中非常流行，很長時間以來也是JavaScript首選的格式。對于基本數(shù)據(jù)類型，用o表示對象(object)、s表示字符串(string)，i表示整數(shù)(integer)，f表示浮點數(shù)(float)、b表示布爾值(boolean)。下面看幾個例子。
- // 使用匈牙利表示法標(biāo)明數(shù)據(jù)類型
- let bFound; // Boolean
- let iCount; // integer
- let sName; // string
- let oPerson; // object
匈牙利表示法也可以應(yīng)用給函數(shù)參數(shù)。匈牙利表示法的缺點是讓代碼可讀性有所下降，不夠直觀，破壞了類似句子的自然閱讀流暢性。為此，匈牙利表示法已經(jīng)被很多開發(fā)者拋棄。
最后一種表明數(shù)據(jù)類型的方式是使用類型注釋。類型注釋放在變量名后面，初始化表達(dá)式的前面?；舅悸肥窃谧兞颗赃吺褂米⑨屨f明類型，比如：
- // 使用類型注釋標(biāo)明數(shù)據(jù)類型
- let found /*:Boolean*/ = false;
- let count /*:int*/ = 10;
- let name /*:String*/ = "Nicholas";
- let person /*:Object*/ = null;
類型注釋在保持整體可讀性的同時向代碼中注入了類型信息。類型注釋的缺點是不能再使用多行注釋把大型代碼塊注釋掉了。因為類型注釋也是多行注釋，因此會造成干擾，如下面的例子所示：
- // 這樣多行注釋不會生效
- /*
- let found /*:Boolean*/ = false;
- let count /*:int*/ = 10;
- let name /*:String*/ = "Nicholas";
- let person /*:Object*/ = null;
- */
這里本來是想使用多行注釋把所有變量聲明都注釋掉。但類型注釋產(chǎn)生了干擾，因為第一個/*(第2行)會與第一個*/(第3行)匹配，結(jié)果會導(dǎo)致語法錯誤。如果想注釋掉包含類型注釋的代碼，只能使用單行注釋一行一行地注釋掉每一行(有的編輯器可以自動完成)。
以上是三種標(biāo)明變量數(shù)據(jù)類型的最常用方式。每種方式都有優(yōu)點和缺點，可以根據(jù)自己的情況選用。關(guān)鍵要看哪一種最適合自己的項目，并保證一致性。
3. 松散耦合
只要應(yīng)用的某個部分對另一個部分依賴得過于緊密，代碼就會變成強(qiáng)耦合，因而難以維護(hù)。典型的問題是在一個對象中直接引用另一個對象。這樣，修改其中一個，可能必須還得修改另一個。緊密耦合的軟件難于維護(hù)，肯定需要頻繁地重寫。
考慮到相關(guān)的技術(shù)，Web應(yīng)用在某些情況下可能變得過于強(qiáng)耦合。關(guān)鍵在于有這個意識，隨時注意不要讓代碼產(chǎn)生強(qiáng)耦合。
3.1 解耦HTML/JavaScript
Web開發(fā)中最常見的耦合是HTML/JavaScript耦合。在網(wǎng)頁中，HTML和JavaScript分別代表不同層面的解決方案。HTML是數(shù)據(jù)，JavaScript是行為。因為它們之間要交互操作，需要通過不同的方式將這兩種技術(shù)聯(lián)系起來?？上У氖?，其中一些方式會導(dǎo)致HTML與JavaScript強(qiáng)耦合。
把JavaScript直接嵌入在HTML中，包括使用<script>元素包含嵌入代碼或使用HTML屬性添加事件處理程序，都會造成強(qiáng)耦合。比如下面的例子：
- <!-- 使用<script>造成HTML/JavaScript強(qiáng)耦合 -->
- <script>
- document.write("Hello world!");
- </script>
- <!-- 使用事件處理程序?qū)傩栽斐蒆TML/JavaScript強(qiáng)耦合 -->
- <input type="button" value="Click Me" onclick="doSomething()"/>
雖然技術(shù)上這樣做沒有問題，但實踐中這樣會導(dǎo)致HTML的數(shù)據(jù)與JavaScript的行為緊密耦合在一起。理想情況下，HTML和JavaScript應(yīng)該完全分開，通過外部文件引入JavaScript，然后使用DOM添加行為。
HTML與JavaScript強(qiáng)耦合的情況下，每次分析JavaScript的報錯都要首先確定錯誤來自HTML還是JavaScript。而且，這樣也會引入代碼可用性的新錯誤。在這個例子中，用戶可能會在doSomething()函數(shù)可用之前點擊按鈕，從而導(dǎo)致JavaScript報錯。由于每次修改按鈕的行為都需要既改HTML又改JavaScript，而實際上只有后者才是有必要修改的。這樣就會降低代碼的可維護(hù)性。
在相反的情況下，HTML和JavaScript也會變得強(qiáng)耦合：把HTML包含在JavaScript中。這種情況通常發(fā)生在把一段HTML通過innerHTML插入到頁面中，比如：
- // HTML緊耦合到了JavaScript
- function insertMessage(msg) {
- let container = document.getElementById("container");
- container.innerHTML = `<div class="msg">
- <p> class="post">${msg}</p>
- <p><em>Latest message above.</em></p>
- </div>`;
- }
一般來說，應(yīng)該避免在JavaScript中創(chuàng)建大量HTML。同樣，這主要是為了做到數(shù)據(jù)層和行為層各司其職，在出錯時更容易定位問題所在。如果使用上面的代碼示例，那么如果動態(tài)插入的HTML格式不對，就會造成頁面布局出錯。但在這種情況下定位錯誤就更困難了。因為這時候通常首先會去找頁面中出錯的HTML源代碼，但又找不到，因為它是動態(tài)生成的。而且修改數(shù)據(jù)或頁面，還需要修改JavaScript，這說明兩層是緊密耦合的。
HTML渲染應(yīng)該盡可能與JavaScript分開。在使用JavaScript插入數(shù)據(jù)時，應(yīng)該盡可能不要插入標(biāo)記。相應(yīng)的標(biāo)記可以包含并隱藏在頁面中，在需要的時候JavaScript可以直接用它來顯示，而不需要動態(tài)生成。另一個辦法是通過Ajax請求獲取要顯示的HTML，這樣也可以保證同一個渲染層(PHP、JSP、Ruby等)負(fù)責(zé)輸出標(biāo)記，而不是把標(biāo)記嵌在JavaScript中。
解耦HTML和JavaScript可以節(jié)省排錯時間，因為更容易定位錯誤來源。同樣解耦也有助于保證可維護(hù)性，對行為的修改只涉及JavaScript，而對標(biāo)記的修改則只涉及要渲染的文件。
3.2 解耦CSS/JavaScript
Web應(yīng)用的另一層是CSS，主要負(fù)責(zé)頁面的外觀。JavaScript和CSS是緊密相關(guān)的，它們都是建構(gòu)在HTML之上的，因此也經(jīng)常一起使用。與HTML和JavaScript的情況類似，CSS也可能與JavaScript產(chǎn)生強(qiáng)耦合。最常見的例子就是使用JavaScript修改個別樣式，比如：
- // CSS緊耦合到了JavaScript
- element.style.color = "red";
- element.style.backgroundColor = "blue";
因為CSS負(fù)責(zé)頁面外觀，任何樣式的問題都應(yīng)該通過CSS文件解決?？墒牵绻鸍avaScript直接修改個別樣式(比如顏色)，就會增加一個排錯時要考慮甚至要修改的因素。結(jié)果是JavaScript某種程度上承擔(dān)了頁面顯示的任務(wù)，與CSS搞成了緊密耦合。如果將來有一天要修改樣式，那么CSS和JavaScript都需要修改。這對負(fù)責(zé)維護(hù)的開發(fā)者來說是一個惡夢。層與層的清晰解耦是必需的。
現(xiàn)代Web應(yīng)用經(jīng)常使用JavaScript改變樣式，因此雖然不太可能完全解耦CSS和JavaScript，但可以讓這種耦合變成更松散。這主要可以通過動態(tài)修改類名而不是樣式來實現(xiàn)，比如：
- // CSS與JavaScript松散耦合
- element.className = "edit";
通過修改元素的CSS類名，可以把大部分樣式限制在CSS文件里。JavaScript只負(fù)責(zé)修改應(yīng)用樣式的類名，而不直接影響元素的樣式。只要應(yīng)用的類名沒錯，那么外觀的問題就只跟CSS有關(guān)，而跟JavaScript無關(guān)。
同樣，保證層與層之間的適當(dāng)分離是至關(guān)重要的。顯示出問題就只應(yīng)該去CSS里解決，行為出問題就只應(yīng)該找JavaScript的問題。這些層之間的松散耦合可以提升整個應(yīng)用的可維護(hù)性。
3.3 解耦應(yīng)用邏輯/事件處理程序
每個Web應(yīng)用中都會有大量事件處理程序在監(jiān)聽各種事件?？墒?，其中很少有真正做到應(yīng)用邏輯與事件處理程序分離的。來看下面的例子：
- function handleKeyPress(event) {
- if (event.keyCode == 13) {
- let target = event.target;
- let value = 5 * parseInt(target.value);
- if (value > 10) {
- document.getElementById("error-msg").style.display = "block";
- }
- }
- }
這個事件處理程序除了處理事件，還包含了應(yīng)用邏輯。這樣做的問題是雙重的。首先，除了事件沒有辦法觸發(fā)應(yīng)用邏輯，結(jié)果造成調(diào)試?yán)щy。如果沒有發(fā)生預(yù)期的結(jié)果怎么辦?是因為沒有調(diào)用事件處理程序，還是因為應(yīng)用邏輯有錯誤?其次，如果后續(xù)事件也會對應(yīng)相同的應(yīng)用邏輯，就會導(dǎo)致代碼重復(fù)，否則就要把它提取到一個函數(shù)中。無論如何，都會導(dǎo)致原本不必要的多余工作。
更好的做法是將應(yīng)用邏輯與事件處理程序分開，各自只負(fù)責(zé)處理各自的事情。事件處理程序應(yīng)該專注于event對象的相關(guān)信息，然后把這些信息傳給處理應(yīng)用邏輯的某些方法。例如，前面的例子可以重寫成這樣：
- function validateValue(value) {
- value = 5 * parseInt(value);
- if (value > 10) {
- document.getElementById("error-msg").style.display = "block";
- }
- }
- function handleKeyPress(event) {
- if (event.keyCode == 13) {
- let target = event.target;
- validateValue(target.value);
- }
- }
這樣修改之后，應(yīng)用邏輯跟事件處理程序就分開了。handleKeyPress()函數(shù)只負(fù)責(zé)檢查用戶是不是按下了回車鍵(event.keyCode等于13)，如果是則取得事件目標(biāo)，并把目標(biāo)的值傳給validateValue()函數(shù)，由該函數(shù)處理應(yīng)用邏輯。注意，validateValue()函數(shù)中不包含任何依賴事件處理程序的代碼。這個函數(shù)只負(fù)責(zé)接收一個值，然后可以對這個值做任何處理。
把應(yīng)用邏輯從事件處理程序中分離出來有很多好處。首先，可以方便地修改觸發(fā)某個流程的事件。如果原來是通過鼠標(biāo)單擊觸發(fā)流程，而現(xiàn)在又想增加鍵盤操作來觸發(fā)，那么修改起來也很簡單。其次，可以在不用添加事件的情況下測試代碼，這樣創(chuàng)建單元測試甚至與應(yīng)用自動化整合都會更簡單。
以下是在解耦應(yīng)用和業(yè)務(wù)邏輯時應(yīng)該注意的幾點。
- 不要把event對象傳給其他方法，而是只傳遞event對象中必要的數(shù)據(jù)。
- 應(yīng)用中每個可能的操作都應(yīng)該無需事件處理程序就可以執(zhí)行。
- 事件處理程序應(yīng)該處理事件，而把后續(xù)處理交給應(yīng)用邏輯。
做到上述幾點能夠給任何代碼的可維護(hù)性帶來巨大的提升，同時也能為將來的測試和開發(fā)提供很多可能性。
4. 編碼慣例
編寫可維護(hù)的JavaScript不僅僅涉及代碼格式和規(guī)范，也涉及代碼做什么。大企業(yè)開發(fā)Web應(yīng)用通常需要很多人協(xié)同工作。這時候就需要保證每個人的瀏覽器環(huán)境都有恒定不變的規(guī)則。為此，開發(fā)者應(yīng)該遵守某些編碼慣例。
4.1 尊重對象所有權(quán)
JavaScript的動態(tài)天性意味著幾乎可以在任何時候修改任何東西。過去有人說，JavaScript中沒有什么是神圣不可侵犯的，因為不能把任何東西標(biāo)記為最終結(jié)果或者恒定不變。但ECMAScript 5引入防篡改對象之后，情況不同了。當(dāng)然，對象默認(rèn)還是可以修改的。在其他語言中，在沒有源代碼的情況下對象和類都是不可修改的。JavaScript則允許在任何時候修改任何對象，因此就可能導(dǎo)致意外地覆蓋默認(rèn)行為。既然這門語言沒有什么限制，那就需要開發(fā)者自己限制自己。
在企業(yè)開發(fā)中，可能最最重的編碼慣例就是尊重對象所有權(quán)，這意味著不要修改不屬于你的對象。簡單地講，如果你不負(fù)責(zé)創(chuàng)建和維護(hù)某個對象，包括它的構(gòu)造函數(shù)或它的方法，就不應(yīng)該對它進(jìn)行任何修改。更具體一點說，就是：
- 不要給實例或原型添加屬性
- 不要給實例或原型添加方法
- 不要重定義已有的方法
問題在于，開發(fā)者會假設(shè)瀏覽器環(huán)境以某種方式運行。修改了多個人使用的對象也就意味著會有錯誤發(fā)生。如果有人希望某個函數(shù)叫stopEvent()，用于取消某個事件的默認(rèn)行為。然后，你把它給改了，除了取消事件的默認(rèn)行為，又添加了其他事件處理程序。可想而知，問題肯定會接踵而至。別人還會認(rèn)為這個函數(shù)只做最開始的那點事，由于對它后來添加的副作用并不知情，很可能會用錯或者造成損失。
以上規(guī)則不僅適用于自定義類型和對象，同樣適用于原生類型和對象，比如Object、String、document、window，等等?？紤]到瀏覽器廠商也有可能會在不宣布的情況下以非預(yù)期方式修改這些對象，那么潛在的風(fēng)險就更大了。
以前有一個流行的Prototype庫就發(fā)生過類似事件。當(dāng)時，這個庫在document對象上實現(xiàn)了getElementsByClassName()方法，返回一個Array的實例，而這個實例上還增加了each()方法。jQuery的作者John Resig后來在自己的博客上分析了這個問題造成的影響。他在博客中(https://johnresig.com/blog/getelementsbyclassname-pre-prototype-16/)指出這個問題是由于瀏覽器也原生實現(xiàn)了相同的getElementsByClassName()方法造成的。但Prototype的同名方法返回的是Array而非NodeList，后者沒有each()方法。使用這個庫的開發(fā)者之前會寫這樣的代碼：
- document.getElementsByClassName("selected").each(Element.hide);
盡管這樣寫在沒有原生實現(xiàn)getElementsByClassName()方法的瀏覽器里沒有問題，但在實現(xiàn)它的瀏覽器里就會出問題。因為兩個同名方法返回的結(jié)果不一樣。我們不能預(yù)見瀏覽器廠商將來會怎么修改原生對象，因此不管怎么修改它們都可能在將來某個時刻出現(xiàn)沖突時導(dǎo)致問題。
為此，最好的方法是永遠(yuǎn)不要修改不屬于你的對象。只有你自己創(chuàng)建的才是你的對象，包括自定義類型和對象字面量。Array、document等這些都不是你的，因為在你的代碼執(zhí)行之前它們已經(jīng)存在了?？梢赃@樣為對象添加新功能：
- 創(chuàng)建包含想要功能的新對象，通過它與別人的對象交互。
- 創(chuàng)建新自定義類型繼承本來想要修改的類型，給自定義類型添加新功能。
很多JavaScript庫目前都贊同這個開發(fā)理念，這樣無論瀏覽器怎樣改變都可以發(fā)展和適應(yīng)。
4.2 不聲明全局變量
與尊重對象所有權(quán)密切相關(guān)的是盡可能不聲明全局變量和函數(shù)。同樣，這也關(guān)系到創(chuàng)建一致和可維護(hù)的腳本運行環(huán)境。最多可以創(chuàng)建一個全局變量，作為其他對象和函數(shù)的命名空間。來看下面的例子：
- // 兩個全局變量——不要！
- var name = "Nicholas";
- function sayName() {
- console.log(name);
- }
以上代碼聲明了兩個全局變量：name和sayName()。可以像下面這樣把它們包含在一個對象中：
- // 一個全局變量——推薦
- var MyApplication = {
- name: "Nicholas",
- sayName: function() {
- console.log(this.name);
- }
- };
這個重寫后的版本只聲明了一個全局對象MyApplication。在這個對象內(nèi)部，又包含name和sayName()。這樣可以避免之前版本的幾個問題。首先，變量name會覆蓋window.name屬性，而這可能會影響其他功能。其次，有助于分清功能都集中在哪里。調(diào)用MyApplication.sayName()從邏輯上就會暗示出現(xiàn)任何問題，都可以在MyApplication的代碼中找原因。
這樣一個全局對象可以擴(kuò)展為命名空間的概念。命名空間涉及創(chuàng)建一個對象，然后通過這個對象來暴露能力。比如，Google Closure庫就利用了這樣的命名空間來組織其代碼。下面是幾個例子：
- goog.string：用于操作字符串的方法。
- goog.html.utils：與HTML相關(guān)的方法。
- goog.i18n：與國際化(i18n)相關(guān)的方法。
對象goog就相當(dāng)于一個容器，其他對象都包含在這里面。只要使用對象以這種方式來組織功能，就可以稱該對象為命名空間。整個Google Closure庫都構(gòu)建在這個概念之上，能夠在同一個頁面上與其他JavaScript庫共存。
關(guān)于命名空間，最重要的是確定一個所有人都同意的全局對象名稱。這個名稱要足夠獨特，不可能與其他人的沖突。多數(shù)情況下，可以使用開發(fā)者所在的公司名，例如goog或Wrox。下面的例子演示了使用Wrox作為命名空間來組織功能：
- // 創(chuàng)建全局對象
- var Wrox = {};
- // 為本書（Professional JavaScript）創(chuàng)建命名空間
- Wrox.ProJS = {};
- // 添加本書用到的其他對象
- Wrox.ProJS.EventUtil = { ... };
- Wrox.ProJS.CookieUtil = { ... };
在這個例子中，Wrox是全局變量，然后在它的下面又創(chuàng)建了命名空間。如果本書所有代碼都保存在Wrox.ProJS命名空間中，那么其他作者的代碼就可以使用自己的對象來保存。只要每個人都遵循這個模式，就不必?fù)?dān)心有人會覆蓋這里的EventUtil或CookieUtil，因為即使重名它們也只會出現(xiàn)在不同的命名空間中。比如下面的例子：
- // 為另一本書（Professional Ajax）創(chuàng)建命名空間
- Wrox.ProAjax = {};
- // 添加其他對象
- Wrox.ProAjax.EventUtil = { ... };
- Wrox.ProAjax.CookieUtil = { ... };
- // 可以照常使用ProJS下面的對象
- Wrox.ProJS.EventUtil.addHandler( ... );
- // 以及ProAjax下面的對象
- Wrox.ProAjax.EventUtil.addHandler( ... );
雖然命名空間需要多寫一點代碼，但從可維護(hù)性角度看，這個代價還是非常值得的。命名空間可以確保代碼與頁面上的其他代碼互不干擾。
4.3 不要比較null
JavaScript不會自動做任何類型檢查，因此就需要開發(fā)者擔(dān)起這個責(zé)任。結(jié)果，很多JavaScript代碼都不會做類型檢查。最常見的類型檢查是看一個值是不是null。然而，與null進(jìn)行比較的代碼太多了，其中很多都因為類型檢查不夠而頻繁引發(fā)錯誤。比如下面的例子：
- function sortArray(values) {
- if (values != null) { // 不要這樣比較！
- values.sort(comparator);
- }
- }
這個函數(shù)的目的是使用給定的比較函數(shù)對數(shù)組進(jìn)行排序。為保證函數(shù)正常執(zhí)行，values參數(shù)必須是數(shù)組。但是，if語句在這里只簡單地檢查了這個值不是null。實際上，字符串、數(shù)值還有其他很多值都可以通過這里的檢查，結(jié)果就會導(dǎo)致錯誤。
現(xiàn)實當(dāng)中，單純比較null通常是不夠的。檢查值的類型就要真的檢查類型，而不是檢查它不能是什么。例如，在前面的代碼中，values參數(shù)應(yīng)該是數(shù)組。為此，應(yīng)該檢查它到底是不是數(shù)組，而不是檢查它不是null?？梢韵裣旅孢@樣重寫那個函數(shù)：
- function sortArray(values) {
- if (values instanceof Array) { // 推薦
- values.sort(comparator);
- }
- }
這個函數(shù)的這個版本可以過濾所有無效的值，根本不需要使用null。
- 如果看到比較null的代碼，可以使用下列某種技術(shù)替換它。
- 如果值應(yīng)該是引用類型，使用instanceof操作符檢查其構(gòu)造函數(shù)。
- 如果值應(yīng)該是原始類型，使用typeof檢查其類型。
- 如果希望值是有特定方法名的對象，使用typeof操作符確保對象上存在給定名字的對象。
代碼中比較null的地方越少，就越容易明確類型檢查的目的，從而消除不必要的錯誤。
4.4 使用常量
依賴常量的目標(biāo)是從應(yīng)用邏輯中分離數(shù)據(jù)，以便修改數(shù)據(jù)時不會引發(fā)錯誤。顯示在用戶界面上的字符串就應(yīng)該以這種方式提取出來，可以方便實現(xiàn)國際化。URL也應(yīng)該這樣提取出來，因為隨著應(yīng)用越來越復(fù)雜，URL也極有可能變化。基本上，像這種地方因為這種或那種原因?qū)硇枰薷臅r，可能就要找到某個函數(shù)，然后修改其中的代碼。而每次像這樣修改應(yīng)用邏輯，都可能引入新錯誤。為此，可以把這些可能會修改的數(shù)據(jù)提取出來，放在單獨定義的常量中，以實現(xiàn)數(shù)據(jù)與邏輯分離。
關(guān)鍵在于把數(shù)據(jù)從使用它們的邏輯中分離出來?？梢允褂靡韵聵?biāo)準(zhǔn)檢查哪些數(shù)據(jù)需要提取。
- 重復(fù)出現(xiàn)的值。任何使用超過一次的值都應(yīng)該提取到常量中。這樣可以消除一個值改了而另一個值沒改造成的錯誤。這里也包括CSS的類名。
- 用戶界面字符串。任何會顯示給用戶的字符串都應(yīng)該提取出來，以方便實現(xiàn)國際化。
- URL：Web應(yīng)用中資源的地址經(jīng)常會發(fā)生變化，因此建議把所有URL集中放在一個地方管理。
- 任何可能變化的值。任何時候，只要在代碼中使用字面值，就問問自己這個值將來有沒有可能會變。如果答案是有可能，那么就應(yīng)該把它提取到常量中。
使用常量是企業(yè)級JavaScript的重要技術(shù)，因為它可以讓代碼更容易維護(hù)，同時可以讓代碼免受數(shù)據(jù)變化的影響。
