debug 是做什么的?
调试包使用指南。用于添加调试日志、理解日志命名空间或实现调试功能。当遇到调试日志请求或日志实现时触发。
概述
debug 包是一个小型但功能强大的 JavaScript 调试工具,受 Node.js 核心调试技术启发。它允许您通过命名空间启用或禁用特定模块的日志输出。
安装
npm install debug
基本用法
const debug = require('debug');
const log = debug('myapp:server');
const error = debug('myapp:error');
log('服务器启动中...');
error('数据库连接失败');
命名空间
命名空间以冒号分隔的层级结构组织日志:
myapp:*- 匹配所有 myapp 命名空间myapp:server- 仅匹配服务器日志myapp:-server- 排除服务器日志*- 匹配所有命名空间
启用日志
通过环境变量 (Node.js)
DEBUG=myapp:* node app.js
通过 localStorage (浏览器)
localStorage.debug = 'myapp:*';
高级功能
- 命名空间通配符支持 (
*和?) - 排除特定命名空间 (使用
-前缀) - 颜色编码输出
- 时间戳和格式化
最佳实践
- 使用有意义的命名空间名称,如
app:module:function - 不要在控制语句中调用调试函数,以避免性能问题
- 在部署到生产环境前禁用所有调试日志
- 利用命名空间组合进行精细控制