Nest如何自定义装饰器

Nest 内置了很多装饰器，大多数功能都是通过装饰器来使用的。

但当这些装饰器都不满足需求的时候，能不能自己开发呢？

装饰器比较多的时候，能不能把多个装饰器合并成一个呢？

自然是可以的。

很多内置装饰器我们都可以自己实现。

我们来试试看：

nest new custom-decorator -p npm

创建个 nest 项目。

执行

nest g decorator aaa --flat

创建个 decorator。

这个装饰器就是自定义的装饰器。

之前我们是这样用的 @SetMetadata

然后加个 Guard 取出来做一些判断：

nest g guard aaa --flat --no-spec

# 示例：设置 metadata

guard 里使用 reflector 来取 metadata：

import { CanActivate, ExecutionContext, Inject, Injectable } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { Observable } from 'rxjs';

@Injectable()
export class AaaGuard implements CanActivate {
  @Inject(Reflector)
  private reflector: Reflector;

  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {

    console.log(this.reflector.get('aaa', context.getHandler()));

    return true;
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

加到路由上：

把服务跑起来：

npm run start:dev

然后访问 http://localhost:3000 可以看到打印的 metadata

但是不同 metadata 有不同的业务场景，有的是用于权限的，有的是用于其他场景的。

但现在都用 @SetMetadata 来设置太原始了。

这时候就可以这样封装一层：

# 封装 metadata 装饰器

装饰器就可以简化成这样：

还有，有没有觉得现在装饰器太多了，能不能合并成一个呢？

当然也是可以的。

这样写：

# 合并多个装饰器

import { applyDecorators, Get, UseGuards } from '@nestjs/common';
import { Aaa } from './aaa.decorator';
import { AaaGuard } from './aaa.guard';

export function Bbb(path, role) {
  return applyDecorators(
    Get(path),
    Aaa(role),
    UseGuards(AaaGuard)
  )
}

1
2
3
4
5
6
7
8
9
10
11

在自定义装饰器里通过 applyDecorators 调用其他装饰器。

这三个 handler 的装饰器都是一样的效果。

这就是自定义方法装饰器。

# 自定义参数装饰器

此外，也可以自定义参数装饰器：

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

export const Ccc = createParamDecorator(
  (data: string, ctx: ExecutionContext) => {
    return 'ccc';
  },
);

1
2
3
4
5
6
7

先用用看：

大家猜这个 c 参数的值是啥？

没错，就是 ccc，也就是说参数装饰器的返回值就是参数的值。

回过头来看看这个装饰器：

data 很明显就是传入的参数，而 ExecutionContext 前面用过，可以取出 request、response 对象。

这样那些内置的 @Param、@Query、@Ip、@Headers 等装饰器，我们是不是能自己实现了呢？

我们来试试看：

# 实现 `@Headers` 装饰器获取请求头

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

export const MyHeaders = createParamDecorator(
  (key: string, ctx: ExecutionContext) => {
    const request: Request = ctx.switchToHttp().getRequest();
    return key ? request.headers[key.toLowerCase()] : request.headers;
  },
);

1
2
3
4
5
6
7
8
9

通过 ExecutionContext 取出 request 对象，然后调用 getHeader 方法取到 key 对应的请求头返回。

效果如下：

分别通过内置的 @Headers 装饰器和我们自己实现的 @MyHeaders 装饰器来取请求头，结果是一样的。

# 实现 @Query 装饰器

再来实现下 @Query 装饰器：

export const MyQuery = createParamDecorator(
    (key: string, ctx: ExecutionContext) => {
        const request: Request = ctx.switchToHttp().getRequest();
        return request.query[key];
    },
);