理解 Nest.js 中的 Metadata 和 Reflector

BUG高级开发工程师
1,308 阅读2分钟

理解 Nest.js 中的 Metadata 和 Reflector

在 Nest.js 中，Metadata 是通过装饰器来实现的，它包含了对应类、方法、属性和参数等的数据。而 Reflector 可以用于检索和解析这些元数据。

Metadata

在 Nest.js 中，Metadata 可以用于添加自定义的元数据以及与依赖注入有关的信息。在构建一个 Nest.js 应用程序时，开发者可以使用不同的装饰器来添加元数据。

下面是一些常见的元数据装饰器：

  • @Controller()：指定一个控制器类，并且可以设置控制器的基本配置。
  • @Injectable()：指定一个可注入的服务类，并且可以设置该服务的基本配置。
  • @Param()：将路由参数注入到控制器方法中。
  • @Body()：将请求体注入到控制器方法中。
  • @Query()：将查询参数注入到控制器方法中。
  • @Header()：将请求头注入到控制器方法中。

这些装饰器可以为 Nest.js 应用程序添加丰富的元数据，以及提供依赖注入的支持。

Reflector

Nest.js 中的 Reflector 可以用于检索和解析元数据。在 Nest.js 中，Reflector 可以轻松地从装饰器中读取元数据信息，并根据需要进行操作。

下面是一些常见的 Reflector 用法：

  • Reflector.getMetadata(metadataKey: string, target: object)：获取指定目标上的元数据。
  • Reflector.getMetadata(metadataKey: string, target: object, propertyKey: string | symbol)：获取指定目标和属性上的元数据。
  • Reflector.getMetadata(metadataKey: string, target: object, propertyKey: string | symbol, parameterIndex: number)：获取指定目标、属性和参数索引上的元数据。

使用 Reflector 函数，可以方便地检索和解析装饰器中定义的元数据，并将其用于处理依赖注入、路由处理等方面。

示例

以下是一个示例，展示如何在 Nest.js 中使用 Metadata 和 Reflector：

import { Controller, Get, ReflectMetadata } from '@nestjs/common';

@Controller('cats')
@ReflectMetadata('roles', ['admin'])
export class CatsController {
  @Get()
  findAll() {
    return 'This action returns all cats';
  }
}

在上述示例中，我们定义了一个 CatsController 类，并在类上使用了 @Controller('cats') 装饰器来指定控制器路径。我们还在类上使用了 @ReflectMetadata('roles', ['admin']) 装饰器来添加自定义的元数据信息。

这样，我们就可以使用 Reflector 函数来检索该元数据：

import { Reflector } from '@nestjs/core';

const roles = Reflector.getMetadata('roles', CatsController);
console.log(roles); // ['admin']

在上述示例中，我们使用 Reflector.getMetadata() 函数来获取 CatsController 类上的 roles 元数据信息，并将其输出到控制台上。

总结

在 Nest.js 中，Metadata 和 Reflector 是非常有用的功能，可以帮助开发者快速获得元数据，并进行依赖注入、路由处理等操作。希望这篇文章对您理解 Nest.js 中 Metadata 和 Reflector 的使用有所帮助。

avatar
文章
阅读
粉丝