寫代碼每個人都有自己的風格,但參考業界總結的經驗總是有益的。以下 14 條來自 Javascript Toolbox,涵蓋變量聲明、特性檢測、事件處理、Ajax、命名空間等方面。
JavaScript 的變量要麼是全局的,要麼是函數級的。漏寫 var 會讓變量洩漏成全局:
var i = 0; // 全局變量
function test() {
for (i = 0; i < 10; i++) { // 少了 var!
alert("Hello World!");
}
}
test();
alert(i); // 全局變量 i 被改成了 10
循環裡的 i 因為沒有 var,實際引用的是全局變量。兩種正確寫法:
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!");
}
}
(在 ES6 之後,塊級作用域的 let / const 是更好的選擇,能從根本上避免這類問題。)
判斷用戶用的是哪個瀏覽器版本、再決定走哪條分支,是非常糟糕的實踐——UA 可以僞造,新版本也會讓判斷失效。更好的做法是在使用前檢查該特性是否存在:
if (document.getElementById) {
var element = document.getElementById('MyId');
} else {
alert('Your browser lacks the capabilities required to run this script!');
}
對象屬性有兩種訪問方式:
MyObject.property // 點記法
MyObject["property"] // 方括號記法
點記法中的屬性名是硬編碼的,運行時無法改變;方括號中放的是一個表達式求值後的字符串,可以是變量甚至函數返回值。當屬性名在執行時才確定時,方括號是唯一選擇:
MyObject["value" + i] // 可以
MyObject.value + i // 不行
另外,某些服務端環境(PHP、Struts 等)會給表單字段名附加 [] 表示數組,這時也必須用方括號:
formref.elements["name[]"] // 可以
formref.elements.name[] // 不行
一個實用的約定是:訪問規範定義的標準屬性用點記法,訪問頁面自定義的屬性用方括號。這樣一眼就能分辨哪些是標準、哪些是約定:
document.forms["myformname"].elements["myinput"].value
這裡 forms、elements、value 都是規範定義的,而 myformname 與 myinput 由頁面自己決定。
eval() 在運行時執行任意字符串代碼。幾乎所有情況下它都不該出現——如果它出現在你的頁面裡,通常說明還有更好的做法。很多 eval 的使用,其實只是因為作者不知道方括號記法。
原則上,eval is evil。除非你是經驗豐富的開發者且確定當前場景是例外,否則不要用它。
所有 HTML 表單都應該有 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";
在事件處理中,更好的做法是把元素自身傳進去,再利用它的 form 屬性反查所屬表單,這樣函數裡就不必硬編碼表單名,可重複性大大提升:
<input type="text" name="address" onChange="validate(this)">
<script>
function validate(input_obj) {
// 引用包含這個元素的 form
var theform = input_obj.form;
// 不必硬編碼表單名即可訪問其他字段
if (theform.elements["city"].value == "") {
alert("Error");
}
}
</script>
with 會把一個對象插入作用域鏈前端,看起來能少寫不少字:
with (document.forms["mainForm"].elements) {
input1.value = "junk";
input2.value = "junk";
}
問題是,程序員無法確認 input1、input2 究竟被解析成了表單元素,還是一路向上找到了全局對象,最後拋出錯誤。這種不確定性會讓調試變得非常痛苦。
替代方案是創建一個引用變數:
var elements = document.forms["mainForm"].elements;
elements.input1.value = "junk";
elements.input2.value = "junk";
(with 已在嚴格模式下被禁用。)
在 <a> 中觸發腳本,應該用 onclick 而不是 javascript: 僞協議。使用 onclick 時,處理函數必須返回 true 或 false:返回 true 則瀏覽器繼續訪問 href,返回 false 則忽略 href。這也是 return false; 常出現在 onclick 末尾的原因。
<a href="javascript_required.html" onclick="return doSomething()">go</a>
這樣的寫法有兩重好處:啟用了 JS 時函數被調用、href 不會跳轉;未啟用 JS 時,javascript_required.html 仍然可以正常加載,用戶能看到友好提示。相比之下,寫成 href="#" 就讓不支持 JS 的用戶無路可走。
需要條件判斷時也是同樣思路:
<a href="/" onclick="return validate()">Home</a>
<script>
function validate() {
return prompt("Are you sure you want to exit this page?");
}
</script>
用戶點「確定」返回 true,允許跳轉;點「取消」返回 false,鏈接不被訪問。
以下都是應該避免的寫法:
<a href="javascript:doSomething()">link</a>
<a href="#">link</a>
+ 既是加法也是字符串拼接。由於表單域的值永遠是字符串,直接相加會得到拼接結果:
<form name="myform" action="[url]">
<input type="text" name="val1" value="1">
<input type="text" name="val2" value="2">
</form>
<script>
function total() {
var theform = document.forms["myform"];
var total = theform.elements["val1"].value
+ theform.elements["val2"].value;
alert(total); // 弹出 "12",但期望是 3
}
</script>
解法是給值前置一個 +,強制轉為數字:
function total() {
var theform = document.forms["myform"];
var total = (+theform.elements["val1"].value)
+ (+theform.elements["val2"].value);
alert(total); // 3
}
(更可讀的替代是 Number(x) 或 parseFloat(x)。)
document.all 是 IE 引入的非標準特性。雖然多數新瀏覽器為了兼容糟糕的老代碼而支持它,仍有瀏覽器並不支持。除非你確實要支持 IE 5.0,否則沒有理由用它。判斷是否為 IE 也不需要用它,現在一般瀏覽器都支持標準方法。
if (document.getElementById) {
var obj = document.getElementById("myId");
} else if (document.all) {
var obj = document.all("myId");
}
若實在要用,原則是:先嘗試其他方法 → 作為最後選擇 → 僅為兼容 5.0 以下 IE → 總是用 if (document.all) 判斷支持。
在 1995 年左右,Netscape 1.0 之類的瀏覽器不認得 <script> 標籤,於是用 HTML 注釋把代碼藏起來,避免被當文本顯示:
<script language="javascript">
!--
// code here
//-->
</script>
今天已經沒有任何常用瀏覽器會忽略 script 標籤,這層僞裝毫無必要,反而有害:在 XHTML 文檔中它會讓源代碼對所有瀏覽器隱藏並渲染成無用內容;而 -- 在 HTML 注釋中並不合法,會讓相關解析出問題。
全局變量和函數越少越好。全局污染會導致多個腳本文件互相衝突、代碼中斷。好的做法是封裝到一個全局命名空間對象裡:
var MyLib = {}; // 全局對象容器
MyLib.value = 1;
MyLib.increment = function () {
MyLib.value++;
};
MyLib.show = function () {
alert(MyLib.value);
};
MyLib.value = 6;
MyLib.increment();
MyLib.show(); // 7
命名空間也可以用閉包創建,並在其中僞造私有成員變量。今天的項目更推薦直接使用 ES Module,讓依賴關係由工具鏈靜態管理。
Ajax 有異步與同步兩種模式。異步模式下請求在後台執行,瀏覽器可以繼續響應;同步模式則會一直等待請求返回。
應該避免同步請求:它會在等待期間凍結整個頁面,一旦服務端繁忙,用戶的瀏覽器(甚至整個系統)在超時之前什麼都做不了。如果你覺得自己的場景必須用同步,最大的可能是設計需要重新思考——真正需要同步 Ajax 的場景極少。
需要把數據結構存成純文本,或通過 Ajax 收發數據時,優先選 JSON 而非 XML。JSON(JavaScript Object Notation)更簡潔高效,且不依賴任何特定語言。
不要寫 language 屬性,它早已過時。正確的寫法是:
<script type="text/javascript">
// code here
</script>
(在 HTML5 中 type 也可以省略,默認就是 JavaScript。)
這 14 條中有幾條是時代的產物(document.all、HTML 注釋、同步 Ajax),了解它們能幫你读懂老代碼;而 var 聲明、特性檢測、避免 eval 與 with、命名空間、事件處理的正確引用方式這些原則,放到今天依然是判斷代碼質量的重要標準。