FluentValidation 自定义验证器中的计算值传递问题解析

问题背景

在使用 FluentValidation 进行数据验证时，开发者经常会遇到需要自定义验证逻辑的场景。一个典型需求是：在自定义验证器中执行某些计算逻辑，当验证失败时，不仅需要返回错误信息，还需要将计算过程中的中间结果一并返回给调用方。

案例场景分析

假设我们需要验证三个字符串字段（HIF、OSI、COC）的总字符长度是否超过限制（160个字符），但计算规则较为复杂：

1. 每个非空字符串需要额外增加4个字符
2. 对于HIF和OSI字段，长度超过65个字符再加1，超过130个字符再加1
3. COC字段只有基础长度加4的规则

常见误区

开发者可能会直接使用Must方法来实现这个验证逻辑，如下所示：

RuleFor(x => new { x.HIF, x.OSI, x.COC })
    .Must(x => custom_MaxLengthV17(x.HIF, x.OSI, x.COC))
    .WithMessage("Max length35 validation (total characters cannot exceed 216).");

这种实现虽然能完成基本的验证功能，但存在一个明显缺陷：当验证失败时，无法将计算得到的总字符数（tot_length）包含在错误信息中，导致用户只能知道验证失败，却无法了解具体超出多少字符。

解决方案

FluentValidation 提供了更灵活的Custom方法来解决这类问题。与Must相比，Custom允许开发者完全控制验证过程和错误信息的生成。

优化后的实现

RuleFor(x => new { x.HIF, x.OSI, x.COC })
    .Custom((x, context) => {
        const int _maxlength = 160;
        int tot_length = 0;
        
        // HIF字段计算
        if (!string.IsNullOrEmpty(x.HIF)) {
            tot_length += x.HIF.Length + 4;
            if (x.HIF.Length > 65) tot_length += 1;
            if (x.HIF.Length > 130) tot_length += 1;
        }
        
        // OSI字段计算
        if (!string.IsNullOrEmpty(x.OSI)) {
            tot_length += x.OSI.Length + 4;
            if (x.OSI.Length > 65) tot_length += 1;
            if (x.OSI.Length > 130) tot_length += 1;
        }
        
        // COC字段计算
        if (!string.IsNullOrEmpty(x.COC)) {
            tot_length += x.COC.Length + 4;
        }
        
        // 验证并设置自定义错误信息
        if (tot_length > _maxlength) {
            context.AddFailure($"总字符数({tot_length})超过了最大限制({_maxlength})");
        }
    });

技术要点解析

1. Custom vs Must：

   • Must只返回布尔值，适合简单验证
   • Custom提供验证上下文，适合需要复杂逻辑和自定义消息的场景

2. 错误信息定制：

   • 可以包含任何计算得出的中间值
   • 支持动态生成错误信息
   • 可以针对不同失败原因提供不同的错误提示

3. 验证上下文(Context)：

   • 通过context.AddFailure添加错误信息
   • 可以添加多个错误信息
   • 支持设置属性名称和错误代码

最佳实践建议

1. 对于简单验证逻辑，优先使用内置验证器或Must

2. 当需要：

   • 返回计算值
   • 动态生成错误信息
   • 处理复杂验证逻辑
   • 需要多个错误信息时 应该使用Custom方法

3. 在自定义验证器中：

   • 保持验证逻辑单一职责
   • 提供清晰的错误信息
   • 考虑性能影响，避免重复计算

总结

FluentValidation 的Custom方法为解决复杂验证场景提供了强大支持。通过合理使用验证上下文，开发者可以构建既严格又用户友好的验证逻辑，在验证失败时提供足够详细的反馈信息，极大提升系统的可用性和可维护性。