6、Nest.js 中的管道与验证器

什么是管道(pipe)?

管道就是一个实现了 PipeTransform 接口并用 @Injectable() 装饰器修饰的类。
管道的作用简单来说就是,可以将输入的数据处理过后输出。

我们在前面的例子中将参数验证的逻辑写在了控制器中,这就打破了单一责任原则,控制器只应该处理请求的分发,验证的逻辑应该让验证器来做。
在 Nest 中正确的做法是,使用管道验证器,改写我们的 findOne 如下:

    @Get(':id')
    async findOne(@Param('id', new ParseIntPipe()) id): Promise<User> {
        return await this.usersService.findOne(id);
    }

我们使用了 @nestjs/common 包中内置的一个管道 ParseIntPipe,它将一个字符串类型的数据转换成一个 int 类型,如果失败则抛出异常,现在访问 http://127.0.0.1:3000/users/exception

{
    "statusCode":400,
    "date":"2018-7-31",
    "path":"/users/exception"
}

我们自定义的错误码又没了!这可不是我们想要的结果,看来还是需要自己定义管道验证器。
现在新建一个管道:

$ nest g pi users/pipes/user-id

CREATE /src/users/pipes/user-id/user-id.pipe.ts (216 bytes)

去掉 user-id/ 这一层目录,默认生成的管道使用的还是老版本的 @Pipe 装饰器, Nest 5.0 已经修改为 @Injectable 装饰器了,所以我们修改生成的代码再给它加上两行打印语句,如下:

import { ArgumentMetadata, PipeTransform, Injectable } from '@nestjs/common';

@Injectable()
export class UserIdPipe implements PipeTransform {
  async transform(value: any, metadata: ArgumentMetadata) {
    console.log(value);
    console.log(metadata);
    return value;
  }
}

PipeTransfrom 接口就只有一个 transfrom 方法, 其中的 value 参数就是我们需要处理的数据源,而 ArgumentMetadata 就是这个对象的一些 元数据(metadate),它的接口定义是下面这样的:

export interface ArgumentMetadata {
    type: 'body' | 'query' | 'param' | 'custom';
    metatype?: new (...args) => any;
    data?: string;
}

这里直接引用官方文档的说明:


image.png

TypeScript接口在编译期间消失,所以如果你使用接口而不是类,那么元类型的值将是一个 Object。

现在让我们的管道工作起来,修改 findOne 如下:

    @Get(':id')
    async findOne(@Param('id', new UserIdPipe()) id): Promise<User> {

        return await this.usersService.findOne(id);
    }

访问 http://127.0.0.1:3000/users/exception, 看到控制台输出:

exception
{ metatype: [Function: Object], type: 'param', data: 'id' }

我们已经在管道中拿到了参数的值和元数据,我们可以写自己的验证逻辑然后在验证失败的时候让他抛出 ApiException:

import { ArgumentMetadata, PipeTransform, Injectable, HttpStatus } from '@nestjs/common';
import { ApiException } from 'common/exceptions/api.exception';
import { ApiErrorCode } from 'common/enums/api-error-code.enum';

@Injectable()
export class UserIdPipe implements PipeTransform {
  async transform(value: any, metadata: ArgumentMetadata) {
   
    value = parseInt(value)

    if(isNaN(value) || typeof value !== 'number' || value <= 0) {
      throw new ApiException('用户ID无效', ApiErrorCode.USER_ID_INVALID, HttpStatus.BAD_REQUEST);
    }

    return value;
  }
}

访问 http://127.0.0.1:3000/users/exception,发现我们的管道工作的很好,我们自定义的业务状态码也回来了啦:

{
    "errorCode":10001,
    "errorMessage":"用户ID无效",
    "date":"2018-8-1",
    "path":"/users/exception"
}

本篇只介绍管道最基本的用法,在后面我们会循序渐进的学习管道的高级用法。

上一篇:5、Nest.js 中的异常处理和AOP编程
下一篇:7、Nest.js 中的类验证器

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容