自定义路由参数装饰器

Nest 是基于 装饰器 这种语言特性而创建的。在很多常用的编程语言中 装饰器 都是一个很大众的概念,但在 JavaScript 语言中这个概念却比较新。所以为了更好地理解装饰器是如何工作的,你应该看看 这篇 文章。下面给出一个简单的定义:

ES2016 的装饰器是一个可以将目标对象,名称和属性描述符作为被修饰方法(returns function)的参数的表达式。你可以通过装饰器前缀 @ 来使用它,并且把它放在你试图装饰的最上面。装饰器可以被定义为一个类或是属性。

Nest 提供了一组有用的参数装饰器,可以和 HTTP 路由处理器(route handlers)一起使用。下面是一组装饰器和普通表达式对象的对照。

@Request() req
@Response() res
@Next() next
@Session() req.session
Param(param?: string) req.params / req.params[param]
@Body(param?: string) req.body / req.body[param]
@@Query(param?: string) req.query / req.query[param]
@Headers(param?: string)           req.headers / req.headers[param]       

另外,你还可以创建你自己的自定义装饰器。为什么它很有用呢?

在 node.js 的世界中,把属性值附加到 request 对象中是一种很常见的做法。然后你可以在任何时候在路由处理程器(route handlers)中手动取到它们,例如,使用下面这个构造:

  1. const user = req.user;

为了更加方便和透明地做到这一点,我们可以创建 @User() 装饰器并且在所有控制器中重复利用它。

user.decorator.ts

  1. import { createRouteParamDecorator } from '@nestjs/common';
  2. export const User = createRouteParamDecorator((data, req) => {
  3. return req.user;
  4. });

现在你可以在任何你想要的地方很方便地使用它。

  1. @Get()
  2. async findOne(@User() user: UserEntity) {
  3. console.log(user);
  4. }

传递数据(Passing data)

当你的装饰器的行为依赖于某些条件时,你可以使用 data 给装饰器的工厂函数传参。例如,下面的构造:

  1. @Get()
  2. async findOne(@User('test') user: UserEntity) {
  3. console.log(user);
  4. }

可以通过 data 访问传进来的 test 字符串:

user.decorator.ts

  1. import { createParamDecorator } from '@nestjs/common';
  2. export const User = createParamDecorator((data, req) => {
  3. console.log(data); // test
  4. return req.user;
  5. });

管道(Pipes)

Nest 对待自定义的路由参数装饰器和这些内置的装饰器(@Body(),@Param() 和 @Query())一样。这意味着管道也会因为自定义注释参数(在本例中为 user 参数)而被执行。此外,你还可以直接将管道应用到自定义装饰器上:

  1. @Get()
  2. async findOne(@User(new ValidationPipe()) user: UserEntity) {
  3. console.log(user);
  4. }