DIV CSS 佈局教程網

JavaScript 撰寫 Best Practice:14 條值得養成的習慣
編輯:關於JavaScript     

寫程式這件事,每個開發者都有自己的風格與堅持,但參考他人的經驗總是有益的。以下整理 14 條 JavaScript 撰寫建議,多數屬於「養成習慣就不會踩坑」的類型。

1. 永遠記得寫 var

JavaScript 的變數作用域不是全域就是函式層級。忘了寫 var,變數就會變成全域,這是 bug 的溫床:

var i = 0;
function test() {
    for (i = 0; i < 10; i++) {   // 少了 var,i 指向全域變數
        alert("Hello World!");
    }
}
test();
alert(i);   // 全域的 i 已經被改成 10

正確寫法有兩種,效果相同:

function test() {
    var i = 0;
    for (i = 0; i < 10; i++) { ... }
}

function test() {
    for (var i = 0; i < 10; i++) { ... }
}

2. 用特性偵測取代瀏覽器偵測

判斷瀏覽器版本再決定行為,是很糟的實務做法。更好的方式是先確認該特性是否存在:

if (document.getElementById) {
    var element = document.getElementById('MyId');
} else {
    alert('瀏覽器不支援執行此程式所需的功能!');
}

3. 善用中括號記法

屬性存取有兩種寫法:MyObject.property 與 MyObject["property"]。前者名稱是寫死的,後者的鍵名可以是變數、字串拼接或函式回傳值:

MyObject["value" + i]      // 可以
MyObject.value + i         // 不行

另一個必要場景是伺服器端會把表單欄位名加上 [] 表示陣列,這時只能用中括號:

formref.elements["name[]"]   // 可以
formref.elements.name[]      // 不行

實務上的經驗法則:標準 DOM 屬性用點號,頁面自訂的屬性用中括號。混用反而能讓程式碼意圖更清楚:

document.forms["myformname"].elements["myinput"].value

4. 遠離 eval

eval() 會在執行期動態執行任意字串。絕大多數情況下都不該使用它;如果你在程式碼裡看到 eval,通常代表還有更好的寫法沒被採用。一句話:Eval is evil。

5. 正確引用表單與表單元素

所有 HTML 表單都該有 name 屬性(XHTML 下則用 id 搭配 getElementById)。用 document.forms[0] 這種索引方式取表單,幾乎在所有情況下都是壞習慣。

document.forms["formname"].elements["inputname"]   // 正確
document.formname.inputname                      // 別這樣寫

若在函式裡要多次存取同一表單,先把表單物件存進變數,避免重複查詢:

var formElements = document.forms["mainForm"].elements;
formElements["input1"].value = "a";
formElements["input2"].value = "b";

事件處理時,把元素本身當參數傳進去,函式就能不寫死任何名稱而到處重用:

<input type="text" name="address" onChange="validate(this)">

function validate(input_obj) {
    var theform = input_obj.form;
    if (theform.elements["city"].value == "") {
        alert("Error");
    }
}

6. 避免使用 with

with 會在作用域前端插入一個物件,讓屬性查找先往該物件找。問題是這種查找順序難以驗證,容易在找不到時一路落到全域物件而拋出錯誤:

var elements = document.forms["mainForm"].elements;   // 用明確的引用取代 with
elements.input1.value = "junk";
elements.input2.value = "junk";

7. 連結上用 onclick 而非 javascript: 協議

<a href="javascript_required.html" onclick="doSomething(); return false;">go</a>

onclick 的函式必須回傳 true 或 false:回傳 true 時 href 照常跳轉,回傳 false 則 href 被忽略——這也是為什麼 return false; 常出現在 onclick 尾端。這樣做的好處是,當使用者停用 JavaScript 時,href 指向的頁面仍能提供替代內容。

需要在跳轉前先驗證時:

<a href="/" onclick="return validate();">Home</a>
function validate() {
    return prompt("確定要離開這個頁面嗎?");
}

以下寫法都應該避免:

<a href="javascript:doSomething()">link</a>
<a href="#" onclick="javascript:doSomething();">link</a>

8. 用一元 + 做型別轉換

JavaScript 的 + 同時是加法與字串串接。表單欄位的值是字串,直接相加會變成串接:

var total = theform.elements["val1"].value + theform.elements["val2"].value;
alert(total);   // 顯示 "12",而不是 3

在前面加上一元 +,強制轉為數字即可:

var total = (+theform.elements["val1"].value) + (+theform.elements["val2"].value);
alert(total);   // 3

9. 別依賴 document.all

document.all 是 IE 引進的非標準特性。雖然多數新瀏覽器為了相容而支援它,仍有瀏覽器不支援,沒有理由優先採用:

if (document.getElementById) {
    var obj = document.getElementById("myId");
} else if (document.all) {          // 只作為最後手段
    var obj = document.all("myId");
}

10. 別在 script 區塊裡包 HTML 註解

早期為了讓不認識 <script> 的舊瀏覽器(如 Netscape 1.0)不把程式碼當文字顯示,人們會用 HTML 註解把程式碼藏起來。今天完全沒有必要,反而在 XHTML 下會造成程式碼被當成註解而失效。

11. 節制使用全域命名空間

全域變數與函式極易造成不同檔案之間的衝突。最簡單的解法是建立一個全域物件當容器:

var MyLib = {};
MyLib.value = 1;
MyLib.increment = function(){ MyLib.value++; };
MyLib.show = function(){ alert(MyLib.value); };
MyLib.increment();
MyLib.show();   // 2

若要更嚴謹的私有成員,則可利用閉包(closure)實作。

12. 避免同步的 Ajax 呼叫

Ajax 有非同步與同步兩種模式。同步模式會讓瀏覽器停在原地等回應,伺服器一忙,使用者就只能乾等直到逾時。如果你覺得自己的情境「必須」用同步,那通常代表設計需要重新思考。

13. 優先採用 JSON

需要以純文字保存資料結構,或透過 Ajax 傳輸資料時,盡量用 JSON 取代 XML。JSON(JavaScript Object Notation)更精簡、解析更快,而且不綁定特定語言。

14. 寫對 script 標籤

<script type="text/javascript">
// code here
</script>

別再用 language 屬性,type 才是正確且標準的寫法。

這些建議沒有一條是什麼高深技巧,但累積下來對程式碼品質的影響相當可觀。挑幾條開始養成習慣,長期收益遠大於一時的方便。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved