node.js中debug模块的简单介绍与使用

简介

Debug是Node.js的一个核心模块，用于提供调试支持。它提供了一种比console.log()更方便的打印调试信息的方式，并支持控制调试输出级别。

安装

Debug模块是Node.js的核心模块，无需安装。

使用

先在js文件中引入debug模块：

const debug = require('debug')('my-app')

这里的参数'my-app'是一个命名空间，可用于区分不同的调试输出。可以在后面的代码中多次使用该命名空间，也可以在终端使用该命令行参数过滤调试输出。

在代码中使用debug()函数打印调试信息，如：

debug('hello, debug')

如果在终端使用DEBUG=my-app node app.js命令运行文件，则会输出调试信息：

my-app hello, debug

如果使用DEBUG=*或未设置DEBUG环境变量，则所有调试信息都会被输出。

下面是一个简单的示例，通过设置不同的命名空间，演示了如何过滤特定的调试信息：

const debug1 = require('debug')('app:debug1')
const debug2 = require('debug')('app:debug2')

debug1('This is debug1 message!')
debug2('This is debug2 message!')

运行该脚本时，不会输出任何调试信息。但是如果在终端输入DEBUG=app:* node app.js，则会输出形如app:debug1 This is debug1 message!的信息。同样，如果只想输出app:debug1的调试信息，可在终端输入DEBUG=app:debug1 node app.js。

示例

示例1：在HTTP请求处理函数中使用debug模块打印调试信息

const http = require('http')
const debug = require('debug')('http')

const server = http.createServer((req, res) => {
  debug(req.method, req.url)
  res.end('Hello World!')
})
server.listen(3000, () => {
  console.log('Server listening on port 3000')
})

示例2：应用中使用debug模块打印调试信息

const debug = require('debug')('my-app')
const chalk = require('chalk')

const { sum } = require('./math')

debug('Start of the app')
console.log(chalk.green('2 + 3='), sum(2, 3))
debug('End of the app')

在终端输入DEBUG=my-app node app.js后，输出结果：

my-app Start of the app +0ms
my-app End of the app +6ms