FluentValidation中自定义验证器的消息定制技巧

理解自定义验证器的消息传递需求

在使用FluentValidation进行数据验证时，开发者经常会遇到需要自定义验证逻辑的情况。一个典型场景是：当验证涉及多个字段的复杂计算时，不仅需要返回验证结果，还需要在错误消息中显示计算过程的中间值。

问题场景分析

考虑这样一个实际案例：需要验证三个字符串字段(HIF、OSI、COC)的总字符数不超过特定限制(160个字符)。这个验证逻辑包含以下特点：

1. 每个非空字段都会增加其长度加4的基础值
2. 对于HIF和OSI字段，长度超过65和130时会有额外加成
3. 需要知道验证失败时的实际总字符数

解决方案：使用Custom而非Must

FluentValidation提供了两种自定义验证方式：Must和Custom。对于需要传递额外验证信息的场景，Custom是更合适的选择，原因如下：

1. 完整的消息控制权：Custom方法允许完全自定义错误消息内容
2. 上下文访问：可以访问验证上下文，获取更多验证信息
3. 灵活的消息构造：可以在消息中包含计算过程的中间结果

实现代码示例

RuleFor(x => new { x.HIF, x.OSI, x.COC })
.Custom((x, context) => 
{
    const int maxlength = 160;
    int tot_length = 0;
    
    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;
    }
    
    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;
    }
    
    if (!string.IsNullOrEmpty(x.COC))
        tot_length += x.COC.Length + 4;
    
    if (tot_length > maxlength) 
    {
        context.AddFailure(
            name: $"{nameof(x.HIF)},{nameof(x.OSI)},{nameof(x.COC)}",
            error: $"总字符数({tot_length})超过了最大限制({maxlength})"
        );
    }
});

技术要点解析

1. Custom方法签名：接收两个参数 - 要验证的值和验证上下文
2. 验证失败处理：通过context.AddFailure添加自定义错误
3. 消息格式化：在错误消息中直接包含计算得出的总字符数
4. 字段命名：保持了原始规则中的字段命名方式

最佳实践建议

1. 对于简单验证逻辑，使用Must即可
2. 当需要显示验证过程中的计算值时，优先选择Custom
3. 错误消息应当清晰说明问题原因和具体数值
4. 复杂的验证逻辑可以提取到单独的方法中保持代码整洁

总结

FluentValidation的Custom验证器为复杂验证场景提供了强大的灵活性，特别是当需要向最终用户展示验证过程中的计算细节时。通过合理利用验证上下文和自定义错误消息，可以显著提升验证失败时的用户体验和问题排查效率。