NestJS Pino 教程：高效日志管理

1. 项目介绍

NestJS Pino 是一个基于Pino的日志库，专为NestJS框架设计。Pino是一个高性能的JSON日志记录器，提供丰富的结构化数据以及灵活的日志级别配置。通过nestjs-pino，你可以轻松地将Pino的强大功能整合到你的NestJS应用中，实现高效且可扩展的日志系统。

2. 项目快速启动

安装依赖

首先确保你已经安装了npm。然后在你的NestJS项目根目录下运行以下命令来安装nestjs-pino：

npm install --save pino nestjs-pino

配置Pino

接下来，在你的main.ts文件中引入并配置Pino：

import { NestFactory } from '@nestjs/core';
import { Logger } from 'nestjs-pino';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useLogger(app.get(Logger)); // 使用Pino作为应用的日志器
  await app.listen(3000);
}
bootstrap();

在模块中注册

导入LoggerModule并在你的主模块（如AppModule）中进行注册：

import { Module } from '@nestjs/common';
import { LoggerModule } from 'nestjs-pino';

@Module({
  imports: [
    LoggerModule.forRoot(), // 默认配置
    // 或者
    LoggerModule.forRootAsync({
      useFactory: () => ({
        level: 'info', // 自定义日志级别
      }),
    }),
  ],
  // 其他模块、提供者等
})
export class AppModule {}

使用日志服务

现在你可以通过依赖注入在服务和控制器中使用Logger：

import { Injectable, Logger } from '@nestjs/common';

@Injectable()
export class SomeService {
  private readonly logger = new Logger(SomeService.name);

  someMethod() {
    this.logger.log('这是一个日志消息');
  }
}

3. 应用案例与最佳实践

• 添加Correlation ID：在分布式系统中，跟踪请求流很有用。创建一个自定义中间件来设置和传递Correlation ID，以便所有相关日志都有相同的标识。
• 使用中间件：创建日志中间件以捕获HTTP请求和响应，以便记录请求元数据和响应时间。
• 处理异常：配置全局异常过滤器，利用Logger.error()记录详细的错误信息。
• 敏感数据脱敏：利用Pino的序列化功能，防止敏感信息（如密码、ID等）出现在日志中。

4. 典型生态项目

• @nestjs/mapped-types：用于映射类型，简化DTO到实体类的转换，使得日志中的数据更加规范。
• @nestjs/axios：优雅地集成Axios库，方便在服务中发送HTTP请求并记录请求日志。
• @nestjs/schedule：计划任务库，可以记录定时任务的执行情况。

本教程覆盖了基本的NestJS Pino配置及使用方法，更多高级特性和最佳实践可以参考项目文档或社区示例。祝你在构建高效日志系统时一切顺利！