伊人久久艹,人人九九精,欧美一级在线视频

一個參數驗證，學會 Nest.js 的兩大機制：Pipe、ExceptionFilter

本文轉載自微信公眾號「神光的編程秘籍」，作者神說要有光zxg。轉載本文請聯系神光的編程秘籍公眾號。

對輸入做驗證是一個 web 應用的基本功能，不止前端要做、后端也要做：

前端做驗證可以避免沒必要的請求，盡快給用戶反饋
后端做驗證可以防止一些繞過瀏覽器的惡意提交

前端做表單的驗證基本不用自己寫，有很多 validation 的庫，大家寫的也比較多了。后端的驗證大家可能寫的相對較少，今天我們就來學下后端框架 Nest.js 如何做參數的驗證吧。

本文會學到這些內容：

Nest.js 的管道(pipe)做參數的驗證和轉換
Nest.js 的異常過濾器(exception filter)做異常的處理，返回響應
Nest.js 結合 class-validation 做聲明式的參數驗證

Nest.js 基礎

Nest.js 是基于 IOC 和 MVC 的思想的后端框架：

MVC 是 Controller、Service、Repository 的分層，這也是后端框架的通用架構
IOC 是依賴注入，也就是 Controller、Service、Repository 等實例都在 IOC 容器內可以自動注入，只需要聲明依賴，不需要手動 new。

此外，Nest.js 還支持 Module，可以把 Controller、Service、Repository 封裝成一個 Module，易于代碼的組織。

整體架構如圖：

一個參數驗證，學會 Nest.js 的兩大機制：Pipe、ExceptionFilter

整個 IOC 容器內有多個 Controller、Service、Respository 等實例，分散在不同的 Module 中。有一個 AppModule 作為根來引入其他 Module。

請求是在 Controller 里處理的，調用 Service 來完成業務邏輯，其中對數據庫的 CRUD 由 Repository 完成。

那么對參數的 validate 應該放在哪呢?

參數 validate 實現思路

對參數做驗證，在 Controller 里就可以，但是這種驗證邏輯是通用的，每個 Controller 里都做一遍也太麻煩了，能不能在 Controller 之前就做好了呢?

可能大家沒什么思路，那我們再了解一個 Nest.js 的功能：管道(Pipe)。

Nest.js 支持管道(Pipe)，它會在請求到達 Controller 之前被調用，可以對參數做驗證和轉換，如果拋出了異常，則不會再傳遞給 Controller。

這種管道的特性適合用來做一些跨 Controller 的通用邏輯，比如 string 的 int 的轉換，參數驗證等等。

Nest.js 內置了 8 個管道：

ValidationPipe
ParseIntPipe
ParseBoolPipe
ParseArrayPipe
ParseUUIDPipe
ParseEnumPipe
ParseFloatPipe
DefaultValuePipe

可以分為 3 類：

parseXxx，把參數轉為某種類型;defaultValue，設置參數默認值;validation，做參數的驗證。

這些都是很通用的功能。

很明顯，validation 就可以用那個 ValidationPipe 來做。

但是我們先不著急用 Nest.js 提供的 Pipe，先自己實現下試試。

Pipe 的形式是實現 PipeTransform 接口的類，實現它的 transform 方法，在里面對 value 做各種轉換或者驗證，如果驗證失敗就拋一個異常。

import { PipeTransform, Injectable, ArgumentMetadata, BadRequestException } from '@nestjs/common';
@Injectable()
export class MyValidationPipe implements PipeTransform<any> {
async transform(value: any, metadata: ArgumentMetadata) {
if (value.age > 20) {
throw new BadRequestException('年齡超過限制');
} else {
value.age += 10;
}
return value;
}
}

之后我們在 IOC 容器啟動的時候調用 useGlobalPipes 方法注冊一下這個 Pipe：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { MyValidationPipe } from './pipes/MyValidationPipe';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useGlobalPipes(new MyValidationPipe());
await app.listen(3000);
}
bootstrap();

我們來測試下：

當參數的 age 大于 20，就會拋異常返回對應的 response。

一個參數驗證，學會 Nest.js 的兩大機制：Pipe、ExceptionFilter

當參數小于 20，參數會被修改之后傳遞到 Controller：

一個參數驗證，學會 Nest.js 的兩大機制：Pipe、ExceptionFilter

可以看到，參數被傳遞到了 Controller 并且做了修改。

這就是 Pipe 的作用。

所以，我們在 pipe 中對參數做 validate 就行了。可以用 class-validation 這個包，它支持裝飾器的方式來配置驗證規則：

類似這樣：

import { IsEmail, IsNotEmpty, IsPhoneNumber, IsString } from "class-validator";
export class CreatePersonDto {
@IsNotEmpty({
message: 'name 不能為空'
})
@IsString()
name: string;
@IsPhoneNumber("CN", {
message: 'phone 不是一個電話號碼'
})
phone: string;
@IsEmail({}, {
message: 'email 不是一個合法郵箱'
})
email: string;
}

然后在 pipe 中調用 validate 的方法，如果有錯誤就拋異常：

import { PipeTransform, Injectable, ArgumentMetadata, BadRequestException } from '@nestjs/common';
import { validate } from 'class-validator';
import { plainToClass } from 'class-transformer';
@Injectable()
export class MyValidationPipe implements PipeTransform<any> {
async transform(value: any, { metatype }: ArgumentMetadata) {
if (!metatype) {
return value;
}
const object = plainToClass(metatype, value);
const errors = await validate(object);
if (errors.length > 0) {
throw new BadRequestException('Validation failed');
}
return value;
}
}

因為我們是用裝飾器做的配置，那就要通過對象拿到它對應的類的裝飾器，所以在 validate 之前要調用 class-transformer 包的 plainToClass 方法來把普通的參數對象轉換為該類的實例。

這樣就實現了參數校驗的功能：

一個參數驗證，學會 Nest.js 的兩大機制：Pipe、ExceptionFilter

這就是 Nest.js 的 ValidationPipe 的實現原理。

當然，我們沒有做錯誤的格式化，不如內置 Pipe 做的漂亮，我們來看下內置 Pipe 的效果：

啟用內置的 ValidationPipe：

import { ValidationPipe } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useGlobalPipes(new ValidationPipe());
await app.listen(3000);
}
bootstrap();

然后測試下：

一個參數驗證，學會 Nest.js 的兩大機制：Pipe、ExceptionFilter

人家這個返回的格式好多了。

還有，大家有沒有注意到，我們只是返回了一個 BadRequestException 的 error，但是服務器就返回了 400 的相應，這個是什么原因呢?

這就涉及到了 Nest.js 的另一個機制：異常過濾器(Exception Filter)。

Nest.js 支持異常過濾器(ExceptionFilter)，可以聲明對什么錯誤做什么響應，這樣應用想返回什么響應只需要拋相應的異常。

異常過濾器的形式是一個實現 ExceptionFilter 接口的類，通過 Catch 裝飾器聲明對什么異常做處理。實現它的 catch 方法，在方法內拿到 response 對象返回相應的響應。

定義異常：

export class ForbiddenException extends HttpException {
constructor() {
super('Forbidden', HttpStatus.FORBIDDEN);
}
}

定義異常過濾器：

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { Request, Response } from 'express';
@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
catch(exception: HttpException, host: ArgumentsHost) {
const ctx = host.switchToHttp();
const response = ctx.getResponse();
const request = ctx.getRequest();
const status = exception.getStatus();
response
.status(status)
.json({
statusCode: status,
timestamp: new Date().toISOString(),
path: request.url,
});
}
}