在 Node.js 中如何使用 Visual Studio Code 调试 Express.js 应用

在 Node.js 中如何使用 Visual Studio Code 调试 Express.js 应用

Visual Studio Code 是一个非常强大的代码编辑器,而 Express.js 是一个流行的 Node.js 框架。在开发前端应用时,我们经常需要构建一个 Express.js 应用程序,并且希望能够在 VS Code 中进行调试。本文将介绍如何在 Node.js 中使用 VS Code 调试 Express.js 应用程序。

步骤一:安装必要的软件

首先需要安装以下几个必要的软件:

Node.js:https://nodejs.org/ Visual Studio Code:https://code.visualstudio.com/ Express.js:https://expressjs.com/

步骤二:创建一个 Express.js 应用程序

在安装 Express.js 之后,我们可以使用以下命令创建一个新的 Express.js 应用程序:

$ npm install -g express-generator
$ express myapp
$ cd myapp
$ npm install

这些命令将创建一个名为 myapp 的新 Express.js 应用程序,并安装所有必要的依赖项。

步骤三:在 VS Code 中打开应用程序

使用以下命令打开 VS Code:

$ code .

这将在当前目录下打开 VS Code。然后,在 VS Code 中打开 myapp 文件夹。

步骤四:配置 VS Code 的调试器

首先,我们需要在 VS Code 中安装 Node.js 调试器。在 VS Code 的侧边栏中,点击左侧的扩展配置按钮,搜索并安装名称为“Node.js 调试器”的插件。

接下来,我们需要在 VS Code 中创建一个调试配置。点击 VS Code 的侧边栏中的调试按钮,然后在配置的下拉菜单中选择“添加配置”。

在打开的 launch.json 文件中,可以看到该文件中的默认配置。如果没找到该文件,则需要在 VS Code 中找到“调试”->“添加配置”,创建一个新的配置。

更新该文件中的 configuration 属性如下:

{
    "type": "node",
    "request": "launch",
    "name": "Launch via NPM",
    "runtimeExecutable": "npm",
    "runtimeArgs": [
        "run-script",
        "debug"
    ],
    "port": 9229,
    "outputCapture": "std"
}

该配置将使用 NPM 执行脚本“debug”并将其附加到端口 9229。

步骤五:添加调试信息到应用程序

在 myapp 的主要 JavaScript 文件(通常是 app.js 或 index.js)的第一行添加以下代码:

const debug = require('debug')('myapp:app');

这将启用一个名为“myapp:app”的调试器,并将其添加到 myapp 应用程序中。

步骤六:在 VS Code 中启动应用程序

在命令行中,使用以下命令启动应用程序:

$ npm run debug

这将使用在步骤四中定义的调试配置启动应用程序。

步骤七:在 VS Code 中调试应用程序

在 VS Code 中,点击调试按钮,然后在 VS Code 的侧边栏中选择“启动 NPM”。这将启动 Node.js 应用程序,并连接到 Node.js 调试器。

然后,你可以在你的代码中设置断点,以开始按步骤调试代码。

示例代码:

以下是一个简单的 Express.js 应用程序,包括一个路由和一个中间件函数:

const express = require('express');
const debug = require('debug')('myapp:app');

const app = express();

app.use((req, res, next) => {
    debug('Request:', req.method, req.url);
    next();
});

app.get('/', (req, res) => {
    res.send('Hello World!');
});

app.listen(3000, () => {
    debug('Server listening on port 3000');
});

需要注意的是,为了便于调试,我们使用了 debug 库来记录请求和服务器日志。在本地环境中使用这样的日志库非常有用,以便更轻松地诊断代码中的问题。

总结:

本文介绍了如何在 Node.js 中使用 VS Code 调试 Express.js 应用程序。我们讨论了必要的软件,创建了一个 Express.js 应用程序,配置了 VS Code 的调试器,并添加了调试信息到应用程序中。在 VS Code 中启动应用程序后,可以使用断点开始按步骤调试代码。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/65ac8087add4f0e0ff614a27