10種最常見的Javascript錯誤——總結于1000+個項目，并闡述如何避免
為了回饋我們的開發者社區，我們查看了數千個項目的數據庫，發現了 JavaScript 中頻度***的 10 種錯誤。我們會告訴你什么原因導致了這些錯誤，以及如何防止這些錯誤發生。如果你能夠避免落入這些 “陷阱”，你將會成為一個更好的開發者。
數據才是王道，我們收集并分析了出現頻次排前 10 的 JavaScript 錯誤。 Rollbar 會收集每個項目的所有錯誤，并總結每個錯誤發生的次數。我們通過根據 “指紋”(rollbar 用到的一種算法，詳見：https://rollbar.com/docs/grouping-algorithm/)對錯誤進行分組。基本上，如果第二個錯誤只是***個錯誤的重復，我們會把兩個錯誤分到同一組。這會給用戶一個很好的概括，而不是像在日志文件中看到的那樣直接一大堆讓人感覺到十分壓迫的 dump。
我們專注于最有可能影響您和您的用戶的錯誤。為此，我們通過研究各種不同公司的項目集來對于錯誤進行排列。如果我們只查看每個錯誤發生的總次數，那么客戶量大的的項目產生的錯誤可能會壓倒其他錯誤，導致實際收集到的是與大多數讀者無關的錯誤數據集。
以下是 JavaScript 錯誤 Top 10：
為了便于閱讀，我們將每個錯誤描述都縮短了。接下來，讓我們深入到每一個錯誤，來確定什么會導致它，以及如何避免創建它。
1. Uncaught TypeError: Cannot read property
如果你是一個 JavaScript 開發人員，可能你看到這個錯誤的次數比你敢承認的要多(LOL…)。當你讀取一個未定義的對象的屬性或調用其方法時，這個錯誤會在 Chrome 中出現。 您可以很容易的在 Chrome 開發者控制臺中進行測試(嘗試)。
發生這種情況的原因很多，但常見的一種是在渲染 UI 組件時對于狀態的初始化操作不當。
我們來看一個在真實應用程序中發生的例子：我們選擇 React，但該情況也同樣適用于 Angular、Vue 或任何其他框架。
- class Quizextends 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中獲取的，組件在數據加載之前至少會呈現一次，當 Quiz ***次呈現時，this.state.items 是未定義的。 這又意味著 ItemList 將 items 定義為 undefined，并且在控制臺中出現錯誤 - “Uncaught TypeError: Cannot read property ‘map’ of undefined”。
這很容易解決。最簡單的方法：在構造函數中用合理的默認值來初始化 state。
- class Quizextends 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
這是在 Safari 中讀取屬性或調用未定義對象上的方法時發生的錯誤。您可以在 Safari Developer Console 中輕松測試。這與 1 中提到的 Chrome 的錯誤基本相同，但 Safari 使用了不同的錯誤消息提示語。
3. TypeError: null is not an object
這是在 Safari 中讀取屬性或調用空對象上的方法時發生的錯誤。 您可以在 Safari Developer Console 中輕松測試。
有趣的是，在 JavaScript 中，null 和 undefined 是不一樣的，這就是為什么我們看到兩個不同的錯誤信息。undefined 通常是一個尚未分配的變量，而 null 表示該值為空。 要驗證它們不相等，請嘗試使用嚴格的相等運算符 ===：
在現實世界的例子中，這種錯誤可能發生的一種場景是：如果在加載元素之前嘗試在 JavaScript 中使用元素。 因為 DOM API 對于空白的對象引用返回值為 null。
任何執行和處理 DOM 元素的 JS 代碼都應該在創建 DOM 元素之后執行。 JS 代碼按照 HTML 中的規定從上到下進行解釋。 所以，如果 DOM 元素之前有一個標簽，腳本標簽內的 JS 代碼將在瀏覽器解析 HTML 頁面時執行。 如果在加載腳本之前尚未創建 DOM 元素，則會出現此錯誤。
在這個例子中，我們可以通過添加一個事件監聽器來解決這個問題，這個監聽器會在頁面準備好的時候通知我們。 一旦 addEventListener被觸發，init() 方法就可以使用 DOM 元素。
- <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>
- <inputtype="text"id="myTextfield"placeholder="Type your name"/>
- <inputtype="button"id="myButton"value="Go"/>
- </form>
4. (unknown): Script error
當未捕獲的 JavaScript 錯誤(通過window.onerror處理程序引發的錯誤，而不是捕獲在try-catch中)被瀏覽器的跨域策略限制時，會產生這類的腳本錯誤。 例如，如果您將您的 JavaScript 代碼托管在 CDN 上，則任何未被捕獲的錯誤將被報告為“腳本錯誤” 而不是包含有用的堆棧信息。這是一種瀏覽器安全措施，旨在防止跨域傳遞數據，否則將不允許進行通信。
要獲得真正的錯誤消息，請執行以下操作：
1. 發送 ‘Access-Control-Allow-Origin’ 頭部
將 Access-Control-Allow-Origin 標頭設置為 * 表示可以從任何域正確訪問資源。 如有必要，您可以將域替換為您的域：例如，Access-Control-Allow-Origin：www.example.com。 但是，處理多個域會變得棘手，如果你使用 CDN，可能由此產生更多的緩存問題會讓你感覺到這種努力并不值得。 在這里看到更多。
這里有一些關于如何在各種環境中設置這個頭文件的例子：
Apache
在 JavaScript 文件所在的文件夾中，使用以下內容創建一個 .htaccess 文件：
- Header add Access-Control-Allow-Origin "*"
Nginx
將 add_header 指令添加到提供 JavaScript 文件的位置塊中：
- location ~ ^/assets/ {
- add_header Access-Control-Allow-Origin *;
- }
HAProxy
將以下內容添加到您為 JavaScript 文件提供資源服務的后端：
- rspadd Access-Control-Allow-Origin:\ *
2. 在<script>中設置crossorigin="anonymous"
在您的 HTML 代碼中，對于您設置了 Access-Control-Allow-Origin header 的每個腳本，在 script 標簽上設置 crossorigin =“anonymous” 。在腳本標記中添加 crossorigin 屬性之前，請確保驗證上述 header 正確發送。 在 Firefox 中，如果存在 crossorigin 屬性，但 Access-Control-Allow-Origin 頭不存在，則腳本將不會執行。
5. TypeError: Object doesn’t support property
這是您在調用未定義的方法時發生在 IE 中的錯誤。 您可以在 IE 開發者控制臺中進行測試。
這相當于 Chrome 中的 “TypeError：”undefined“ is not a function” 錯誤。 是的，對于相同的邏輯錯誤，不同的瀏覽器可能具有不同的錯誤消息。
對于使用 JavaScript 命名空間的 Web 應用程序，這是一個 IE l瀏覽器的常見的問題。 在這種情況下，99.9% 的原因是 IE 無法將當前名稱空間內的方法綁定到 this 關鍵字。 例如：如果你 JS 中有一個命名空間 Rollbar 以及方法 isAwesome 。 通常，如果您在 Rollbar 命名空間內，則可以使用以下語法調用 isAwesome 方法：
- this.isAwesome();
Chrome，Firefox 和 Opera 會欣然接受這個語法。 另一方面 IE，不會。 因此，使用 JS 命名空間時最安全的選擇是始終以實際名稱空間作為前綴。
- Rollbar.isAwesome();
6. TypeError: ‘undefined’ is not a function
當您調用未定義的函數時，這是 Chrome 中產生的錯誤。 您可以在 Chrome 開發人員控制臺和 Mozilla Firefox 開發人員控制臺中進行測試。
隨著 JavaScript 編碼技術和設計模式在過去幾年中變得越來越復雜，回調和關閉中的自引用范圍也相應增加，這是這種/那種混淆的相當常見的來源。
考慮這個代碼片段：
- 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 保存在一個變量，然后可以由閉包繼承。 例如：
- function testFunction(){
- this.clearLocalStorage();
- var self = this; // save reference to 'this', while it's still this!
- this.timer = setTimeout(function(){
- self.clearBoard();
- }, 0);
- };
或者，在較新的瀏覽器中，可以使用 bind() 方法傳遞適當的引用：
- 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 在一些情況下會發生的錯誤。 一個是當你調用一個不終止的遞歸函數。您可以在 Chrome 開發者控制臺中進行測試。
此外，如果您將值傳遞給超出范圍的函數，也可能會發生這種情況。 許多函數只接受其輸入值的特定范圍的數字。 例如： Number.toExponential(digits) 和 Number.toFixed(digits) 接受 0 到 20 的數字， Number.toPrecision(digits) 接受 1 到 21 的數字。
- 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 中發生的錯誤，因為讀取未定義變量的長度屬性。 您可以在 Chrome 開發者控制臺中進行測試。
您通常會在數組中找到定義的長度，但是如果數組未初始化或者變量名稱在另一個上下文中隱藏，則可能會遇到此錯誤。讓我們用下面的例子來理解這個錯誤。
- var testArray = ["Test"];
- function testFunction(testArray){
- for (var i = 0; i < testArray.length; i++) {
- console.log(testArray[i]);
- }
- }
- testFunction();
當你用參數聲明一個函數時，這些參數變成了函數作用域內的本地參數。這意味著即使你函數外有名為 testArray 的變量，在一個函數中具有相同名字的參數也會被視為本地參數。
您有兩種方法可以解決您的問題：
1. 刪除函數聲明語句中的參數(事實上你想訪問那些聲明在函數之外的變量，所以你不需要函數的參數)：
- 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. 用聲明的數組調用該函數：
- 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 ，我們不能獲取或設置任何未定義的屬性。 在這種情況下，應用程序將拋出 “Uncaught TypeError: Cannot set property”。
例如，在 Chrome 瀏覽器中：
如果測試對象不存在，錯誤將會拋出 “Uncaught TypeErrorUncaught TypeError: Cannot set property”。
10. ReferenceError: event is not defined
當您嘗試訪問未定義的變量或超出當前范圍的變量時，會引發此錯誤。 您可以在 Chrome 瀏覽器中輕松測試。
如果在使用事件處理系統時遇到此錯誤，請確保使用傳入的事件對象作為參數。像 IE 這樣的舊瀏覽器提供了一個全局變量事件，但并不是所有瀏覽器都支持。像 jQuery 這樣的庫試圖規范化這種行為。盡管如此，***使用傳入事件處理函數的函數。
- function myFunction(event){
- event = event.which || event.keyCode;
- if(event.keyCode===13){
- alert(event.keyCode);
- }
- }
結論
我們希望你學到了新的東西，可以避免將來的錯誤，或者本指南幫助你解決了頭痛的問題。
盡管如此，即使有***實踐，生產中也會出現意想不到的錯誤。能夠查看影響用戶的錯誤，并擁有快速解決問題的好工具，這一點非常重要。推薦 Rollbar 。
