NestJS自定义验证器：根据验证逻辑动态定制错误信息

在nestjs应用中，当使用`class-validator`创建自定义验证器时，我们可能需要根据验证逻辑的实际失败原因返回特定的错误消息，而非通用的默认消息。本文将介绍一种有效的方法，通过在自定义验证器类中引入私有变量来捕获和传递验证过程中的详细错误信息，从而实现`defaultmessage()`函数的动态定制，提升用户界面的错误提示精度。

1. 理解NestJS自定义验证器与class-validator

NestJS框架结合class-validator库提供了强大的数据验证能力。开发者可以通过实现ValidatorConstraintInterface接口来创建高度定制化的验证逻辑。这个接口主要包含两个核心方法：

• validate(value: any, args?: ValidationArguments): 此方法承载实际的验证逻辑。如果数据通过验证，它应返回true；否则，返回false。
• defaultMessage?(args?: ValidationArguments): 当validate方法返回false时，此方法被调用以提供一个默认的错误消息。

然而，defaultMessage方法在设计上并未直接提供从validate方法中捕获到的具体错误上下文。这意味着，如果我们希望根据validate方法中发生的特定异常（例如，解析CSS时遇到的CssSyntaxError）来动态生成错误消息，直接在defaultMessage中实现将面临挑战。它无法直接“知道”是什么导致了validate方法的失败。

2. 挑战：CSS验证器中的动态错误消息需求

考虑一个实际场景：我们需要验证用户输入的字符串是否为有效的CSS代码。为了实现这一点，我们可以利用postcss这样的库来解析CSS。如果输入的CSS无效，postcss.parse通常会抛出CssSyntaxError，其中包含了关于错误类型和位置的详细信息（例如，“未闭合的注释”）。

一个初始的CssValidator实现可能如下所示：

import { IsOptional, IsString, Validate } from 'class-validator';
import { ValidatorConstraint, ValidatorConstraintInterface } from 'class-validator';
import { Injectable } from '@nestjs/common';
import postcss from 'postcss';

@ValidatorConstraint({ async: true })
@Injectable()
export class CssValidator implements ValidatorConstraintInterface {
  async validate(value: string) {
    try {
      await postcss.parse(value); // 尝试解析CSS
      return true; // 解析成功，CSS有效
    } catch (error) {
      if (error.name === 'CssSyntaxError') {
        console.log(error.reason); // 能够捕获到具体的错误原因，例如: Unclosed comments
      }
    }
    return false; // 解析失败，CSS无效
  }

  defaultMessage() {
    return 'Invalid CSS provided'; // 期望此处能根据 `validate` 中的错误动态定制
  }
}

export class CustomStylesCreateDto {
  @Validate(CssValidator)
  styles?: string;
}

登录后复制

如上述代码所示，validate方法能够捕获到具体的CssSyntaxError及其详细原因。然而，defaultMessage方法却无法直接访问这些上下文信息，只能返回一个静态的通用错误消息“Invalid CSS provided”。这种限制使得前端无法向用户展示精确的错误提示，从而影响了用户体验。

3. 解决方案：利用私有变量传递错误上下文

为了克服defaultMessage无法访问validate方法上下文的限制，我们可以采用一种面向对象的设计模式：在自定义验证器类中声明一个私有变量，用于存储在validate方法执行过程中捕获到的具体错误信息。随后，defaultMessage方法可以检查这个私有变量，并根据其内容动态生成定制化的错误消息。

标签： css js 前端 ai 并发请求