JavaScript 是個寬容的語言,寬容到你不小心就會寫出能跑但很糟的程式。以下整理 14 條值得養成习惯的撰寫準則,多數都是「現在不做,三個月後會後悔」的那一類。
JavaScript 的變數作用域只有兩種:全域與函式層級。漏寫 var,變數就會變成全域,這是無數 bug 的源頭。
var i = 0; // 這是全域變數
function test() {
for (i = 0; i < 10; i++) { // 漏了 var,實際上在改全域的 i
alert("Hello World!");
}
}
test();
alert(i); // 10!全域變數被汙染了
正確做法有兩種,功能等價:
function test() {
var i = 0;
for (i = 0; i < 10; i++) { alert("Hello World!"); }
}
function test() {
for (var i = 0; i < 10; i++) { alert("Hello World!"); }
}
判斷使用者用的是哪個瀏覽器版本、再據此走不同分支,是公認的不良實踐。使用者可以偽造 user agent,新版本也可能改變行為。正確思路是:先問「這個能力存在嗎」,存在就用。
if (document.getElementById) {
var element = document.getElementById('MyId');
} else {
alert('您的瀏覽器缺少執行此腳本所需的功能!');
}
屬性存取有兩種寫法:點記法 MyObject.property 與中括號 MyObject["property"]。點記法的屬性名是寫死的,中括號裡則可以是任何運算式。
MyObject["value" + i] // 可以 MyObject.value + i // 錯,這是字串串接
有些後端框架(PHP、Struts)會把表單欄位名加上 [] 以表示陣列,這時中括號是唯一選擇:
formref.elements["name[]"] // 可以 formref.elements.name[] // 語法錯誤
實務上的建議慣例是:存取 DOM 規範定義的標準屬性用點記法,存取頁面自訂的屬性用中括號。混用反而能讓人一眼看出哪些是標準、哪些是約定:
document.forms["myformname"].elements["myinput"].value
eval() 會把字串當程式碼執行,幾乎所有情況都有更好的替代方案。程式碼裡出現 eval,通常意味著作者不知道中括號記法或 JSON.parse 的存在。一句老話說得好:Eval is evil。
每個 form 都應該有 name 屬性;在 XHTML 文件中 name 不被允許,則改用 id 並以 document.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.form 反查所屬表單,這樣函式就不必寫死表單名稱,重用性更高:
<input type="text" name="address" onChange="validate(this)">
function validate(input_obj) {
var theform = input_obj.form;
if (theform.elements["city"].value == "") {
alert("Error");
}
}
with 會把一個物件插入作用域鏈的前端,讓後續的屬性引用優先往它找。聽起來很方便:
with (document.forms["mainForm"].elements) {
input1.value = "junk";
input2.value = "junk";
}
問題是這段程式難以靜態分析——你無法確定 input1 究竟被解析成表單元素還是別的東西,效能也更差。改用一個區域變數存引用即可:
var elements = document.forms["mainForm"].elements; elements.input1.value = "junk"; elements.input2.value = "junk";
要在 <a> 上觸發 JavaScript,請用 onclick,而不是 href="javascript:..."。onclick 中的程式碼若回傳 false,瀏覽器就不會跳轉,這也是為什麼常看到結尾寫 return false;。
<a href="https://example.com" onclick="doSomething(); return false;">go</a>
這樣寫的好處是:不支援或停用 JavaScript 的瀏覽器仍能正常前往 href 指向的頁面,屬於漸進增強。
若需要依條件決定是否跳轉:
<a href="/" onClick="return validate();">Home</a>
function validate() {
return prompt("確定要離開此頁面嗎?");
}
以下都是不建議的寫法:
<a href="javascript:doSomething()">link</a> <a href="#" onClick="doSomething()">link</a> <a href="#" onClick="javascript:doSomething();">link</a>
+ 在 JavaScript 中同時是加法與串接運算子。表單欄位的值一律是字串,直接相加會變成串接:
function total() {
var theform = document.forms["myform"];
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
document.all 是 IE 的非標準擴充,雖然多數瀏覽器為了相容而支援,但並非所有環境都有。沒有理由優先使用它,最多作為最後退路:
if (document.getElementById) {
var obj = document.getElementById("myId");
} else if (document.all) {
var obj = document.all("myId");
}
1995 年 Netscape 1.0 不認得 <script> 標籤,於是人們用 HTML 註解把程式碼藏起來:
<script language="javascript"> <!-- // code here //--> </script>
今天已經沒有主流瀏覽器會忽略 <script>,這段 hack 只剩下壞處:在 XHTML 中會造成解析問題,而且 --> 的存在會讓遞減運算子 --> 的解析出現歧義。
全域變數愈少愈好,因為它們容易互相衝突。比較簡易的做法是建立一個命名空間物件:
var MyLib = {}; // 全域容器
MyLib.value = 1;
MyLib.increment = function() { MyLib.value++; };
MyLib.show = function() { alert(MyLib.value); };
MyLib.value = 6;
MyLib.increment();
MyLib.show(); // 7
進階做法則是利用閉包(closure)模擬私有成員,這在模組化設計中很常見。
Ajax 有同步與非同步兩種模式。同步模式會凍結瀏覽器直到回應返回,伺服器一慢,使用者就完全無法操作,直到逾時。若你覺得自己「需要」同步,絕大多數情況其實是設計該重新思考了。
需要傳遞結構化資料時,JSON 比 XML 更精簡、解析更快,且不綁定特定語言。它同時也是 JavaScript 的原生資料表示法,處理成本最低。
language 屬性早已廢棄,正確寫法是:
<script type="text/javascript"> // code here </script>
這 14 條準則的核心其實只有一句:寫給人看,機器只是順便能跑。養成這些習慣,程式碼的可讀性與可維護性都會明顯提升。希望對你的 JavaScript 開發有所幫助。