在NestJS自定义验证器中实现动态错误消息

本文旨在解决nestjs `class-validator`中自定义验证器无法根据验证逻辑动态返回错误消息的问题。通过引入一个私有实例变量来存储验证过程中捕获的详细错误信息，并由 `defaultmessage` 方法访问并返回这些信息，从而实现高度定制化的错误提示。这种方法提升了用户体验和前端错误处理的灵活性。

背景与挑战

在NestJS应用中，我们经常使用 class-validator 库进行数据验证。对于简单的验证规则，内置的装饰器或自定义验证器配合 defaultMessage 方法足以满足需求。然而，当验证逻辑涉及外部库调用或复杂业务规则，且需要在验证失败时返回具体的、动态生成的错误信息时，传统的 defaultMessage 方法就显得力不从心了。

例如，一个自定义CSS验证器需要使用 postcss 解析用户输入的字符串，如果解析失败，postcss 会抛出 CssSyntaxError，其中包含详细的语法错误原因。我们希望将这个具体的错误原因直接作为验证失败的提示信息返回给用户，而不是一个通用的“CSS无效”消息。问题在于，defaultMessage 方法在被调用时，无法直接访问 validate 方法内部捕获的动态错误上下文。

解决方案：利用私有实例变量存储动态错误

解决这个问题的关键在于，在自定义验证器类中引入一个私有实例变量，用于在 validate 方法执行期间捕获并存储具体的错误信息。随后，defaultMessage 方法可以访问这个私有变量，并根据其内容返回定制化的错误消息。

1. 定义自定义验证器骨架

首先，我们创建一个实现了 ValidatorConstraintInterface 接口的自定义验证器。本例中，我们将创建一个 CssValidator 来检查CSS字符串的有效性。

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

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

  /**
   * 异步验证方法
   * @param value 待验证的字符串
   * @returns 如果验证通过返回 true，否则返回 false
   */
  async validate(value: string): Promise<boolean> {
    // 在每次验证前清空之前的错误信息，确保每次验证都是独立的
    this.validationErrors = []; 
    try {
      await postcss.parse(value);
      return true; // 验证通过
    } catch (error) {
      if (error.name === 'CssSyntaxError') {
        // 捕获到CSS语法错误，将错误消息存储到私有变量中
        this.validationErrors.push(error.message);
      } else {
        // 其他未知错误，也可以存储通用消息或特定错误
        this.validationErrors.push('An unexpected error occurred during CSS validation.');
      }
      return false; // 验证失败
    }
  }

  /**
   * 返回默认（或定制）的错误消息
   * @returns 错误消息字符串
   */
  defaultMessage(): string {
    // 如果私有变量中存储了具体的错误信息，则返回这些信息
    if (this.validationErrors.length > 0) {
      return this.validationErrors.join(', '); // 可以根据需要格式化错误信息
    }
    // 否则，返回一个通用的默认错误消息
    return 'Provided string is not valid CSS.';
  }
}

在上述代码中：

Zyro AI Background Remover

Zyro推出的AI图片背景移除工具

55

查看详情

• 我们声明了一个 private validationErrors: string[] = []; 变量来存储 postcss 解析失败时产生的具体错误消息。
• 在 validate 方法的 try...catch 块中，当捕获到 CssSyntaxError 时，我们将 error.message 推入 validationErrors 数组。
• 重要提示：在 validate 方法开始时，务必清空 this.validationErrors。这是因为NestJS的DI容器可能会重用验证器实例，如果不清空，上一次验证的错误可能会影响到本次验证。
• defaultMessage 方法现在可以检查 this.validationErrors 数组。如果数组中有内容，说明在 validate 期间捕获到了具体错误，此时可以返回这些详细的错误信息；否则，返回一个通用的错误消息。

2. 在DTO中使用自定义验证器

完成 CssValidator 的实现后，我们可以在任何DTO中使用它，就像使用其他 class-validator 装饰器一样。

import { IsOptional, IsString, Validate } from 'class-validator';
import { CssValidator } from './css.validator'; // 导入自定义验证器

export class CustomStylesCreateDto {
  @IsOptional() // 字段可选
  @IsString()   // 确保字段是字符串类型
  @Validate(CssValidator, { message: 'Invalid CSS format: $value' }) // 使用自定义验证器
  styles?: string;
}

在 @Validate 装饰器中，我们传入了 CssValidator。当 styles 字段验证失败时，class-validator 会调用 CssValidator 实例的 defaultMessage 方法来获取最终的错误消息。

注意事项与最佳实践

1. 清空状态：如前所述，由于NestJS的DI容器可能会重用验证器实例（尤其是当验证器被注册为单例Provider时），在 validate 方法开始时清空 this.validationErrors 至关重要，以避免不同验证请求之间的状态污染。
2. 错误消息格式：考虑统一错误消息的格式，以便前端或其他消费者能够更容易地解析和展示。例如，总是返回一个包含错误代码和描述的JSON对象，或者约定一种固定的字符串分隔符。
3. 异步验证：如果 validate 方法是异步的（如本例中使用了 postcss.parse），请确保 ValidatorConstraint 装饰器中的 async 属性设置为 true。
4. 错误处理粒度：你可以根据需要，在 catch 块中捕获不同类型的错误，并存储不同格式或详细程度的错误信息。
5. 可测试性：这种方法将错误生成逻辑封装在验证器内部，使得对验证器及其错误输出的单元测试更加直接和方便。

总结

通过在NestJS自定义验证器中引入私有实例变量来存储动态生成的错误信息，并由 defaultMessage 方法访问这些信息，我们能够突破 class-validator 默认的静态错误消息限制，实现高度定制化和上下文相关的错误提示。这种方法不仅提升了用户体验，也使得后端验证逻辑能够更精确地反馈问题，为前端错误处理提供了更丰富的数据。

以上就是在NestJS自定义验证器中实现动态错误消息的详细内容，更多请关注php中文网其它相关文章！