ExpressJS - 调试

Express.js - 调试技巧

调试是每个开发人员的关键技能。在 Node.js 和 Express 环境中，你可以使用多种强大的工具和技术来查找和修复问题，从简单的控制台日志到复杂的集成调试器。

1. 使用 `debug` 模块

Express 是基于流行的 debug 模块构建的，它允许你通过设置环境变量来查看内部日志信息。这对于理解 Express 如何处理请求、匹配路由和执行中间件非常有用。

要启用调试日志，请在启动应用程序时设置 DEBUG 环境变量。你不需要单独安装 debug，因为它是 Express 的一个依赖项。

启用调试日志

该命令因操作系统的 shell 而异：

**Linux/macOS：** export DEBUG=express:* && node index.js
**Windows (PowerShell)：** $env:DEBUG='express:*'; node index.js
**Windows (CMD)：** set DEBUG=express:* && node index.js

一个跨平台的解决方案是使用 cross-env 包。首先，安装它： npm install --save-dev cross-env

然后，在你的 package.json 中添加一个脚本：

"scripts": {
  "start:dev": "cross-env DEBUG=express:* nodemon index.js"
}

现在你可以在任何操作系统上运行 npm run start:dev。* 是一个通配符，它会启用 express 命名空间下的所有日志。你将看到关于路由、中间件执行等详细输出。

过滤日志

为了减少干扰，你可以指定要调试 Express 的哪些部分。例如，只查看路由和应用程序级别的日志：

cross-env DEBUG=express:router,express:application nodemon index.js

2. 经典的 `console.log`

永远不要低估简单的 console.log() 的威力。它是检查变量值、查看某段代码是否正在执行或检查 req 和 res 对象内容的快捷方式。

app.get('/users/:id', (req, res) => {
    console.log('--- 新请求 ---');
    console.log('路由参数：', req.params);
    console.log('查询字符串：', req.query);

    const { id } = req.params;
    res.send(`用户 ID 的个人资料: ${id}`);
});

专家提示：使用 console.dir(object, { depth: null }) 来打印大型对象的完整内容，而不会被截断。

3. 集成调试器 (VS Code)

对于更复杂的问题，使用单步调试器是最有效的方法。它允许你暂停代码执行、检查变量并逐行调试逻辑。Visual Studio Code 对 Node.js 调试有出色的内置支持。

设置步骤：

在 VS Code 中打开“运行和调试”面板 (Ctrl+Shift+D)。
点击“创建 launch.json 文件”并选择“Node.js”。
这将在 .vscode 目录中生成一个 launch.json 文件。

示例 `launch.json` 配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Express App",
            "program": "${workspaceFolder}/index.js",
            "restart": true,
            "runtimeExecutable": "nodemon",
            "console": "integratedTerminal"
        }
    ]
}

此配置告诉 VS Code 使用 nodemon 启动你的应用程序以实现自动重启。现在你可以：

通过点击代码行号旁边的空白区域设置断点。
按 F5 启动调试器。
向你的服务器发送请求（例如，从浏览器或 API 客户端）。
执行将在你的断点处暂停，允许你检查程序状态。