Nest.js 系列：装饰器深潜与自定义装饰器

后端

2024-01-21 05:37:25

Nest.js中的装饰器：揭示其功能和自定义

Nest.js 中的常用装饰器
自定义装饰器
结语
常见问题解答

Nest.js中的常用装饰器

在Nest.js框架中，装饰器扮演着至关重要的角色。它们允许您通过在类、方法或属性上附加元数据来扩展其功能。Nest.js内置了许多有用的装饰器，其中一些最常见的包括：

@Controller(): 用于标识控制器类，负责处理请求并返回响应。
@Get(), @Post(), @Put(), @Delete(): 用于设置控制器的路由，指定HTTP方法和路由路径。
@Service(): 用于标记服务类，提供业务逻辑和数据访问。
@Inject(): 用于将服务注入到控制器或其他类中，实现依赖关系注入。
@Middleware(): 用于注册中间件，在处理请求和返回响应之前或之后执行特定操作。
@ValidationPipe(): 用于验证传入数据的有效性，确保其符合预期格式和约束。
@Logger(): 用于记录日志信息，帮助调试和故障排除。
@Cache(): 用于缓存数据，提高性能和减少数据库查询。

自定义装饰器

除了使用内置的装饰器外，您还可以创建自己的自定义装饰器，以满足您的特定需求。Nest.js提供了三种方式来定义自定义装饰器：

1. 使用@Decorator装饰器

@Injectable()
export class CustomDecoratorService {
  createDecorator(metadataKey: string, metadataValue: any) {
    return createParamDecorator((data: unknown, ctx: ExecutionContext) => {
      const request = ctx.switchToHttp().getRequest();
      return request[metadataKey][metadataValue];
    });
  }
}

2. 使用工厂函数

export const CustomDecorator = createParamDecorator((data: unknown, ctx: ExecutionContext) => {
  const request = ctx.switchToHttp().getRequest();
  return request.customData;
});

3. 使用装饰器表达式

export const CustomDecorator = (metadataKey: string, metadataValue: any) => {
  return (data: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    return request[metadataKey][metadataValue];
  };
};