NestJS -在拦截器(非全局拦截器)内部使用服务

基础概念

NestJS 是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的框架。它基于 Express.js 和 Fastify，并且使用了现代 JavaScript 或 TypeScript。拦截器（Interceptor）是 NestJS 中的一个核心概念，允许你在方法调用前后执行自定义逻辑。

类型与应用场景

类型

全局拦截器：应用于整个应用程序的所有请求。
控制器拦截器：应用于特定控制器的所有方法。
方法拦截器：仅应用于单个方法。

应用场景

日志记录：记录请求和响应的详细信息。
身份验证：在处理请求前验证用户身份。
数据转换：在发送响应前格式化数据。
异常处理：统一处理控制器中的异常。

在拦截器内部使用服务

在 NestJS 中，拦截器可以注入并使用服务。以下是如何在非全局拦截器内部使用服务的示例：

示例代码

假设我们有一个 LoggingService 用于记录日志：

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

@Injectable()
export class LoggingService {
  log(message: string) {
    console.log(`[LOG]: ${message}`);
  }
}

接下来，创建一个拦截器 LoggingInterceptor 并在其中使用 LoggingService：

import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { tap } from 'rxjs/operators';
import { LoggingService } from './logging.service';

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
  constructor(private readonly loggingService: LoggingService) {}

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const now = Date.now();
    return next
      .handle()
      .pipe(
        tap(() => {
          this.loggingService.log(`${context.getClass().name}.${context.getHandler().name} ${Date.now() - now}ms`);
        }),
      );
  }
}

在控制器中使用这个拦截器：

import { Controller, Get, UseInterceptors } from '@nestjs/common';
import { LoggingInterceptor } from './logging.interceptor';
import { LoggingService } from './logging.service';

@Controller('example')
export class ExampleController {
  constructor(private readonly loggingService: LoggingService) {}

  @Get()
  @UseInterceptors(new LoggingInterceptor(this.loggingService))
  getExample() {
    return 'This is an example response';
  }
}

遇到的问题及解决方法

问题：拦截器无法注入服务

原因：可能是因为拦截器没有正确地通过依赖注入获取服务实例。

解决方法：

确保 LoggingService 已经在模块中声明并提供。
在拦截器构造函数中正确注入服务。

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
  constructor(private readonly loggingService: LoggingService) {}
  // ...
}

如果使用模块化的方式，确保在模块中导入并提供 LoggingService：

import { Module } from '@nestjs/common';
import { ExampleController } from './example.controller';
import { LoggingInterceptor } from './logging.interceptor';
import { LoggingService } from './logging.service';

@Module({
  controllers: [ExampleController],
  providers: [LoggingService, LoggingInterceptor],
})
export class ExampleModule {}

通过以上步骤，可以确保拦截器能够正确地使用服务，并在方法调用前后执行自定义逻辑。