断点调试 nest 项目

背景

说起项目调试，我们最常使用的方式就是console.log，但是对于服务端项目，仅仅使用 console.log 是远远不够的，况且 console.log 的功能很弱，想知道代码运行路线，想让代码在某一行断住，实时查看某个变量的值...很困难，甚至无法实现，所以会使用 debugger 调试时一名合格程序员必备的技能之一

提示

调试原生 js 文件运行可以看另一篇文章 js 代码断点调试方法

调试 nest.js 项目，由多种方式，这里介绍两种，一种借助 chrome 的 inspect 进行调试，一种直接在 vscode 内调试

`chrome://inspect`

在需要打断点的地方加上degubber关键字

import { Controller, Get, ParseIntPipe, Query } from "@nestjs/common";
import { AppService } from "./app.service";

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }

  @Get("getOne")
  getOne(@Query("id", ParseIntPipe) id: number) {
    debugger; 
    console.log(typeof id);
    return this.appService.getPersonOne(id);
  }
}

运行 nest 项目，带上--debug参数，例如 npm run start:debug

bash

"start:debug": "nest start --debug --watch",

nest start 命令提供的 --debug参数的原理就是 node --inspect，--inspect 并不会和 --inspect-brk 一样在首行断住，所以需要在需要 debugger 关键字的帮助

nest 项目启动后的结果（重点为高亮部分）：

bash

Debugger listening on ws://127.0.0.1:9229/47453ade-d66f-40a4-87fd-18d3fd15c744  // [!code warning]
For help, see: https://nodejs.org/en/docs/inspector // [!code warning]
[Nest] 11984  - 2024/07/28 21:14:31     LOG [NestFactory] Starting Nest application...
[Nest] 11984  - 2024/07/28 21:14:31     LOG [InstanceLoader] PersonModule dependencies initialized +7ms
|

这时候就说明可以在 chrome 的 devTools 内调试 nestjs 项目了

在 chrome 打开 chrome://inspect
访问相关接口

vscode 调试（推荐）

在 vscode 开发 nest 项目，当然首选在编辑器内调试，更方便

VSCode 也实现了 Debugger 的客户端。

创建 .vscode/launch.json 文件点击调试面板的 create launch.json file，它会创建 .vscode/launch.json 的调试配置文件：
修改内容新增或者修改 configurations 内容

json

{
  "type": "node",
  "request": "launch",
  "name": "debug nest",
  "runtimeExecutable": "npm",
  "args": ["run", "start:dev"],
  "skipFiles": ["<node_internals>/**"],
  "console": "integratedTerminal"
}