Kurs NestJS · Moduł 10: Walidacja danych

Zaawansowane dekoratory walidacji

2 min czytania ·
W tej lekcji6

Podstawowi strażnicy bramy znasz już całkiem nieźle. Teraz czas poznać elitarnych gwardzistów - zaawansowane dekoratory class-validator, które radzą sobie z bardziej skomplikowanymi sytuacjami.

@IsOptional() - strażnik wartości opcjonalnych

Nie każde pole musi być obowiązkowe. Dekorator @IsOptional() mówi: "Jeśli to pole istnieje, sprawdź je. Jeśli nie istnieje - przepuść":

import { IsOptional, IsString, IsNumber } from 'class-validator';

export class UpdateLegionaryDto {
  @IsOptional()
  @IsString()
  nickname?: string;  // Może nie mieć pseudonimu

  @IsOptional()
  @IsNumber()
  bonusPay?: number;  // Dodatkowy żołd jest opcjonalny
}

@IsEnum() - strażnik dozwolonych wartości

Gdy pole może przyjmować tylko określone wartości, używamy @IsEnum(). To jak lista dozwolonych rang w legionie:

import { IsEnum } from 'class-validator';

enum LegionaryRank {
  MILES = 'miles',
  OPTIO = 'optio',
  CENTURIO = 'centurio',
  LEGATUS = 'legatus',
}

export class CreateLegionaryDto {
  @IsEnum(LegionaryRank)
  rank: LegionaryRank;
  // 'centurio', 'imperator'
}

@IsArray() i @ArrayMinSize() - strażnicy tablic

Gdy oczekujesz tablicy danych, potrzebujesz specjalnych strażników:

import { IsArray, ArrayMinSize, IsString } from 'class-validator';

export class CreateLegioDto {
  @IsArray()
  @ArrayMinSize(1)
  @IsString({ each: true })
  skills: string[];
  // ["combat", "march"], [], "combat"
}

Zwróć uwagę na { each: true } - ten parametr mówi dekoratorowi @IsString(), żeby sprawdził każdy element tablicy, a nie samą tablicę.

@IsDateString() - strażnik dat

Weryfikuje, czy wartość jest poprawnym łańcuchem daty w formacie ISO 8601:

import { IsDateString } from 'class-validator';

export class CreateEventDto {
  @IsDateString()
  enlistmentDate: string;
  // "2024-03-15T10:00:00Z", "wczoraj"
}

@Matches() - strażnik wzorców (regex)

Najuniwersalniejszy strażnik - sprawdza, czy wartość pasuje do wyrażenia regularnego:

import { Matches, IsString } from 'class-validator';

export class CreateLegionaryDto {
  @IsString()
  @Matches(/^LEG-[A-Z]{3}-\d{4}$/, {
    message: 'Numer identyfikacyjny musi mieć format LEG-XXX-0000',
  })
  militaryId: string;
  // "LEG-ROM-0042", "123ABC"
}

Pełny przykład - formularz rekrutacji do legionu

Połączmy wszystkie zaawansowane dekoratory w kompletnym DTO:

import {
  IsString,
  IsNotEmpty,
  IsEnum,
  IsOptional,
  IsArray,
  ArrayMinSize,
  IsDateString,
  Matches,
  IsNumber,
  Min,
  Max,
  MinLength,
} from 'class-validator';

enum LegionaryRank {
  MILES = 'miles',
  OPTIO = 'optio',
  CENTURIO = 'centurio',
  LEGATUS = 'legatus',
}

export class RecruitLegionaryDto {
  @IsString()
  @IsNotEmpty()
  @MinLength(2)
  name: string;

  @IsEnum(LegionaryRank)
  rank: LegionaryRank;

  @IsNumber()
  @Min(16)
  @Max(65)
  age: number;

  @IsDateString()
  enlistmentDate: string;

  @Matches(/^LEG-[A-Z]{3}-\d{4}$/)
  militaryId: string;

  @IsArray()
  @ArrayMinSize(1)
  @IsString({ each: true })
  skills: string[];

  @IsOptional()
  @IsString()
  nickname?: string;
}

Mając te dekoratory w swoim arsenale, możesz walidować praktycznie dowolne dane. Strażnicy bramy twojego API są teraz dobrze wyszkoleni!

Kod do tej lekcji: src/advanced-decorators.ts
// Zaawansowane dekoratory walidacji
import {
  IsString,
  IsNotEmpty,
  IsEnum,
  IsOptional,
  IsArray,
  ArrayMinSize,
  IsDateString,
  Matches,
  IsNumber,
  Min,
} from 'class-validator';

// Enumy rang legionistów
enum LegionaryRank {
  MILES = 'miles',
  OPTIO = 'optio',
  CENTURIO = 'centurio',
  LEGATUS = 'legatus',
}

// TODO: Uzupełnij DTO zaawansowanymi dekoratorami
export class RecruitLegionaryDto {
  @IsString()
  @IsNotEmpty()
  name: string;

  // TODO: Dodaj @IsEnum z LegionaryRank
  rank: LegionaryRank;

  @IsNumber()
  @Min(16)
  age: number;

  // TODO: Dodaj @IsDateString()
  enlistmentDate: string;

  // TODO: Dodaj @Matches z regexem /^LEG-[A-Z]{3}-\d{4}$/
  militaryId: string;

  // TODO: Dodaj @IsArray, @ArrayMinSize(1), @IsString({ each: true })
  skills: string[];

  // TODO: Dodaj @IsOptional() i @IsString()
  nickname?: string;
}

console.log('Zaawansowane dekoratory gotowe!');

Hasła z dokumentacji w tej lekcji

Widzisz błąd w tej lekcji?

Sprawdź się

Odpowiedz na pytania z tej lekcji. Wybierz odpowiedź, a od razu zobaczysz, czy jest poprawna.

  1. 1. Co robi dekorator @IsOptional() w class-validator?

  2. 2. Do czego służy dekorator @IsEnum() w class-validator?

To 2 z 3 pytań do tej lekcji. Pozostałe rozwiążesz w grze.

Zadania praktyczne w grze

  • Edytor kodu

    Uzupełnij enum ProvinceType i dodaj dekoratory walidacji do CreateProvinceDto

  • Układanie w pionie

    Uporządkuj dekoratory od najmniej do najbardziej restrykcyjnego:

  • Edytor kodu

    Uzupełnij dekoratory @Matches i @IsDateString w CreateDocumentDto

  • Klikanie w kolejności

    Ułóż elementy dekoratora @Matches w prawidłowej kolejności:

  1. PytanieDekorator @IsOptional
  2. PytanieDekorator @IsEnum
  3. Zadanie z kodemEnum i tablice w walidacji
  4. Ułóż w kolejnościRestrykcyjność dekoratorów walidacji
  5. PytanieParametr each w dekoratorach
  6. Zadanie z kodemWalidacja z wyrażeniami regularnymi
  7. Kliknij w kolejnościBudowanie dekoratora @Matches

Przydatne artykuły