Comparaison de zod avec le validateur de classe et le transformateur de classe dans NestJS

J'étais confus, ou du moins curieux entre zod ou class-validator & class-transformer
en tant que bibliothèque de validation dans NestJS.

Point principal

Allez-y directement.

1. Raisons du choix du validateur de classe et du transformateur de classe

• Est un duo packages courants et largement utilisés dans NestJS
• La méthode d'écriture est très NestJS car c'est une validation basée sur le décorateur
• intégration propre et transparente avec son utilisation avec class-transformer et ValidationPipe

2. Raisons du choix de Zod

• Agnostique du framework
• Très dactylographié
• Pour ceux qui préfèrent l'approche fonctionnelle et basée sur des schémas
• La validation des performances et de la légèreté est essentielle

Détails

class-validator & class-transformer sont les 2 packages les plus couramment utilisés comme validation dans NestJS,
oui, mis à part le fait que la méthode d'écriture est la même que NestJS utilisant basé sur un décorateur,
aussi parce qu'il est propre et transparent car il peut être utilisé avec ValidationPipe comme DTO.

Les données/charges utiles entrantes re?ues par le contr?leur ont donc été validées et modifiées/transformées selon leur définition.
Pendant ce temps, Zod doit encore valider manuellement les données/charges utiles re?ues,
Oui, peut-être seulement 1 ou un maximum de 3 lignes,
mais bien s?r, plus il faut de fonctions de validation, plus il faut de processus manuels.

Détails de la procédure

Ce qui suit sont des procédures détaillées (peut être subjectives) à des fins de comparaison.

validateur de classe et transformateur de classe

1.Installation

npm install class-validator class-transformer

2. Activer la validation globale

// 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. Définir DTO (Data Transfer Object)

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;
}

C'est assez long, mais c'est comme ?a basé sur le décorateur.

4. Utilisation de la validation

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
    }
}

Zod

1.Installation

npm install zod

2. Créer un schéma de validation

// 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>;

*Personnel : je préfère lire ce schéma que celui ci-dessus

3. Utilisation de la validation

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
    }
}

Conclusion

Personnellement, je préfère la fa?on dont Zod est utilisé.
Cependant, ce qu'il faut souligner, c'est choisir en fonction des besoins et des standards de l'équipe.

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!