NestJS 中高效日志库的使用：记录请求与响应，快速定位性能瓶颈

引言

在开发复杂的后端应用时，日志记录是调试和性能优化的关键工具。NestJS 作为基于 Node.js 的框架，提供了强大的日志功能，但如何高效地使用日志库，记录请求与响应的详细信息，并快速定位性能瓶颈，是每个开发者都需要掌握的技能。本文将深入探讨如何在 NestJS 中使用高效的日志库（如 winston 或 pino），并提供具体的代码示例和配置步骤。

为什么需要高效的日志记录？

1. 调试问题：日志可以帮助开发者快速定位问题，尤其是在生产环境中。
2. 性能监控：通过记录请求和响应的时间，可以识别性能瓶颈。
3. 审计与安全：详细的日志可以用于审计和安全分析。

选择合适的日志库

NestJS 默认使用 Logger 服务，但它的功能相对基础。对于更复杂的需求，我们可以选择以下日志库：

• Winston：功能强大，支持多种日志格式和传输方式。
• Pino：性能极高，适合高并发场景。

使用 Winston 记录请求与响应

安装 Winston

npm install winston

创建日志配置

import { createLogger, format, transports } from 'winston';

const logger = createLogger({
  level: 'info',
  format: format.combine(
    format.timestamp(),
    format.json()
  ),
  transports: [
    new transports.Console(),
    new transports.File({ filename: 'combined.log' })
  ]
});

export default logger;

在中间件中使用

import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response } from 'express';
import logger from './logger';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: Function) {
    const start = Date.now();
    res.on('finish', () => {
      const duration = Date.now() - start;
      logger.info({
        method: req.method,
        url: req.url,
        status: res.statusCode,
        duration: `${duration}ms`
      });
    });
    next();
  }
}

使用 Pino 记录请求与响应

安装 Pino

npm install pino

创建日志配置

import pino from 'pino';

const logger = pino({
  level: 'info',
  transport: {
    target: 'pino-pretty',
    options: {
      colorize: true
    }
  }
});

export default logger;

在中间件中使用

import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response } from 'express';
import logger from './logger';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: Function) {
    const start = Date.now();
    res.on('finish', () => {
      const duration = Date.now() - start;
      logger.info({
        method: req.method,
        url: req.url,
        status: res.statusCode,
        duration: `${duration}ms`
      });
    });
    next();
  }
}

性能优化实践

1. 异步日志记录：使用异步传输方式（如 winston 的 AsyncTransport）减少日志记录对主线程的影响。
2. 结构化日志：将日志格式化为 JSON，便于后续分析和查询。
3. 日志轮转：使用 winston-daily-rotate-file 或类似工具，避免日志文件过大。

总结

高效的日志记录是 NestJS 开发中不可或缺的一部分。通过合理配置和使用日志库，开发者可以快速定位性能瓶颈，提高应用的稳定性和可维护性。希望本文的内容能帮助你在实际项目中更好地应用日志功能。