NestJS自定义验证器：根据验证逻辑动态定制错误信息-js教程-PHP中文网

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方法可以检查这个私有变量，并根据其内容动态生成定制化的错误消息。

Pippit AI

CapCut推出的AI创意内容生成工具

133

查看详情

核心实现思路如下：

声明私有变量: 在CssValidator类内部添加一个私有数组（例如validationErrors: string[]），用于在验证过程中收集错误消息。
捕获并存储错误: 在validate方法中，当捕获到特定类型的错误（如CssSyntaxError）时，将其详细消息添加到这个私有数组中。
动态生成消息: 在defaultMessage方法中，首先检查私有数组是否包含错误消息。如果存在，则将这些消息拼接起来作为最终的错误提示返回；否则，返回一个通用的默认消息。

以下是修改后的CssValidator实现：

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

@ValidatorConstraint({ async: true })
@Injectable()
export class CssValidator implements ValidatorConstraintInterface {
  // 1. 声明一个私有变量，用于存储验证过程中捕获到的具体错误信息
  private validationErrors: string[] = []; 

  async validate(value: string) {
    // 每次验证开始前清空之前的错误信息，确保验证器实例的状态独立性
    this.validationErrors = []; 
    try {
      await postcss.parse(value); // 尝试解析CSS
      return true; // 验证成功
    } catch (error) {
      if (error.name === "CssSyntaxError") {
        // 2. 捕获到CssSyntaxError时，将其详细消息存储到私有变量中
        this.validationErrors.push(error.message); 
        return false; // 验证失败
      }
      // 对于其他未知错误，也可以选择记录日志或返回通用错误
      return false; 
    }
  }

  defaultMessage() {
    // 3. 根据私有变量的内容动态生成错误消息
    if (this.validationErrors.length === 0) {
      // 如果没有捕获到具体错误，返回通用消息
      return "提供的CSS无效"; 
    }
    // 返回所有捕获到的具体错误消息，用逗号连接
    return this.validationErrors.join(", "); 
  }
}

登录后复制

4. 完整示例与使用

为了将上述定制的验证器应用到数据传输对象（DTO）中，我们只需在DTO字段上使用@Validate装饰器，并指定CssValidator：

import { IsOptional, IsString, Validate } from 'class-validator';
// 假设 CssValidator 定义在 './css-validator.constraint' 文件中
// import { CssValidator } from './css-validator.constraint'; 

export class CustomStylesCreateDto {
  @IsOptional() // 允许此字段为空
  @IsString()   // 确保此字段是字符串类型
  @Validate(CssValidator, { 
    // message属性可以是一个字符串，也可以是一个函数
    // 当提供函数时，可以访问ValidationArguments，从而间接调用defaultMessage
    message: (args) => {
      // 获取CssValidator的实例
      const validator = args.constraints[0] as CssValidator; 
      if (validator && typeof validator.defaultMessage === 'function') {
        // 调用验证器实例的defaultMessage方法，获取动态生成的错误消息
        return validator.defaultMessage();
      }
      return '提供的CSS无效'; // 备用错误消息
    }
  })
  styles?: string;
}

登录后复制

当CustomStylesCreateDto的styles字段被验证时，如果输入了无效CSS，class-validator将首先调用CssValidator的validate方法。如果验证失败，它会接着调用defaultMessage方法（通过@Validate装饰器中的message函数），此时defaultMessage将返回validationErrors中存储的精确错误信息，例如“:1:1: Unclosed comments”，而不是通用的“提供的CSS无效”。

5. 注意事项与最佳实践

状态管理与实例生命周期:
- @ValidatorConstraint({ async: true }) 结合 @Injectable() 意味着NestJS会管理该验证器实例的生命周期。在大多数情况下，class-validator在执行验证时，会为每个验证请求创建一个新的验证器实例，或者至少确保验证逻辑的执行是独立的。
- 关键点: 在validate方法开始时清空私有变量this.validationErrors = [];至关重要。这确保了每次验证都是从一个干净的状态开始，避免了在一个请求中捕获的错误影响到后续或并发请求的错误消息。
错误消息的粒度与格式:
- 根据应用需求，可以决定存储更详细的错误对象（而不仅仅是字符串），例如包含错误代码、错误类型、发生位置等信息的自定义错误结构。这有助于前端进行更精细的展示、过滤或国际化处理。
- 对于多条错误信息，join(", ")是一种简单有效的展示方式。在更复杂的场景中，可能需要返回一个错误对象数组，以便前端逐条渲染。
国际化 (i18n):
- defaultMessage方法是实现国际化的理想位置。可以注入一个国际化服务到CssValidator中，并根据当前请求的语言环境，从预定义的翻译资源中获取对应的错误消息。这样，捕获到的英文错误信息（如error.message）可以被翻译成用户所选的语言。
异常处理:
- 在validate方法中，除了处理已知的特定异常（如CssSyntaxError），还应考虑其他潜在的运行时错误。对于未预料到的异常，应有适当的catch块进行处理，例如记录日志或返回一个更通用的验证失败消息，以防止应用崩溃。
测试:
- 务必为自定义验证器编写全面的单元测试。测试应覆盖有效输入、各种无效输入以及可能抛出不同类型异常的场景，确保验证器在所有预期情况下都能返回正确的验证结果和错误消息。