Pipe

段落

pipe 元件可以針對輸入輸出驗證資料格式，並進行轉型。

參數驗證

在 @Query 或 @Param 裝飾器中傳入：

@Get('test-parse-int-pipe')
getTestParseIntPipe(@Query('id', ParseIntPipe) id: number) {
  return `id type: ${typeof id}`; // id type: number
}

可以在實例化 pipe 時在建構函式帶入指定的狀態碼來表示請求格式有誤時要拋出的回應：

@Get('test-parse-int-pipe')
getTestParseIntPipe(
  @Query(
    'id',
    new ParseIntPipe({
      errorHttpStatusCode: HttpStatus.NOT_ACCEPTABLE,
    }),
  )
  id: number,
) {
  return `id type: ${typeof id}`;
}

預設的訊息會明確指出是在驗證階段發現的錯誤：

{
  "message": "Validation failed (numeric string is expected)",
  "error": "Not Acceptable",
  "statusCode": 406
}

只要是能拋出錯誤的地方，就能自訂回應內容，透過 exceptionFactory 的 callback 拋出：

@Get('test-parse-int-pipe')
getTestParseIntPipe(
  @Query(
    'id',
    new ParseIntPipe({
      exceptionFactory: (error) => new HttpException(error, 999),
    }),
  )
  id: number,
) {
  return `id type: ${typeof id}`;
}

多筆資料的參數，如 ?ids=1,2,3，要使用 ParseArrayPipe，並在建構函式中設定 items 和 seperator 來指定要解析的資料型態與分割符：

@Get()
getTodos(
  @Query('ids', new ParseArrayPipe({
    items: Number,
    seperator: ','
  }))
  ids: number[],
) {
  return { ids };
}

物件資料驗證

需要用到 ValidationPipe：

Terminal window
npm i class-validator class-transformer

透過物件形式傳輸的資料也稱作 DTO：

export class CreateTodoDto {
  public readonly title: string;
  public readonly content: string;
}

配合 class-validator 的裝飾器就可以附加每個欄位的驗證規則：

export class CreateTodoDto {
  @MaxLength(100)
  @MinLength(1)
  public readonly title: string;


  @MaxLength(100)
  @IsOptional()
  public readonly content?: string;
}
警告

官方有特別強調，雖然用 interface 定義格式也能達到驗證的效果，但是只是 TS 的檢查語法，不會被編譯成 class 或其他實例，因為 runtime 階段 interface 就不存在了，沒有辦法在資料傳輸的過程中被 class-validator 檢查。

部分套用

使用 @UsePipe 裝飾器，套用在指定的方法或是 controller 上，參數型別可以直接指定為 CreateTodoDto 這個類別定義，ValidationPipe 就會去找原始定義進行比對：

// 套用在 post 方法
@UsePipes(ValidationPipe)
@Post()
createTodo(@Body() data: CreateTodoDto) {
  console.log(data);


  return data;
}

故意傳入一個不符格式的資料 {}，會得到：

{
  "message": [
    "title must be longer than or equal to 1 characters",
    "title must be shorter than or equal to 100 characters"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

在 CreateTodoDto 中有對 content 標記 @IsOptional()，因此這個沒給這個值或是給空值不會報錯。

如果將 @UsePipes 移除的話，DTO 中標記的所有規則都不會生效，這個 POST 請求就會直接通過，得到一個 {}。

全域套用

套用的方式和 exception filter 相同。

在根模組進行注入：

@Module({
  controllers: [AppController],
  providers: [
    {
      provide: APP_PIPE,
      useClass: ValidationPipe,
    },
  ],
})
export class AppModule {}

或是在啟動程序中呼叫 useGlobalPipes 並傳入實例：

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  // 建立實例
  app.useGlobalPipes(new ValidationPipe());
  await app.listen(process.env.PORT ?? 3000);
}

建構函式

傳入 ValidationPipe 給 @UsePipes 時，會自動建立實例，再根據下一行要執行的函式參數型別套用驗證：

@UsePipes(ValidationPipe)

手動建立實例時可以在建構函式中啟用一些設定，例如驗證失敗時不給任何 message：

@UsePipes(
  new ValidationPipe({
    disableErrorMessages: true,
  }),
)

使用 whitelist: true 會過濾掉不在 DTO 裡的欄位，使用 forbidNonWhitelisted 會讓帶有多餘欄位的資料請求失敗：

@UsePipes(
  new ValidationPipe({
    whitelist: true,
    forbidNonWhitelisted: true,
  }),
)

轉型

將 transform 打開後，驗證結束時會將資料做轉型，如下面這個範例，傳入的 data 通過驗證後，會依照參數型別的宣告，轉型成 CreateTodoDto 實例：

@UsePipes(
  new ValidationPipe({
    transform: true,
  }),
)
@Post()
createTodo(@Body() data: CreateTodoDto) {
  const isInstance = data instanceof CreateTodoDto;


  return {
    msg: '這是被轉換的資料',
    isInstance,
    data,
  };
}

因此像是剛開始示範的 query、param 要從 string 轉 number，也可以用這種方式轉型。

共用格式

DTO 本身也可以透過繼承來映射出新的 DTO，首先要安裝：

Terminal window
npm i @nestjs/mapped-types

部分套用

用 PartialType 繼承 ，全部欄位都會變成可選的，但驗證規則一樣保留：

export class UpdateUserDto extends PartialType(CreateUserDto) {}

選擇套用

在 PickType 中的陣列放入指定欄位名稱就可以改寫驗證規則：

export class UpdateTodoDto extends PickType(CreateTodoDto, ['title']) {
  @MaxLength(1000)
  @IsOptional()
  public readonly description?: string;
}

排除套用

和 PickType 相反，可以排除指定欄位：

export class UpdateTodoDto extends OmitType(CreateTodoDto, ['title']) {}

合併套用

不解釋，就是合併任意 DTO 的全部欄位：

export class UpdateTodoDto extends OmitType(CreateTodoDto, OtherDto) {}

自訂 pipe

運行的流程也和 filter 差不多，在特定的判斷點沒有通過驗證的話就 throw 中斷流程：

@Injectable()
export class CustomParseIntPipe implements PipeTransform {
  transform(value: string, metadata: ArgumentMetadata) {
    const intValue = parseInt(value, 10);


    if (isNaN(intValue)) {
      throw new NotAcceptableException('不是數字');
    }


    return intValue;
  }
}

用法一樣是在特定的裝飾器中傳入 pipe 元件的類別或實例：

@Get('test-parse-int-pipe-custom')
getTestParseIntPipeCustom(
  @Query('id', CustomParseIntPipe)
  id: number,
) {
  return `id type: ${typeof id}`;
}

小結

pipe 是 NestJS 必用的元件，基本上 ValidationPipe 就已經能取代大部分的輸入輸出驗證，整體用法和 filter 也是一模一樣！

參考資料