除錯 | Next.js - 繁體中文

本文件說明如何透過完整的原始碼映射支援，使用 VS Code 除錯器或 Chrome DevTools 來為您的 Next.js 前端和後端程式碼進行除錯。

任何可以附加到 Node.js 的除錯器也可用於為 Next.js 應用程式進行除錯。您可以在 Node.js 的除錯指南中找到更多詳細資訊。

使用 VS Code 進行除錯

在專案的根目錄下建立一個名為 .vscode/launch.json 的檔案，內容如下：

launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Next.js: debug server-side",
      "type": "node-terminal",
      "request": "launch",
      "command": "npm run dev"
    },
    {
      "name": "Next.js: debug client-side",
      "type": "chrome",
      "request": "launch",
      "url": "http://localhost:3000"
    },
    {
      "name": "Next.js: debug full stack",
      "type": "node-terminal",
      "request": "launch",
      "command": "npm run dev",
      "serverReadyAction": {
        "pattern": "- Local:.+(https?://.+)",
        "uriFormat": "%s",
        "action": "debugWithChrome"
      }
    }
  ]
}

如果您使用 Yarn 或 pnpm，可以將 npm run dev 替換為 yarn dev 或 pnpm dev。

如果您變更了應用程式啟動的埠號，請將 http://localhost:3000 中的 3000 替換為您使用的埠號。

如果您從非根目錄執行 Next.js（例如使用 Turborepo），則需要在伺服器端和全堆疊除錯任務中添加 cwd。例如："cwd": "${workspaceFolder}/apps/web"。

現在前往除錯面板（Windows/Linux 上按 Ctrl+Shift+D，macOS 上按 ⇧+⌘+D），選擇一個啟動配置，然後按 F5 或從命令面板中選擇 Debug: Start Debugging 來開始您的除錯工作階段。

點擊執行時配置的下拉選單，然後點擊 Edit Configurations...。建立一個 Javascript Debug 除錯配置，將 http://localhost:3000 設為 URL。根據您的喜好進行自訂（例如選擇用於除錯的瀏覽器、儲存為專案檔案等），然後點擊 OK。執行此除錯配置，所選的瀏覽器應會自動開啟。此時，您應該有兩個應用程式處於除錯模式：NextJS 節點應用程式和客戶端/瀏覽器應用程式。

使用 Chrome DevTools 進行除錯

客戶端程式碼

像往常一樣執行 next dev、npm run dev 或 yarn dev 來啟動開發伺服器。伺服器啟動後，在 Chrome 中開啟 http://localhost:3000（或您的替代 URL）。接著，開啟 Chrome 的開發者工具（Windows/Linux 上按 Ctrl+Shift+J，macOS 上按 ⌥+⌘+I），然後前往 Sources 標籤。

現在，每當您的客戶端程式碼執行到 debugger 語句時，程式碼執行將會暫停，該檔案將出現在除錯區域中。您也可以按 Ctrl+P（Windows/Linux）或 ⌘+P（macOS）來搜尋檔案並手動設定中斷點。請注意，在此搜尋時，您的原始檔路徑將以 webpack://_N_E/./ 開頭。

伺服器端程式碼

要使用 Chrome DevTools 為伺服器端 Next.js 程式碼進行除錯，您需要將 --inspect 標記傳遞給底層的 Node.js 程序：

Terminal

NODE_OPTIONS='--inspect' next dev

如果您使用 npm run dev 或 yarn dev，則應更新 package.json 中的 dev 腳本：

package.json

{
  "scripts": {
    "dev": "NODE_OPTIONS='--inspect' next dev"
  }
}

使用 --inspect 標記啟動 Next.js 開發伺服器時，輸出將類似於以下內容：

Terminal

Debugger listening on ws://127.0.0.1:9229/0cf90313-350d-4466-a748-cd60f4e47c95
For help, see: https://nodejs.org/en/docs/inspector
ready - started server on 0.0.0.0:3000, url: http://localhost:3000

請注意，執行 NODE_OPTIONS='--inspect' npm run dev 或 NODE_OPTIONS='--inspect' yarn dev 將無法正常工作。這會嘗試在同一埠上啟動多個除錯器：一個用於 npm/yarn 程序，一個用於 Next.js。您將在控制台中看到類似 Starting inspector on 127.0.0.1:9229 failed: address already in use 的錯誤。

伺服器啟動後，在 Chrome 中開啟新分頁並訪問 chrome://inspect，您應該會在 Remote Target 部分看到您的 Next.js 應用程式。點擊應用程式下方的 inspect 以開啟獨立的 DevTools 視窗，然後前往 Sources 標籤。

在此處為伺服器端程式碼進行除錯與使用 Chrome DevTools 為客戶端程式碼進行除錯非常相似，只是當您使用 Ctrl+P 或 ⌘+P 搜尋檔案時，您的原始檔路徑將以 webpack://{application-name}/./ 開頭（其中 {application-name} 將根據您的 package.json 檔案替換為您的應用程式名稱）。

在 Windows 上進行除錯

Windows 使用者在執行 NODE_OPTIONS='--inspect' 時可能會遇到問題，因為該語法在 Windows 平台上不受支援。為了解決這個問題，請安裝 cross-env 套件作為開發依賴項（使用 npm 和 yarn 時加上 -D），並將 dev 腳本替換為以下內容：

package.json

{
  "scripts": {
    "dev": "cross-env NODE_OPTIONS='--inspect' next dev"
  }
}

cross-env 將設定 NODE_OPTIONS 環境變數，無論您使用的是哪個平台（包括 Mac、Linux 和 Windows），並允許您在各種裝置和作業系統上一致地進行除錯。

小提示：請確保您的電腦上已停用 Windows Defender。此外部服務會檢查 每個讀取的檔案，據報告這會大大增加使用 next dev 時的快速重新整理時間。這是一個已知問題，與 Next.js 無關，但確實會影響 Next.js 的開發。

除錯

使用 VS Code 進行除錯

在 Jetbrains WebStorm 中使用除錯器

使用 Chrome DevTools 進行除錯

客戶端程式碼

伺服器端程式碼

在 Windows 上進行除錯

更多資訊

On this page