NodeJS 錯誤處理最佳實踐-前端問答-PHP中文網

NodeJS 錯誤處理最佳實踐

PHPz

發布： 2023-05-12 10:35:06

原創

733 人瀏覽過

NodeJS 是一種基於事件驅動、非同步 I/O 的開放原始碼伺服器端 JavaScript 執行階段環境。它的高效性和可擴展性使得 NodeJS 成為了許多企業級 Web 應用的首選技術。然而，像所有其他軟體一樣，NodeJS 應用程式也無法完全避免出現錯誤和異常。為了提高程式碼的健全性和可靠性，正確地進行錯誤處理是非常重要的。

本文旨在提供一些 NodeJS 錯誤處理的最佳實踐，幫助開發者從根本上改進錯誤處理的方式。

一、利用 Error 物件

JavaScript 提供了內建的 Error 對象，它們是用來表示執行階段錯誤的標準方式。在 NodeJS 中，開發者可以基於 Error 物件建立自己的客製化錯誤對象，從而更好地適應應用的特定需求。以下是一個簡單的例子：

class DatabaseConnectionError extends Error {
  constructor(msg, userFriendlyMsg) {
    super(msg);
    this.userFriendlyMsg = userFriendlyMsg;
    this.name = this.constructor.name;
    Error.captureStackTrace(this, this.constructor);
  }
}

登入後複製

在這個例子中，我們擴展了NodeJS 內建的Error 對象，並添加了一個userFriendlyMsg 屬性來提供用戶友好的錯誤訊息，並且重載了構造函數以允許在創建錯誤的同時透明地提供這些資訊。

二、優雅地處理非同步異常

由於 NodeJS 是非同步 I/O 的，其異常處理方式與傳統的同步程式碼不同。因此，在非同步程式碼中處理異常需要遵循一些不同的規則。以下是兩種優雅地處理非同步異常的方法：

回呼函數中的異常處理

在NodeJS 中，回呼函數是事件驅動的解決方案的核心。通常，回呼函數會採用(error, data)的雙參數形式，其中 error 參數表示非同步操作時可能出現的錯誤，data 參數表示非同步操作的結果。

為了優雅地處理回呼函數中的異常，我們建議使用 error-first callback 的模式，即在回呼函數的第一個參數中傳遞錯誤物件。當然，在某些情況下，可以使用 try-catch 語句來捕獲回呼函數中的異常，但這通常不是一個好的實踐。

以下是一個簡單的例子：

function readFile(filePath, callback) {
  fs.readFile(filePath, (err, data) => {
    if (err) {
      callback(new Error(`Failed to read file: ${filePath}`));
    } else {
      callback(null, data);
    }
  });
}

登入後複製

在這個例子中，我們在回調函數中手動檢查錯誤，並將錯誤物件作為第一個參數傳遞給回調。

Promise 異常處理

Promise 是現代 JavaScript 中提供了更優雅的非同步程式碼處理方式。透過 Promise，可以更自然地處理非同步操作中可能出現的異常。以下是一個簡單的範例：

function readFilePromise(filePath) {
  return new Promise((resolve, reject) => {
    fs.readFile(filePath, (err, data) => {
      if (err) {
        reject(new Error(`Failed to read file: ${filePath}`));
      } else {
        resolve(data);
      }
    });
  });
}

登入後複製

在這個範例中，我們使用Promise 物件來處理非同步讀取檔案的操作，並且在出現異常的情況下使用reject 方法設定Promise 的狀態為“rejected” 。注意，在 Promise 異常處理鏈的每個環節都需要呼叫 catch 方法或使用 Promise.allSettled() 方法才能確保不會有異常被忽略。

三、寫好日誌記錄

當出現錯誤時，日誌記錄是一項重要的任務。日誌可以幫助我們快速定位問題，找出錯誤的根本原因，並找到合適的解決方案。

在 NodeJS 中，日誌記錄可以使用內建的 console 對象，也可以使用第三方日誌記錄庫，例如 winston.js、bunyan 等。

如果有多個 NodeJS 實例或運行在多個伺服器上，則應將錯誤日誌記錄到中央日誌記錄系統中，例如 Elasticsearch、Graylog、Logstash 等等。

四、使用適當的偵錯工具

像 NodeJS 這樣的大型伺服器應用程式可以變得非常複雜，出現錯誤時偵錯也變得很棘手。為了更輕鬆地調試 NodeJS 應用程序，我們可以使用一些適當的調試工具。以下是一些常用的偵錯工具：