超燃！NestJS博客实战04-解锁自定义Log日志模块！

2023-04-17 16:35:41

自定义NestJS日志模块：提升日志记录和异常捕获能力

在构建健壮且可维护的NestJS应用程序时，日志记录和异常捕获至关重要。本文将深入探讨如何创建自定义日志模块，从而简化程序日志捕获和显示，增强异常管理功能。

定义自定义日志模块：构建日志记录基础

1. 创建自定义日志模块

// custom-logger.module.ts
import { Module } from '@nestjs/common';
import { CustomLoggerService } from './custom-logger.service';

@Module({
  providers: [CustomLoggerService],
  exports: [CustomLoggerService],
})
export class CustomLoggerModule {}

2. 定义自定义日志服务

// custom-logger.service.ts
import { Injectable, LoggerService } from '@nestjs/common';

@Injectable()
export class CustomLoggerService implements LoggerService {
  private readonly logger = new Logger('CustomLoggerService');

  log(message: any, ...optionalParams: any[]) {
    this.logger.log(message, optionalParams);
  }

  error(message: any, ...optionalParams: any[]) {
    this.logger.error(message, optionalParams);
  }

  warn(message: any, ...optionalParams: any[]) {
    this.logger.warn(message, optionalParams);
  }

  debug(message: any, ...optionalParams: any[]) {
    this.logger.debug(message, optionalParams);
  }

  verbose(message: any, ...optionalParams: any[]) {
    this.logger.verbose(message, optionalParams);
  }
}

引入自定义日志模块：将日志记录功能纳入应用程序

// app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { CustomLoggerModule } from './custom-logger/custom-logger.module';

@Module({
  imports: [CustomLoggerModule],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

使用自定义日志模块：捕获和显示日志消息

// app.controller.ts
import { Controller, Get, UseFilters } from '@nestjs/common';
import { AppService } from './app.service';
import { CustomLoggerService } from './custom-logger/custom-logger.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService, private readonly logger: CustomLoggerService) {}

  @Get()
  getHello(): string {
    this.logger.log('This is a log message.');
    this.logger.error('This is an error message.');
    this.logger.warn('This is a warning message.');
    this.logger.debug('This is a debug message.');
    this.logger.verbose('This is a verbose message.');
    return this.appService.getHello();
  }
}