NestJS在拦截器中设置HttpStatus

时间:2019-03-28 20:16:50

标签: javascript node.js typescript nestjs fastify

我正在使用拦截器来转换我的响应。我想在内部设置HttpStatus,但现在使用的代码不起作用。

import { CallHandler, ExecutionContext, NestInterceptor, SetMetadata } from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
import { classToPlain } from 'class-transformer';
import { ApiResponse } from '../models/apiResponse';

export class TransformInterceptor implements NestInterceptor {
  intercept(
    context: ExecutionContext,
    next: CallHandler<ApiResponse | any>,
  ): Observable<ApiResponse | any> {
    return next.handle().pipe(
      map(data => {
        const http = context.switchToHttp();
        const res = http.getResponse();

        if(data instanceof ApiResponse) {
          if(data.status !== undefined) {
            res.status(data.status);
          }
        }

        return classToPlain(data);
      }),
    );
  }
}

1 个答案:

答案 0 :(得分:0)

无法通过拦截器设置状态代码(请参见issue),因为:

  
      
  • 有时响应状态代码取决于异常,并且在拦截器之后执行异常过滤器,
  •   
  • 全局响应控制器的逻辑是在通过网络发送最终结果之前的最后一步(即   默认状态代码出现的位置。)
  •   

因此,您的状态代码将被默认代码200/201或异常过滤器覆盖。


作为一种(棘手的)解决方法,您可以使用异常过滤器在拦截器中设置状态代码:

1)创建自己的异常作为HttpException的包装器:

export class StatusException extends HttpException {
  constructor(data, status: HttpStatus) {
    super(data, status);
  }
}

2)创建一个用于设置响应代码并返回数据的异常过滤器:

@Catch(StatusException)
export class StatusFilter implements ExceptionFilter {
  catch(exception: StatusException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const status = exception.getStatus();
    console.log(`Setting status to ${status}`);
    response.status(status).json(exception.message);
  }
}

3)不是设置响应,而是在拦截器中抛出相应的异常:

@Injectable()
export class StatusInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next): Observable<any> {
    return next.handle().pipe(
      map((data: any) => {
        if (data.text === 'created') {
          throw new StatusException(data, HttpStatus.CREATED);
        } else {
          throw new StatusException(data, HttpStatus.ACCEPTED);
        }
      }),
    );
  }
}

4)在您的控制器中使用它:

@UseFilters(StatusFilter)
@UseInterceptors(StatusInterceptor)
@Controller()
export class AppController {
  @Get(':param')
  async get(@Param('param') param) {
    return { text: param };
  }
}

或者,您可以在控制器中注入@Res()并直接控制响应代码(但也可以丢失拦截器,异常过滤器等)