为什么Node.js项目需要规范的日志记录
在Node.js应用运行过程中，难免会出现接口报错、业务逻辑异常、性能瓶颈等问题，仅靠控制台打印的临时信息很难快速定位问题。规范的日志记录可以持久化保存运行过程中的关键信息，还能按照不同级别分类，方便后续排查和监控。同时，统一的日志格式也便于对接日志分析工具，提升项目的运维效率。
常见的Node.js日志库选择
Node.js生态中有不少成熟的日志库，开发者可以根据项目规模和需求选择：
- winston：功能全面的主流日志库，支持多传输方式、自定义格式、日志分级，适配各种规模的项目
- morgan：专注于HTTP请求日志的中间件，常和Express框架搭配使用，记录接口请求的相关信息
- pino：性能优异的日志库，输出速度快，适合对性能要求较高的高并发场景
使用winston实现基础日志记录
winston是最常用的Node.js日志库，下面演示基础的使用方式：
// 引入winston库
const winston = require('winston');
// 创建logger实例，配置日志分级和输出方式
const logger = winston.createLogger({
level: 'info', // 设置默认日志级别，低于该级别的日志不会输出
format: winston.format.combine(
winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), // 添加时间戳
winston.format.printf(({ level, message, timestamp }) => {
return `${timestamp} [${level.toUpperCase()}]: ${message}`; // 自定义输出格式
})
),
transports: [
new winston.transports.Console(), // 输出到控制台
new winston.transports.File({ filename: 'app.log' }) // 输出到文件
]
});
// 不同级别的日志输出
logger.error('这是一条错误日志，比如接口调用失败');
logger.warn('这是一条警告日志，比如请求参数异常');
logger.info('这是一条信息日志，比如服务启动成功');
logger.debug('这是一条调试日志，比如变量当前值');结合morgan记录HTTP请求日志
如果是Express框架的项目，可以搭配morgan记录所有接口的访问情况：
const express = require('express');
const morgan = require('morgan');
const winston = require('winston');
const app = express();
// 创建写入访问日志的stream，对接winston的文件传输
const accessLogStream = {
write: (message) => {
logger.info(`HTTP请求: ${message.trim()}`);
}
};
// 使用morgan中间件，自定义输出格式
app.use(morgan(':method :url :status :response-time ms - :res[content-length]', { stream: accessLogStream }));
app.get('/test', (req, res) => {
res.send('测试接口');
});
app.listen(3000, () => {
logger.info('服务启动在3000端口');
});日志分级与多环境适配
实际项目中需要根据环境调整日志级别，比如开发环境输出debug级别的日志方便调试，生产环境只输出info及以上级别的日志减少性能开销：
// 根据环境变量设置日志级别
const logLevel = process.env.NODE_ENV === 'production' ? 'info' : 'debug';
const logger = winston.createLogger({
level: logLevel,
format: winston.format.combine(
winston.format.timestamp(),
winston.format.json() // 生产环境可以用json格式，方便日志分析工具解析
),
transports: [
new winston.transports.Console(),
new winston.transports.File({ filename: 'error.log', level: 'error' }), // 错误日志单独存文件
new winston.transports.File({ filename: 'combined.log' })
]
});日志记录的注意事项
- 不要在日志中记录敏感信息，比如用户密码、身份证号、支付密钥等
- 合理设置日志级别，避免输出过多无用信息占用磁盘空间
- 定期清理过期日志，防止日志文件过大影响服务器性能
- 如果是分布式项目，可以考虑把日志统一上报到日志服务，方便集中查询