除錯

本文檔說明如何使用 VS Code 除錯器、Chrome DevTools 或 Firefox DevTools，以完整的原始碼地圖支援來除錯您的 Next.js 前端和後端程式碼。

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

使用 VS Code 除錯

在您的專案根目錄建立名為 .vscode/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": "https://127.0.0.1:3000"
    },
    {
      "name": "Next.js: debug client-side (Firefox)",
      "type": "firefox",
      "request": "launch",
      "url": "https://127.0.0.1:3000",
      "reAttach": true,
      "pathMappings": [
        {
          "url": "webpack://_N_E",
          "path": "${workspaceFolder}"
        }
      ]
    },
    {
      "name": "Next.js: debug full stack",
      "type": "node",
      "request": "launch",
      "program": "${workspaceFolder}/node_modules/.bin/next",
      "runtimeArgs": ["--inspect"],
      "skipFiles": ["<node_internals>/**"],
      "serverReadyAction": {
        "action": "debugWithEdge",
        "killOnServerStop": true,
        "pattern": "- Local:.+(https?://.+)",
        "uriFormat": "%s",
        "webRoot": "${workspaceFolder}"
      }
    }
  ]
}

注意：若要在 VS Code 中使用 Firefox 除錯，您需要安裝 Firefox Debugger 擴充功能。

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

在「Next.js: debug full stack」設定中，serverReadyAction.action 指定伺服器準備就緒時要開啟哪個瀏覽器。 debugWithEdge 表示啟動 Edge 瀏覽器。如果您使用 Chrome，請將此值更改為 debugWithChrome。

如果您要變更應用程式啟動的連接埠號碼，請將 https://127.0.0.1:3000 中的 3000 替換為您正在使用的連接埠。

如果您從根目錄以外的目錄執行 Next.js（例如，如果您使用 Turborepo），則需要在伺服器端和完整堆疊除錯任務中新增 cwd。例如，"cwd": "${workspaceFolder}/apps/web"。

現在前往「除錯」面板（Windows/Linux 上為 Ctrl+Shift+D，macOS 上為 ⇧+⌘+D），選取啟動設定，然後按下 F5 或從命令面板中選取「除錯：開始除錯」以開始您的除錯會話。

在 Jetbrains WebStorm 中使用除錯器

點擊列出執行階段設定的下拉選單，然後點擊「編輯設定...」。建立一個 JavaScript Debug 除錯設定，並將 https://127.0.0.1:3000 作為 URL。根據您的喜好自訂（例如，用於除錯的瀏覽器、儲存為專案檔案），然後點擊「確定」。執行此除錯設定，選定的瀏覽器應會自動開啟。此時，您應該會有 2 個處於除錯模式的應用程式：NextJS 節點應用程式和用戶端/瀏覽器應用程式。

使用瀏覽器開發者工具除錯

用戶端程式碼

照常執行 next dev、npm run dev 或 yarn dev 來啟動您的開發伺服器。伺服器啟動後，在您偏好的瀏覽器中開啟 https://127.0.0.1:3000（或您的替代 URL）。

針對 Chrome

• 開啟 Chrome 的開發人員工具（Windows/Linux 上為 Ctrl+Shift+J，macOS 上為 ⌥+⌘+I）
• 前往「來源」標籤

針對 Firefox

• 開啟 Firefox 的開發人員工具（Windows/Linux 上為 Ctrl+Shift+I，macOS 上為 ⌥+⌘+I）
• 前往「除錯器」標籤

在任一瀏覽器中，每當您的用戶端程式碼到達 debugger 陳述式時，程式碼執行將會暫停，並且該檔案會出現在除錯區域中。您也可以搜尋檔案以手動設定中斷點

• 在 Chrome 中：在 Windows/Linux 上按下 Ctrl+P 或在 macOS 上按下 ⌘+P
• 在 Firefox 中：在 Windows/Linux 上按下 Ctrl+P 或在 macOS 上按下 ⌘+P，或使用左側面板中的檔案樹

請注意，搜尋時，您的原始檔路徑將以 webpack://_N_E/./ 開頭。

伺服器端程式碼

若要使用瀏覽器開發者工具除錯伺服器端 Next.js 程式碼，您需要將 --inspect 標記傳遞給底層的 Node.js 程序

NODE_OPTIONS='--inspect' next dev

小提示：使用 NODE_OPTIONS='--inspect=0.0.0.0' 以允許在 localhost 外部進行遠端除錯存取，例如在 Docker 容器中執行應用程式時。

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

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

使用 --inspect 標記啟動 Next.js 開發伺服器看起來會像這樣

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

針對 Chrome

1. 開啟新標籤並訪問 chrome://inspect
2. 點擊「設定...」以確保列出兩個除錯連接埠
3. 如果 localhost:9229 和 localhost:9230 尚未存在，請同時新增它們
4. 在「遠端目標」區段中尋找您的 Next.js 應用程式
5. 點擊「檢查」以開啟單獨的開發者工具視窗
6. 前往「來源」標籤

針對 Firefox

1. 開啟新標籤並訪問 about:debugging
2. 點擊左側邊欄中的「此 Firefox」
3. 在「遠端目標」下，尋找您的 Next.js 應用程式
4. 點擊「檢查」以開啟除錯器
5. 前往「除錯器」標籤

除錯伺服器端程式碼的方式與除錯用戶端程式碼類似。搜尋檔案時 (Ctrl+P/⌘+P)，您的原始檔路徑將以 webpack://{application-name}/./ 開頭（其中 {application-name} 將替換為根據您的 package.json 檔案的應用程式名稱）。

使用瀏覽器開發者工具檢查伺服器錯誤

當您遇到錯誤時，檢查原始碼可以幫助追蹤錯誤的根本原因。

Next.js 將在錯誤覆蓋層上的 Next.js 版本指示器下方顯示 Node.js 圖示。透過點擊該圖示，DevTools URL 會複製到您的剪貼簿。您可以開啟一個包含該 URL 的新瀏覽器標籤，以檢查 Next.js 伺服器程序。

在 Windows 上除錯

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

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