资讯

历史

科技

环境与自然

成长

游戏

财经

文学与艺术

美食

健康

家居

文化

情感

汽车

三农

军事

旅行

运动

教育

生活

星座命理

VSCode调试Node.js完全指南：从入门到实战

创作时间:

作者:

@小白创作中心

VSCode调试Node.js完全指南：从入门到实战

引用

来源

https://docs.pingcode.com/baike/3578272

在开发Node.js应用程序时，调试是一个必不可少的环节。本文将详细介绍如何在VSCode中调试Node.js应用程序，包括配置launch.json文件、使用内置调试工具、设置断点、监视变量等基本操作，以及远程调试、TypeScript项目调试等高级功能。

一、配置 launch.json 文件

在VSCode中调试Node.js应用程序的第一步是配置launch.json文件。这个文件用于定义调试器的配置，比如启动程序的路径、调试端口等。

打开VSCode并打开你的Node.js项目。
按下Ctrl+Shift+D或点击左侧活动栏中的调试图标，进入调试视图。
点击齿轮图标，选择“Node.js”环境，这时会自动生成一个launch.json文件。

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "启动程序",
      "skipFiles": ["<node_internals>/"],
      "program": "${workspaceFolder}/app.js"
    }
  ]
}

在这个配置文件中，program属性指定了要调试的入口文件路径。你可以根据实际项目的需求修改这个路径。

二、使用内置调试工具

VSCode提供了丰富的调试工具，可以帮助你快速找到问题。

调试控制台

调试控制台是一个非常有用的工具，你可以在这里查看日志、变量值等信息。在调试过程中，调试控制台会自动显示当前程序的运行状态，并允许你输入命令来检查变量的值或者执行一些即时代码。

调试工具栏

调试工具栏提供了一些常用的调试操作，比如继续运行、单步执行、跳过、重启等。这些功能可以帮助你快速定位问题代码。

三、设置断点

断点是调试过程中的重要工具，它可以让程序在特定的代码行暂停运行，从而方便你检查代码的状态。

如何设置断点

在代码编辑器中，点击代码行左侧的灰色区域，即可添加断点。
再次点击该区域可以移除断点。

条件断点

有时候，你可能需要在特定条件下才暂停程序的运行。这个时候可以使用条件断点：

右键点击断点，选择“编辑断点”。
输入条件表达式，比如i === 5，这样只有在i等于5时程序才会暂停。

四、监视变量

调试过程中，监视变量是一个非常有用的功能。它允许你查看和监控变量的实时值。

如何监视变量

在调试视图中，找到“监视”面板。
点击加号按钮，输入你想监视的变量名。
在程序运行过程中，“监视”面板会自动更新变量的值。

五、使用调试控制台

调试控制台可以让你在调试过程中执行任意的JavaScript代码，这对于检查变量值、测试代码片段非常有帮助。

如何使用调试控制台

在调试模式下，按下Ctrl+Shift+Y打开调试控制台。
你可以在控制台中输入任意的JavaScript代码，并查看执行结果。

六、集成其他调试工具

除了VSCode自带的调试工具，你还可以集成其他调试工具来增强调试功能。

集成 Mocha

如果你在项目中使用了Mocha进行单元测试，可以在launch.json文件中添加以下配置来调试Mocha测试：

{
  "type": "node",
  "request": "launch",
  "name": "调试 Mocha 测试",
  "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
  "args": [
    "--timeout",
    "999999",
    "--colors",
    "${workspaceFolder}/test"
  ],
  "internalConsoleOptions": "openOnSessionStart"
}

七、调试远程 Node.js 应用

有时候，你可能需要调试运行在远程服务器上的Node.js应用。VSCode也提供了支持远程调试的功能。

配置远程调试

在远程服务器上启动Node.js应用，并添加--inspect标志，比如node --inspect app.js。
在本地的launch.json文件中添加以下配置：

{
  "type": "node",
  "request": "attach",
  "name": "附加到远程",
  "address": "远程服务器IP",
  "port": 9229,
  "localRoot": "${workspaceFolder}",
  "remoteRoot": "/远程服务器上的项目路径"
}

使用 SSH 隧道

为了确保调试数据的安全性，你可以使用SSH隧道来进行远程调试：

在本地终端中运行以下命令，创建一个SSH隧道：

ssh -L 9229:localhost:9229 user@远程服务器IP

然后在VSCode中按照前面的步骤配置远程调试即可。

八、调试 TypeScript 项目

如果你的Node.js项目是使用TypeScript编写的，VSCode也提供了很好的支持。

配置 tsconfig.json

确保你的项目中有一个正确配置的tsconfig.json文件：

{
  "compilerOptions": {
    "outDir": "./dist",
    "sourceMap": true,
    "noImplicitAny": true,
    "module": "commonjs",
    "target": "es6",
    "allowJs": true
  }
}

配置 launch.json

在launch.json文件中，添加以下配置来调试TypeScript项目：

{
  "type": "node",
  "request": "launch",
  "name": "启动 TypeScript 程序",
  "skipFiles": ["<node_internals>/"],
  "program": "${workspaceFolder}/src/app.ts",
  "preLaunchTask": "tsc: build - tsconfig.json",
  "outFiles": ["${workspaceFolder}/dist//*.js"]
}