zod 與 NestJS 中的類別驗(yàn)證器和類別轉(zhuǎn)換器的比較

我很困惑，或者至少對(duì) zod 或類驗(yàn)證器和類轉(zhuǎn)換器感到好奇
作為 NestJS 中的驗(yàn)證庫(kù)。

重點(diǎn)

直接去吧。

1. 選擇class-validator和class-transformer的理由

• 是 NestJS 中常見且廣泛使用的 duo 套件
• 寫法很NestJS因?yàn)樗?em>基於裝飾器的驗(yàn)證
• 與類轉(zhuǎn)換器和 ValidationPipe 的使用進(jìn)行乾淨(jìng)且無縫的集成

2、選擇Zod的理由

• 與框架無關(guān)
• 很打字稿
• 對(duì)於喜歡功能性和基於模式方法
的人
• 性能和輕量級(jí)驗(yàn)證至關(guān)重要

細(xì)節(jié)

class-validator 和 class-transformer 是 NestJS 中最常用作驗(yàn)證的 2 個(gè)包，
是的，除了寫法和NestJS一樣，使用基於裝飾器的，
也因?yàn)樗瑴Q(jìng)且無縫，因?yàn)樗梢耘c ValidationPipe 一起用作 DTO.

因此控制器接收到的傳入資料/有效負(fù)載已根據(jù)其定義進(jìn)行了驗(yàn)證和更改/轉(zhuǎn)換。
同時(shí)，Zod 仍需要手動(dòng)驗(yàn)證收到的資料/有效負(fù)載，
是的，也許只有 1 行或最多 3 行，
但當(dāng)然，需要的驗(yàn)證功能越多，需要的手動(dòng)流程就越多。

程序詳情

以下是詳細(xì)流程（可能主觀）供比較。

類別驗(yàn)證器和類別轉(zhuǎn)換器

1. 安裝

npm install class-validator class-transformer

2.啟用全域驗(yàn)證

// main.ts
....
import { ValidationPipe } from '@nestjs/common';

async function bootstrap() {
....
  // Enable validation globally
  app.useGlobalPipes(new ValidationPipe({
    transform: true, // Automatically transform payloads to DTO instances
    whitelist: true, // Strip unknown properties
    forbidNonWhitelisted: true, // Throw error for unknown properties
  }));
....
}
....

3.定義DTO（資料傳輸物件）

import { IsNotEmpty, IsString, IsInt, Min } from "class-validator";
import { Type, Transform } from "class-transformer";

export class CreateUserDto {
    @Transform(({ value }) => value.trim()) // Trim whitespaces
    @IsNotEmpty({ message: "Nama tidak boleh kosong" })
    @IsString({ message: "Nama harus berupa string" })
    @Min(3, { message: "Minimal panjang nama 3 karakter" })
    name: string;

    @Type(() => Number) // Transform input ke tipe Number
    @IsNotEmpty({ message: "Nama tidak boleh kosong" })
    @IsInt({ message: "Umur harus berupa bilangan bulat" })
    @Min(17, { message: "Minimal umur terdaftar 17 tahun" })
    age: number;
}

很長(zhǎng)，但就是這樣基於裝飾器。

4. 驗(yàn)證的使用

import { Body, Controller, Post } from "@nestjs/common";
import { CreateUserDto } from "./create-user.dto";

@Controller("users")
export class UsersController {
    @Post()
    create(@Body() createUserDto: CreateUserDto) {
        // Pada titik ini data/payload createUserdDto
        // sudah tervalidasi & diubah sesuai definisinya
        // developer bisa langsung eksekusi service
        // atau logic yang lain
    }
}

佐德

1. 安裝

npm install zod

2. 建立驗(yàn)證方案

// user.validaiton.ts
import { z, ZodType } from "zod";

export class UserValidation {
    static readonly CREATE: ZodType = z.object({
        name: z
            .string({ message: "Nama harus berupa string" })
            .nonempty({ message: "Nama tidak boleh kosong" })
            .min(3, "Minimal panjang nama 13 karakter"),
        age: z
            .number({ message: "Umur harus berupa angka" })
            .int({ message: "Umur harus berupa bilangan bulat" })
            .min(17, "Minimal umur terdaftar 17 tahub"),
    });
}

export type TCreateUserPayload = z.infer<typeof UserValidation.CREATE>;

*個(gè)人：與上面的相比，我更喜歡閱讀此架構(gòu)

3. 驗(yàn)證的使用

import { Body, Controller, Post } from "@nestjs/common";
import { UserValidation, TCreateUserPayload } from "./user.validation.ts";

@Controller("users")
export class UsersController {
    @Post()
    create(@Body() createUserPayload: TCreateUserPayload) {
        const payload = UserValidation.CREATE.parse(createUserPayload);
        // Pada titik ini data/payload payload
        // sudah tervalidasi & diubah sesuai definisinya
        // developer bisa langsung eksekusi service
        // atau logic yang lain
    }
}

結(jié)論

我個(gè)人比較喜歡Zod的使用方式。
不過要強(qiáng)調(diào)的是根據(jù)團(tuán)隊(duì)的需求和標(biāo)準(zhǔn)來選擇。

https://abdulghofurme.github.io/posts/zod-vs-class-validator-n-class-transformer/

以上是zod 與類別驗(yàn)證器和類別轉(zhuǎn)換器的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！