Express 调试

Express 框架提供了强大的调试功能，帮助开发者洞悉应用内部的运作机制。想要查看 Express 的内部日志，只需在启动应用时设置 DEBUG 环境变量为 express:* 即可。

Linux/macOS 系统：

DEBUG=express:* node index.js

Windows 系统：

set DEBUG=express:* & node index.js

以 Express 生成器创建的默认应用为例，运行以上命令后，会输出类似如下的日志信息：

$ DEBUG=express:* node ./bin/www
  express:router:route new / +0ms
  express:router:layer new / +1ms
  express:router:route get / +1ms
  express:router:layer new / +0ms
  express:router:route new / +1ms
  express:router:layer new / +0ms
  express:router:route get / +0ms
  express:router:layer new / +0ms
  express:application compile etag weak +1ms
  express:application compile query parser extended +0ms
  express:application compile trust proxy false +0ms
  express:application booting in development mode +1ms
  express:router use / query +0ms
  express:router:layer new / +0ms
  express:router use / expressInit +0ms
  express:router:layer new / +0ms
  express:router use / favicon +1ms
  express:router:layer new / +0ms
  express:router use / logger +0ms
  express:router:layer new / +0ms
  express:router use / jsonParser +0ms
  express:router:layer new / +1ms
  express:router use / urlencodedParser +0ms
  express:router:layer new / +0ms
  express:router use / cookieParser +0ms
  express:router:layer new / +0ms
  express:router use / stylus +90ms
  express:router:layer new / +0ms
  express:router use / serveStatic +0ms
  express:router:layer new / +0ms
  express:router use / router +0ms
  express:router:layer new / +1ms
  express:router use /users router +0ms
  express:router:layer new /users +0ms
  express:router use / <anonymous> +0ms
  express:router:layer new / +0ms
  express:router use / <anonymous> +0ms
  express:router:layer new / +0ms
  express:router use / <anonymous> +0ms
  express:router:layer new / +0ms

这些日志详细记录了 Express 应用的各个环节，包括路由创建、中间件执行、视图渲染等。

当应用收到请求时，你还能看到 Express 代码中指定的日志，例如：

express:router dispatching GET / +4h
  express:router query  : / +2ms
  express:router expressInit  : / +0ms
  express:router favicon  : / +0ms
  express:router logger  : / +1ms
  express:router jsonParser  : / +0ms
  express:router urlencodedParser  : / +1ms
  express:router cookieParser  : / +0ms
  express:router stylus  : / +0ms
  express:router serveStatic  : / +2ms
  express:router router  : / +2ms
  express:router dispatching GET / +1ms
  express:view lookup "index.pug" +338ms
  express:view stat "/projects/example/views/index.pug" +0ms
  express:view render "/projects/example/views/index.pug" +1ms

这些信息能帮助你了解请求的处理流程，以及每个中间件的执行情况。

更精细的控制

如果你只想查看特定组件的日志，可以设置更精确的 DEBUG 值，如：

• express:router：仅显示路由相关的日志。
• express:application：仅显示应用相关的日志。
• …

使用 debug 模块调试 Express 应用

由 express 命令生成的 Express 应用内置了 debug 模块，并将其调试命名空间限定为应用的名称。

例如，如果你使用以下命令创建了名为 sample-app 的应用：

$ express sample-app

那么，可以使用以下命令启用调试语句：

$ DEBUG=sample-app:* node ./bin/www

指定多个调试命名空间

可通过逗号分隔的列表指定多个调试命名空间：

$ DEBUG=http,mail,express:* node index.js

高级选项

在 Node.js 环境中运行时，你可以设置一些环境变量来更改调试日志的行为：

名称	作用
DEBUG	启用/禁用特定的调试命名空间。
DEBUG_COLORS	是否在调试输出中使用颜色。
DEBUG_DEPTH	对象检查深度。
DEBUG_FD	将调试输出写入的文件描述符。
DEBUG_SHOW_HIDDEN	在检查对象时显示隐藏属性。

注意：以 DEBUG_ 开头的环境变量最终会转换为一个 Options 对象，该对象与 %o/%O 格式化程序一起使用。有关完整列表，请参阅 Node.js 文档中的 util.inspect() 。

通过 debug 模块和环境变量，你可以更方便地控制和查看 Express 应用的调试信息，从而更快地定位问题并进行优化。