Nodejs Nestjs日志记录插件@nestjs/morgan的使用

Nodejs Nestjs日志记录插件@nestjs/morgan的使用
[@nestjs](/user/nestjs)/morgan 是一个用于 NestJS 应用程序的日志记录中间件，它基于 morgan。morgan 是一个流行的 HTTP 请求日志记录工具，适用于 Node.js 的 Express 框架。下面是如何在 NestJS 项目中使用 [@nestjs](/user/nestjs)/morgan 插件。

安装

首先，你需要安装必要的包：

npm install [@nestjs](/user/nestjs)/common [@nestjs](/user/nestjs)/core [@nestjs](/user/nestjs)/morgan morgan

配置 Morgan 中间件

接下来，你需要在你的 NestJS 应用程序中配置 Morgan 中间件。这通常在主模块（通常是 AppModule）中完成，但更推荐的方式是在单独的中间件模块中进行配置，以保持项目的整洁。

创建中间件模块

创建一个新的模块，例如 LoggerModule，在这个模块中配置 Morgan 中间件：

import { Module, NestModule, MiddlewareConsumer } from '[@nestjs](/user/nestjs)/common';
import * as morgan from 'morgan';

@Module({
  // 这里可以添加其他需要的模块
})
export class LoggerModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(morgan('combined'))
      .forRoutes('*');
  }
}

这里我们使用了 morgan('combined')，它会提供一个标准的 Apache Combined 日志格式。你也可以选择其他格式，如 'tiny', 'short', 'dev' 等，具体取决于你的需求。

在应用程序中启用 LoggerModule

确保在你的主要应用模块（通常是 AppModule）中导入并使用这个新的 LoggerModule：

import { Module } from '[@nestjs](/user/nestjs)/common';
import { LoggerModule } from './logger/logger.module'; // 假设 LoggerModule 在 logger 文件夹中

@Module({
  imports: [
    // 其他模块
    LoggerModule,
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

测试

启动你的 NestJS 应用程序，并发送一些请求到服务器。你应该能够在控制台看到请求日志输出。

注意事项

• 确保在生产环境中不要使用开发模式的日志格式（如 'dev'），因为它可能会泄露敏感信息。
• 如果你使用的是反向代理（如 Nginx），可能需要调整日志记录策略，避免重复记录日志。

通过上述步骤，你应该能够成功地在 NestJS 应用程序中集成和使用 [@nestjs](/user/nestjs)/morgan 插件来记录 HTTP 请求日志。