条件验证与动态分组
使用 @ValidateIf 以及按端点划分的验证分组,应用依赖上下文的规则。
条件验证与动态分组 是 CoddyKit 上的免费 NestJS Enterprise Backend APIs 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 NestJS Enterprise Backend APIs 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 NestJS Enterprise Backend APIs 课程共包含 4 节课。
本课时的部分内容尚未翻译,以英文显示。
Why Conditional Validation?
Real enterprise endpoints rarely need the same rules on every request. A field can be required in one situation and forbidden in another. Two tools in class-validator solve this:
- @ValidateIf — runs (or skips) a property's validators based on a condition computed from the object itself.
- Validation groups — named sets of constraints, activated per call so one DTO can serve multiple endpoints.
This lesson shows how to combine both to keep a single DTO authoritative across create, update, and role-specific flows.
The Core Idea Behind @ValidateIf
@ValidateIf(cb) takes a callback (object, value) => boolean. When it returns false, class-validator ignores all other decorators on that property — including @IsNotEmpty and even @IsOptional. When it returns true, validation proceeds normally.
Think of it as a runtime switch placed in front of the property's constraint chain.
import { ValidateIf, IsNotEmpty, IsString } from 'class-validator';
export class PaymentDto {
@IsString()
method: 'card' | 'invoice';
// cardToken is validated ONLY when method === 'card'
@ValidateIf((o: PaymentDto) => o.method === 'card')
@IsNotEmpty()
@IsString()
cardToken?: string;
}@ValidateIf vs @IsOptional
These two look similar but differ in intent:
- @IsOptional — skips validation when the value is
nullorundefined, unconditionally. - @ValidateIf — skips (or enables) validation based on any condition you write, including other fields.
Crucially, @ValidateIf returning false also suppresses errors even when a value is present. Use it when the presence requirement itself depends on context.
Forbidding a Field Conditionally
You can flip the logic: require a field to be absent under a condition. Combine @ValidateIf with @IsEmpty so the field is rejected when it should not appear.
Here, a discountCode is only allowed for promo orders; supplying it on a standard order fails validation.
import { ValidateIf, IsEmpty, IsString, IsIn } from 'class-validator';
export class OrderDto {
@IsIn(['standard', 'promo'])
type: 'standard' | 'promo';
// Must be EMPTY unless this is a promo order
@ValidateIf((o: OrderDto) => o.type !== 'promo')
@IsEmpty({ message: 'discountCode is only allowed on promo orders' })
discountCode?: string;
}Introducing Validation Groups
A validation group is just a string label attached to a decorator via its options. Constraints with no group always run; constraints assigned to a group run only when that group is requested at validation time.
This lets one DTO express different rule sets — e.g. stricter rules at create than at update — without duplicating the class.
import { IsString, MinLength, IsNotEmpty } from 'class-validator';
export const CREATE = 'create';
export const UPDATE = 'update';
export class ProfileDto {
@IsNotEmpty({ groups: [CREATE] })
@IsString({ groups: [CREATE, UPDATE] })
@MinLength(2, { groups: [CREATE, UPDATE] })
displayName?: string;
}Activating a Group
Groups do nothing until you pass them to the validator. With the imperative API you supply { groups: [...] } to validate(). In NestJS you forward the same option through the ValidationPipe.
Important default: when you request a group, constraints that belong to no group are still applied unless you set strictGroups or always options.
import { validate } from 'class-validator';
import { ProfileDto, UPDATE } from './profile.dto';
async function run() {
const dto = Object.assign(new ProfileDto(), { displayName: '' });
// Only UPDATE-group constraints (plus groupless ones) run.
const errors = await validate(dto, { groups: [UPDATE] });
console.log('error count:', errors.length);
}
run();Wiring Groups into a NestJS Pipe
NestJS exposes validation-group options on ValidationPipe. The cleanest pattern is a per-route pipe whose groups declare which rule set this endpoint enforces.
Set always: true if you want groupless constraints to keep running regardless of the active group, and strictGroups: true to reject constraints whose group was not requested.
import { Controller, Post, Body, ValidationPipe } from '@nestjs/common';
import { ProfileDto, CREATE } from './profile.dto';
@Controller('profiles')
export class ProfileController {
@Post()
create(
@Body(new ValidationPipe({ groups: [CREATE], always: true }))
dto: ProfileDto,
) {
return { ok: true, dto };
}
}One DTO, Two Endpoints
The payoff: a single DTO drives both POST (create) and PATCH (update) with different strictness. Each route binds its own ValidationPipe with the matching group.
Avoid the temptation to keep separate CreateDto and UpdateDto when only required-ness differs — groups remove that duplication and keep field types in one place.
import { Controller, Post, Patch, Body, ValidationPipe } from '@nestjs/common';
import { ProfileDto, CREATE, UPDATE } from './profile.dto';
@Controller('profiles')
export class ProfileController {
@Post()
create(@Body(new ValidationPipe({ groups: [CREATE] })) dto: ProfileDto) {
return dto;
}
@Patch(':id')
update(@Body(new ValidationPipe({ groups: [UPDATE] })) dto: ProfileDto) {
return dto;
}
}Dynamic Groups from Request Context
Sometimes the group depends on runtime data — the caller's role, a feature flag, a tenant tier. Since the ValidationPipe instance is built at route-declaration time, derive the group inside a small custom pipe that reads the request, then call validate yourself with the computed groups.
import { Injectable, PipeTransform, BadRequestException } from '@nestjs/common';
import { plainToInstance } from 'class-transformer';
import { validate } from 'class-validator';
import { REQUEST } from '@nestjs/core';
import { Inject, Scope } from '@nestjs/common';
@Injectable({ scope: Scope.REQUEST })
export class RoleAwareValidationPipe implements PipeTransform {
constructor(@Inject(REQUEST) private readonly req: any) {}
async transform(value: any, meta: any) {
const groups = this.req.user?.role === 'admin' ? ['admin'] : ['user'];
const dto = plainToInstance(meta.metatype, value);
const errors = await validate(dto, { groups, always: true });
if (errors.length) throw new BadRequestException(errors);
return dto;
}
}Combining @ValidateIf With Groups
The two mechanisms compose. @ValidateIf handles within-payload dependencies (field A depends on field B); groups handle which endpoint/role is calling. A constraint runs only when its group is active and its @ValidateIf condition holds.
Below, cancelReason is required — but only in the cancel group and only when the status is actually being set to cancelled.
import { ValidateIf, IsNotEmpty, IsIn } from 'class-validator';
export const CANCEL = 'cancel';
export class UpdateBookingDto {
@IsIn(['active', 'cancelled'], { groups: [CANCEL] })
status: 'active' | 'cancelled';
@ValidateIf((o: UpdateBookingDto) => o.status === 'cancelled', { groups: [CANCEL] })
@IsNotEmpty({ groups: [CANCEL] })
cancelReason?: string;
}Pure Logic You Can Verify
Strip away the framework and the decision is just predicate logic: a constraint fires when its group is requested and its condition is true. The function below mirrors how class-validator decides whether to enforce a single constraint, so you can reason about edge cases without a server.
type Ctx = { activeGroups: string[]; obj: Record<string, unknown> };
function shouldValidate(
constraintGroups: string[],
validateIf: (o: Record<string, unknown>) => boolean,
ctx: Ctx,
): boolean {
const groupMatches =
constraintGroups.length === 0 ||
constraintGroups.some((g) => ctx.activeGroups.includes(g));
return groupMatches && validateIf(ctx.obj);
}
const ctx: Ctx = { activeGroups: ['cancel'], obj: { status: 'cancelled' } };
const fires = shouldValidate(['cancel'], (o) => o.status === 'cancelled', ctx);
console.log('cancelReason enforced?', fires); // true
const skip = shouldValidate(['create'], () => true, ctx);
console.log('create-only rule enforced?', skip); // falseQuick Check
Consider this property decorated with @ValidateIf.
Recap
You learned to make validation context-aware in NestJS:
- @ValidateIf(cb) enables or fully skips a property's constraint chain based on a runtime predicate over the payload — ideal for inter-field dependencies.
- Validation groups label constraints so one DTO serves multiple endpoints/roles; activate them via
ValidationPipe({ groups }). - Tune behavior with
always(groupless rules still run) andstrictGroups(reject unrequested-group constraints). - For dynamic groups from request context (role, tenant), use a request-scoped pipe that computes groups and calls
validatedirectly. - The mechanisms compose: a constraint fires only when its group is active and its
@ValidateIfcondition is true.
常见问题解答
「条件验证与动态分组」课时是免费的吗?
是的 — 「条件验证与动态分组」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 NestJS Enterprise Backend APIs 课程的其余内容,请升级到 CoddyKit PRO。 NestJS Enterprise Backend APIs 课程共包含 4 节课。
「条件验证与动态分组」这节课中我会学到什么?
使用 @ValidateIf 以及按端点划分的验证分组,应用依赖上下文的规则。 你通过在浏览器中直接运行的动手代码来练习 NestJS Enterprise Backend APIs,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 NestJS Enterprise Backend APIs 需要有经验吗?
无需任何先前经验。CoddyKit 上的 NestJS Enterprise Backend APIs 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。
「条件验证与动态分组」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 NestJS Enterprise Backend APIs 课中编写并运行代码吗?
能。每节 NestJS Enterprise Backend APIs 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。