JS編碼技巧:翻譯的14天JS編寫技巧

2024-09-06 12:41:01

字體：大中小

來源：轉載

供稿：網友

寫任何編程代碼，不同的開發者都會有不同的見解。但參考一下總是好的，下面是來自 javascript toolbox 發布的 14條最佳js代碼編寫技巧 ，sofish翻譯(1,2)。

1. 總是使用 ‘var’

在javascript中，變量不是全局范圍的就是函數范圍的，使用”var”關鍵詞將是保持變量簡潔明了的關鍵。當聲明一個或者是全局或者是函數級（function-level）的變量，需總是前置”var”關鍵詞，下面的例子將強調不這樣做潛在的問題。

不使用 var 造成的問題

var i=0; // this is good - creates a global variable
function test() {
   for (i=0; i<10; i++) {
      alert("hello world!");
   }
}
test();
alert(i); // the global variable i is now 10!

因為變量函數中變量 i 并沒有使用 var 使其成為函數級的變量，在這個例子中它引用了全局變量?？偸鞘褂?var 來聲明全局變量是一個很多的做法，但至關重要的一點是使用 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!");
   }
}

2. 特性檢測而非瀏覽器檢測

一些代碼是寫來發現瀏覽器版本并基于用戶正使用的客戶端的對其執行不同行為。這個，總的來說，是一個非常糟的實踐。更好的方法是使用特性檢測，在使用一個老瀏覽器可能不支持的高級的特性之前，首先檢測（瀏覽器的）是否有這個功能或特性，然后使用它。這單獨檢測瀏覽器版本來得更好，即使你知道它的性能。你可以在 http://www.jibbering.com/faq/faq_notes/not_browser_detect.html 找到一個深入討論這個問題的文章。

例子：

if (document.getelementbyid) {
var element = document.getelementbyid('myid');
}
else {
alert('your browser lacks the capabilities required to run this script!');
}

|||

3. 使用方括號記法

當訪問由執行時決定或者包括要不能用”.”號訪問的對象屬性，使用方括號記法。如果你不是一個經驗豐富的javascript程序員，總是使用方括號是一個不錯的做法

對象的屬性由兩種固定的方法來訪問：”.”記法和”[ ]“方括號記法：

“.”號記法

myobject.property“[ ]“

方括號記法

myobject["property"]

使用”.”號，屬性名是硬代碼，不能在執行時改變。使用”[ ]“方括號，屬性名是一個通過計算屬性名而來的字符串。字符串要以是硬代碼，也可能是變量，甚至可以是一個調回一個字母串值的函數。如果一個屬性名在執行產生，方括號是必須，如果你有 “value1′, “value2′, 和 “value3′這樣的屬性，并且想利用變量 i=2來訪問。

這個可以運行：

myobject["value"+i]

這個不可以：

myobject.value+i

并且在某些服務器端環境（php、struts等）下，form 表單被附加了 [ ] 號來表示 form 表單在服務器端必須被當作數組來對待。如此，用”.”號來引用一個包含 [ ] 號的字段將不會執行，因為 [ ] 是引用一個 javascript 數組的語法。所以，[ ] 號記法是必須的：

這個可以運行：

formref.elements["name[]"]

這個不可以：

formref.elements.name[]

推薦使用”[ ]“方括號記法是說當其需要時（明顯地）總是使用它。當不是嚴格需要使用它的時候，它是一個私人的偏好和習慣。一個好的經驗原則是，使用”.”號記法訪問標準的對象屬性，使用”[ ]“方括號記法訪問由頁面定義的對象屬性。這樣，document["getelementbyid"]() 是一個完美可行的”[ ]“方括號記法用法，但 document.getelementbyid() 在語法上是首選，因為 getelementbyid 是一個 dom 規范中定義的一個標準文檔對象屬性?；旌鲜褂眠@兩個記法使哪個是標準對象屬性，哪個屬性名是由上下文所定義的，在代碼中顯得清晰明了：

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

