通過統計資料庫中的1000多個專案,我們發現在 JavaScript 中最常出現的錯誤有10個。下面會向大家介紹這些錯誤發生的原因以及如何防止。
對於這些錯誤發生的次數,我們是通過收集的資料統計得出的。Rollbar 會收集每個專案中的所有錯誤,並總結每個錯誤發生的次數,然後通過各個錯誤的特徵進行分組。
下圖是發生次數最多的10大 JavaScript 錯誤:
下面開始深入探討每個錯誤發生的情況,以便確定導致錯誤發生的原因以及如何避免。
1. Uncaught TypeError: Cannot Read Property
這是 JavaScript 開發人員最常遇到的錯誤。當你讀取一個屬性或呼叫一個未定義物件的方法時,Chrome 中就會報出這樣的錯誤。
導致這個錯誤發生的原因有很多,常見的一種情況是在渲染 UI 元件時,不正確地初始化狀態。我們來看一個真實的應用程式中發生這種情況的例子。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
class Quiz extends Component { componentWillMount() { axios.get('/thedata').then(res => { this.setState({items: res.data}); }); } render() { return ( <ul> {this.state.items.map(item => <li key={item.id}>{item.name}</li> )} </ul> ); } } |
以上程式碼有兩個重要方面:
- 一是元件的狀態(例如 this.state),在開始生命週期之前是 undefined 狀態。
- 二是當通過非同步的方式獲取資料時,無論是在建構函式中 componentWillMount 中,還是在建構函式中提取 componentDidMount,元件在資料載入之前至少會渲染一次。當檢測首次渲染時,會發現 this.state.items 是未定義的。此時就會出現一個錯誤 -“Uncaught TypeError: Cannot read property ‘map’ of undefined” in the consol”。
解決的方法很簡單:在建構函式中使用合理的預設值進行狀態初始化。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
複製程式碼 class Quiz extends Component { // Added this: constructor(props) { super(props); // Assign state itself, and a default value for items this.state = { items: [] }; } componentWillMount() { axios.get('/thedata').then(res => { this.setState({items: res.data}); }); } render() { return ( <ul> {this.state.items.map(item => <li key={item.id}>{item.name}</li> )} </ul> ); } } |
2. TypeError: ‘undefined’ Is Not an Object (evaluating…)
這是在 Safari 中讀取屬性或呼叫未定義物件上的方法時發生的錯誤,這與 Chrome 的上述錯誤基本相同,只是 Safari 使用不同的錯誤訊息。
3. TypeError: Null Is Not an Object (evaluating…)
這是在 Safari 中讀取屬性或呼叫空物件上的方法時發生的錯誤。
有趣的是,在 JavaScript 中,null 和 undefined 是兩種不同的型別,這就是為什麼會出現兩個不同的錯誤訊息。未定義通常是一個尚未分配的變數,而 null 則表示該值為空。要驗證它們不相等,請使用嚴格的相等運算子:
在實際情況中,導致這種錯誤的原因之一是:在元素載入之前,就嘗試在 JavaScript 中使用 DOM 元素。這是因為 DOM API 對於空白的物件引用返回 null。
任何執行和處理 DOM 元素的 JS 程式碼,都應該在建立 DOM 元素之後執行。JS 程式碼按照 HTML 中的規定自上而下進行解釋。因此,如果在 DOM 元素之前存在標籤,則指令碼標籤內的 JS 程式碼就會在瀏覽器分析 HTML 頁面時執行。如果在載入指令碼之前尚未建立 DOM 元素,就會出現這樣的錯誤。
在這個例子中,我們可以通過新增一個事件偵聽器來解決這個問題,事件偵聽器會在頁面準備就緒時通知我們。一旦 addEventListener 被觸發,該 init( ) 方法就可以使用 DOM 元素。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
<script> function init() { var myButton = document.getElementById("myButton"); var myTextfield = document.getElementById("myTextfield"); myButton.onclick = function() { var userName = myTextfield.value; } } document.addEventListener('readystatechange', function() { if (document.readyState === "complete") { init(); } }); </script> <form> <input type="text" id="myTextfield" placeholder="Type your name" /> <input type="button" id="myButton" value="Go" /> </form> |
4. (unknown): Script Error
當未捕獲的 JavaScript 錯誤違背跨邊界原則時,就會發生指令碼錯誤。例如,如果將 JavaScript 程式碼託管在 CDN 上,則任何未被捕獲的錯誤(通過 window.onerror 處理程式發出的錯誤,而不是 try-catch 中捕獲到的錯誤)將僅報告為“指令碼錯誤”。這是瀏覽器的一種安全措施,主要用於防止跨域傳遞資料的情況出現。
要獲取真實的錯誤訊息,需要執行以下操作:
1. Access-Control-Allow-Origin
將 Access-Control-Allow-Origin 設定為 *, 表示可以從任何域正確訪問資源。* 如有必要,也可以用自己的域名進行替換,例如:
Access-Control-Allow-Origin: www.example.com。
以下是在各種環境中設定的一些示例:
Apache
在 JavaScript 資料夾中,建立一個 .htaccess 檔案,幷包含以下內容:
1 |
Header add Access-Control-Allow-Origin "*" |
Nginx
將 add_header 指令新增到提供 JavaScript 檔案的 location block 中:
1 2 3 |
location ~ ^/assets/ { add_header Access-Control-Allow-Origin *; } |
HAProxy
將以下內容新增到提供 JavaScript 檔案的靜態資源配置後端:
1 |
rspadd Access-Control-Allow-Origin:\ * |
2. 在指令碼標籤上設定crossorigin =“anonymous”
在你的 HTML 原始碼中,為每一個指令碼設定 Access-Control-Allow-Origin,在設定 SCRIPT 標籤中,設定 crossorigin=”anonymous”。在將 crossorigin 屬性新增到指令碼標籤之前,請確保正在向指令碼檔案傳送 header。在 Firefox 中,如果 crossorigin 屬性存在但 Access-Control-Allow-Origin 標題不存在,則指令碼不會執行。
5. TypeError: Object Doesn’t Support Property
當呼叫未定義的方法時,IE 中會發生這樣的錯誤。
這相當於 Chrome 中的 “undefined’ is not a function” 錯誤。對於相同的邏輯錯誤,不同的瀏覽器可能會有不同的錯誤訊息。
這是在 IE 的 Web 應用程式中使用 JavaScript 名稱空間出現的一個常見問題。出現這種情況的絕大部分原因是IE無法將當前名稱空間內的方法繫結到this關鍵字。例如,如果你有 JS Rollbar 方法的名稱空間 isAwesome。通常,如果位於 Rollbar 名稱空間內,則可以使用以下語法呼叫該 isAwesome 方法:
1 |
this.isAwesome(); |
Chrome、Firefox 和 Opera 接受這種語法,IE則不接受。因此,使用 JS 名稱空間時最安全的做法是:始終以實際名稱空間作為字首。
1 |
Rollbar.isAwesome(); |
6. TypeError: ‘undefined’ Is Not a Function
當呼叫未定義的函式時,Chrome 中就會發生這樣的錯誤。
隨著 JavaScript 編碼技術和設計模式在過去幾年中變得越來越複雜,回撥和閉包中的自引用範圍也相應增加,這是造成這種混亂現象的主要來源。
正如下面的示例程式碼片段:
1 2 3 4 5 6 |
function testFunction() { this.clearLocalStorage(); this.timer = setTimeout(function() { this.clearBoard(); // what is "this"? }, 0); }; |
執行上面的程式碼會導致以下錯誤:“Uncaught TypeError: undefined is not a function。” 發生以上錯誤的原因是,當你呼叫 setTimeout( ) 時,實際上是在呼叫 window.setTimeout( ),傳遞給 setTimeout( ) 的匿名函式是在視窗物件的上下文中定義的,而該視窗物件沒有 clearBoard( ) 方法。
符合舊版瀏覽器的解決方案是以變數的方式簡單地將引用儲存在 this 中,然後通過閉包繼承。例如:
1 2 3 4 5 6 7 |
function testFunction () { this.clearLocalStorage(); var self = this; // save reference to 'this', while it's still this! this.timer = setTimeout(function(){ self.clearBoard(); }, 0); }; |
或者,在較新的瀏覽器中,使用 bind( ) 方法傳遞引用:
1 2 3 4 5 6 7 |
function testFunction () { this.clearLocalStorage(); this.timer = setTimeout(this.reset.bind(this), 0); // bind to 'this' }; function testFunction(){ this.clearBoard(); //back in the context of the right 'this'! }; |
7. Uncaught RangeError: Maximum Call Stack
這是在很多種情況,Chrome 中發生的錯誤,一種情況是當你呼叫一個不會終止的遞迴函式時。
如果將值傳遞給超出範圍的函式,也可能會發生這種情況。許多函式只接受特定範圍內的數字輸入值。例如,Number.toExponential( digits ) 與 Number.toFixed( digits) 接受的引數範圍為從0到20,而 Number.toPrecision( digits ) 接受的數字範圍為從1至21。
1 2 3 4 5 6 7 8 9 10 11 |
var a = new Array(4294967295); //OK var b = new Array(-1); //range error var num = 2.555555; document.writeln(num.toExponential(4)); //OK document.writeln(num.toExponential(-2)); //range error! num = 2.9999; document.writeln(num.toFixed(2)); //OK document.writeln(num.toFixed(25)); //range error! num = 2.3456; document.writeln(num.toPrecision(1)); //OK document.writeln(num.toPrecision(22)); //range error! |
8. TypeError: Cannot Read Property ‘length’
這是 Chrome 中發生的錯誤,因為讀取了未定義長度屬性的變數。
通常在陣列中能夠找到定義的長度,但是如果陣列未初始化或變數名在另一個上下文中隱藏,則可能會出現這種錯誤。讓我們用下面的例子來解釋這種錯誤。
1 2 3 4 5 6 7 |
var testArray= ["Test"]; function testFunction(testArray) { for (var i = 0; i <testArray.length;i++) { console.log(testArray[i]); } } testFunction(); |
當用引數宣告一個函式時,這些引數會成為本地引數。這意味著即使你有名稱變數 testArray,函式中具有相同名稱的引數仍會被視為本地引數。
有兩種方法可以解決這個問題:
1. 刪除函式宣告語句中的引數:
1 2 3 4 5 6 7 8 |
var testArray = ["Test"]; /* Precondition: defined testArray outside of a function */ function testFunction(/* No params */) { for (var i = 0; i <testArray.length;i++) { console.log(testArray[i]); } } testFunction(); |
2. 呼叫傳遞給我們宣告的陣列函式:
1 2 3 4 5 6 7 |
var testArray = ["Test"]; function testFunction(testArray) { for (var i = 0; i <testArray.length;i++) { console.log(testArray[i]); } } testFunction(testArray); |
9. Uncaught TypeError: Cannot Set Property
當嘗試訪問未定義的變數時,總會返回 undefined。我們也無法獲取或設定 undefined 的任何屬性。在這種情況下,應用程式將丟擲“Uncaught TypeError cannot set property of undefined”。
例如,在 Chrome 瀏覽器中,如果 test 物件不存在,就會出現這種錯誤:
所以就需要在訪問變數之前,對變數進行定義。
10. ReferenceError: Event Is Not Defined
嘗試訪問未定義的變數或當前範圍之外的變數時會引發此錯誤。
如果在使用事件處理系統時遇到此錯誤,請確保使用傳入的事件物件作為引數。IE 這樣的瀏覽器提供了全域性變數事件,Chrome 會自動將事件變數附加到處理程式中,Firefox 則不會自動新增事件變數。
1 2 3 |
document.addEventListener("mousemove", function (event) { console.log(event); }) |
結論
事實證明很多這些 null 或 undefined 的錯誤是普遍存在的。 一個類似於 Typescript 這樣的好的靜態型別檢查系統,當設定為嚴格的編譯選項時,能夠幫助開發者避免這些錯誤。
最後也希望通過本文,可以幫助開發者更好避免或是應對以上的10種錯誤。