NestJS自定义装饰器返回undefined

基础概念

NestJS 是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的框架。它使用 TypeScript 构建，并结合了面向对象编程（OOP）、函数式编程（FP）和响应式编程（FRP）的元素。装饰器是 TypeScript 的一个特性，允许你在不修改类或方法源代码的情况下，为其添加额外的功能或元数据。

自定义装饰器

自定义装饰器是一种特殊类型的声明，可以附加到类声明、方法、访问器、属性或参数上。它们通过 @expression 的形式使用，其中 expression 必须是一个函数，该函数将在运行时被调用，并带有关于被装饰的声明的信息。

返回 undefined 的问题

当自定义装饰器返回 undefined 时，通常是因为装饰器函数没有正确地返回期望的值。这可能是由于多种原因造成的，比如装饰器逻辑错误、错误的返回类型或未处理的异常。

原因分析

装饰器逻辑错误：装饰器内部的逻辑可能不正确，导致没有返回期望的值。
错误的返回类型：装饰器可能没有返回正确的类型，或者在某些情况下没有返回任何值。
未处理的异常：装饰器内部可能抛出了异常，但没有被捕获和处理。

解决方案

以下是一个简单的示例，展示如何创建一个自定义装饰器，并确保它正确返回值：

import { createParamDecorator, ExecutionContext } from '@nestjs/common';

export const CustomDecorator = createParamDecorator(
  (data: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    // 假设我们要从请求头中获取一个值
    const value = request.headers['x-custom-header'];
    if (value) {
      return value; // 确保返回期望的值
    }
    return undefined; // 如果没有找到值，返回 undefined
  },
);

应用场景

自定义装饰器在 NestJS 中有多种应用场景，例如：

身份验证：用于检查用户是否已通过身份验证，并获取用户信息。
日志记录：用于记录方法调用或请求的信息。
参数验证：用于验证方法参数的有效性。

示例代码

以下是一个使用自定义装饰器的示例：

import { Controller, Get, UseGuards } from '@nestjs/common';
import { CustomDecorator } from './custom.decorator';

@Controller('example')
export class ExampleController {
  @Get()
  getExample(@CustomDecorator() customValue: string): string {
    return `Custom value is: ${customValue}`;
  }
}