這里，forms 是 document 的一個標準屬性，而表單名 myformname 則是由頁面所定義的。同時，elements 和 value 屬性都是由規范所定義的標準屬性。而 myinput 則是由頁面所定義的。這頁是句法讓人非常容易理解（代碼的內容），是一個推薦遵循的習慣用法，但不是嚴格原則。

|||

4. 避免 ‘eval’

在javascript中，eval()功能是一個在執行期中執行任意代碼的方法。在幾乎所有的情況下，eval 都不應該被使用。如果它出現在你的頁面中，則表明你所做的有更好的方法。舉一個例子，eval 通常被不知道要使用方括號記法的程序員所使用。

原則上，”eval is evil（eval是魔鬼）”。別使用它，除非你是一個經驗豐富的開發者并且知道你的情況是個例外。

5. 正確地引用表單和表單元素

所有的 html 表單都應該有一個 name 屬性。對于 xhtml 文檔來說，name 屬性是不被要求的，但 form 標簽中應有相應有 id 屬性，并必須用 document.getelementbyid() 來引用。使用像 document.forms[0] 這樣的索引方法來引用表單，在幾乎所有情況下，是一個糟糕的做法。有些瀏覽器把文檔中使用 form 來命名的元素當作一個可用的 form 屬性。這樣并不可靠，不應該使用。

下面這個例子用使用方括號和正確的對象引用方法來展示如何防止錯誤地引用一個表單的input：

正確引用表單 input：

document.forms["formname"].elements["inputname"]

糟糕的做法:

document.formname.inputname

如果你要引用一個函數里的兩個表單元素，較好的做法是先引用這個form對象，并將其儲存在變量中。這樣避免了重復查詢以解決表單的引用：

var formelements = document.forms["mainform"].elements;
formelements["input1"].value="a";
formelements["input2"].value="b";

當你使用 onchange 或者其他類似的事件處理方法，一個好的做法是總是通過一個引來把 input 元素本身引用到函數中來。所有 input 元素都帶有一個對包含其在內的form表單有一個引用：

<input type="text" name="address" onchange="validate(this)">
function validate(input_obj) {
   // 引用包含這個元素的form
   var theform = input_obj.form;
   // 現在你可以不需要使用硬代碼來引用表單自身
   if (theform.elements["city"].value=="") {
      alert("error");
   }
}

通過對表單元素的引用來訪問表單的屬性，你可以寫一個不包含硬代碼的函數來引用這個頁面中任何一個有特定名的表單。這是一個非常好的做法，因為函數變得可重用。

避免 ‘with’

javascript 中的 with 聲明在一個作用域的前端插入一個對象，所以任何屬性/變量的引用將會倚著對象被首先解決。這通常被用作一個避免重復引用的快捷方法：

使用 with 的例子：

with (document.forms["mainform"].elements) {
input1.value = "junk";
input2.value = "junk";
}

但問題在于程序員并沒有方法來驗證 input1 或 input2 實際上已經被當作 form 元素數組的屬性來解決。它首先以為這些名來檢測屬性，如果找不到，它將會繼續（向下）檢測這個作用域。最后，它在全局對象中嘗試把input1 和 input2 作為一個全局對象來對待，而這以一個錯誤作為結尾。

變通的方法是：創建一個引用來減少引用的對象，并使用它來解決這些引用。

使用一個引用：

var elements = document.forms["mainform"].elements;
elements.input1.value = "junk";
elements.input2.value = "junk";

|||

7. 在錨點中使用 “onclick” 替代 “javascript: pseudo-protocol”

如果你想在 <a> 標簽中觸發javascript 代碼，選擇 onclick 而非 javascript: pseudo-protocol；使用 onclick 來運行的 javascript 代碼必須返回 ture 或者false（or an expression than evalues to true or false [這句要怎么翻譯呢? 我是這樣理解的：一個優先性高于true 或 false 的表達式]）來返回標簽本身：如果返回 true，則錨點的 href 將被當作一個一般的鏈接；如果返回 false，則 href 會被忽略。這就是為什么”return false;” 經常被包含在 onclick 所處理代碼的尾部。

正確句法：

在這個實例中，”dosomething()” 函數(定義于頁面的某個角落)將在被點擊時調用。href 將永遠不會被啟用了javascript 的瀏覽器訪問。在你可以提醒javascript 是必須的、而用戶未啟用之的瀏覽器中，文檔 javascript_required.html 才會被加載。通常，當你確保用戶將會開啟 javascript 支持，為盡量簡化，鏈接將只包含 href=”#”。而這個做法是不被鼓勵的。通常有一個不錯的做法是：可以提供沒用啟用 javascript 一個返回本地的頁面。

有時，眾多想要分情況來訪問一個鏈接。例如，當一個用戶要離開你的一個表單頁面，而想先驗證來確保沒有東西被改變。在這個情況下，你的 onclick 將會訪問一個返回詢問鏈接是否應該被遵循的函數：

有條件的鏈接訪問:

<a href="/" onclick="return validate();">home</a>
function validate() {
return prompt("are you sure you want to exit this page?");
}

在這個實例中，validate() 函數必須只返回 ture 或 false。ture 的時候用戶將被允許問題 home 頁面，或 false 的時候鏈接不被訪問。這個例子提示確認（其行為），以訪問 ture 或 false，這完全由用戶點擊”確實”或者”取消”決定。

下面是一些”不應該”的例子。如果你在自己的頁面中看到下面這樣的代碼，這是不正確的，需要被修改：

什么是不應該做的：

8. 使用一元 ‘+’ 號運算符使類型轉向number

在javascript中，”+”號運算符同時充當數學加號和連接符。這會在form表單的域值相加時出現問題，例如，因為javascript是一個弱類型語言，form 域的值將會被當作數組來處理，而你把它們”+”一起的時候，”+”將被當成連接符，而非數學加號。

有問題的例子:

<form name="myform" action="[url]">
<input type="text" name="val1" value="1">
<input type="text" name="val2" value="2">
</form>
function total() {
var theform = document.forms["myform"];
var total = theform.elements["val1"].value + theform.elements["val2"].value;
alert(total); // 這個將會彈出 "12", 但你想要的是 3!
}

解決這個問題，javascript 需要一個提示來讓它把這些值當做數字來處理。你可以使用”+”號來把數組轉換成數字。給變量或者表達式前置一個”+”號將會強制其當作一個數字來處理，而這也將使得數學”+”得以成功應用。

修改好的代碼：

function total() {
var theform = document.forms["myform"];
var total = (+theform.elements["val1"].value) + (+theform.elements["val2"].value);
alert(total); // this will alert 3
}

|||

9. 避免 document.all

document.all 是由microsoft 的 ie 所引進的，并不是一個標準的 javascript dom 特性。盡管大多數新的瀏覽器支持它以支持依賴于它的糟糕代碼，（而）還有很多瀏覽器是不支持的。

并沒有理由其他方法都不適用，而一個老的ie瀏覽器（<5.0）需要支持，而在javascript中使用 document.all 作為一個折衷方法。你并不需要使用 document.all 來檢測其是不是ie瀏覽器，因為其他瀏覽器現在一般都支持。

只把 document.all 當做最后的選擇：

if (document.getelementbyid) {
var obj = document.getelementbyid("myid");
}
else if (document.all) {
var obj = document.all("myid");
}

一些使用 document.all 的原則：

同嘗試其他方法
當其作為最后的選擇
當需要支持 5.0 版本以下的 ie 瀏覽器
總是使用 “if (document.all) { }” 來查看是否支持.

10. 不要在腳本代碼塊中使用html注釋

在 javascript 的舊日子（1995）里，諸如 netscape 1.0 的一些瀏覽器并不支持或認識 <script>標簽。所以，當 javascript 第一次被發布，需要有一個技術來讓實些代碼不被當做文本顯示于舊版瀏覽器上。有一個”hack” 是在代碼中使用 html 注釋來隱藏這些代碼。

使 html 注釋并不好：

在今天，沒有任何一個常用的瀏覽器會忽略掉 <script> 標簽。因此，再沒必要隱藏 javascript 源代碼。事實上，它還可以因為下面的理由，被認為是無益的：