FluentValidation中如何为集合验证添加行号提示

在FluentValidation这个流行的.NET验证库中，当我们需要验证集合类型数据时，默认的错误消息可能不够清晰，特别是当集合中包含多个元素时，开发者往往难以快速定位到具体出错的行。本文将介绍几种增强集合验证错误消息可读性的方法。

使用内置的CollectionIndex占位符

FluentValidation提供了一个内置的{CollectionIndex}占位符，可以在验证消息中直接使用。这个占位符会自动替换为当前验证项在集合中的索引位置（从0开始）。

RuleFor(line => line.Quantity)
  .GreaterThan(0)
  .WithMessage("'{PropertyName}'在第{CollectionIndex}行必须大于{ComparisonValue}");

执行上述验证后，错误消息会显示为："'Quantity'在第0行必须大于0"。这种方式简单直接，但索引从0开始可能不符合某些业务场景的需求。

自定义行号占位符

对于需要从1开始显示行号的场景，我们可以通过扩展方法实现自定义占位符。下面是一个完整的实现示例：

public static class ValidationExtensions 
{
    public static IRuleBuilderOptions<T, TProperty> WithRowNumberPlaceholder<T, TProperty>(
        this IRuleBuilderOptions<T, TProperty> ruleBuilder) 
    {
        return ruleBuilder.Configure(rule => 
        {
            rule.MessageBuilder = context => 
            {
                if (context.MessageFormatter.PlaceholderValues.TryGetValue("CollectionIndex", out var index) 
                {
                    // 将索引+1转换为行号
                    context.MessageFormatter.AppendArgument("RowNumber", (int)index + 1);
                }
                return context.GetDefaultMessage();
            };
        });
    }
}

使用方法：

RuleFor(line => line.Quantity)
    .GreaterThan(0)
    .WithRowNumberPlaceholder()
    .WithMessage("'{PropertyName}'在第{RowNumber}行必须大于{ComparisonValue}");

现在错误消息会显示为："'Quantity'在第1行必须大于0"，更加符合常规业务需求。

复杂对象前缀处理

对于嵌套在复杂对象中的集合验证，我们还可以进一步扩展错误消息，添加对象前缀信息：

public static IRuleBuilderOptions<T, TProperty> WithObjectPrefix<T, TProperty>(
    this IRuleBuilderOptions<T, TProperty> ruleBuilder, string prefix) 
{
    return ruleBuilder.Configure(rule => 
    {
        rule.MessageBuilder = context => 
        {
            context.MessageFormatter.AppendArgument("ObjectPrefix", prefix);
            return context.GetDefaultMessage();
        };
    });
}

使用示例：

RuleFor(order => order.Lines)
    .ForEach(lineRule => 
    {
        lineRule.RuleFor(x => x.Price)
            .GreaterThan(0)
            .WithObjectPrefix("订单明细")
            .WithRowNumberPlaceholder()
            .WithMessage("'{ObjectPrefix}第{RowNumber}行的{PropertyName}必须大于{ComparisonValue}");
    });

这样产生的错误消息会是："'订单明细第1行的Price必须大于0'"，极大提高了错误信息的可读性。

最佳实践建议

1. 对于简单的集合验证，直接使用{CollectionIndex}占位符即可
2. 需要从1开始计数时，推荐使用自定义的行号占位符
3. 对于复杂嵌套结构，考虑添加对象前缀信息
4. 保持错误消息格式在整个项目中一致
5. 考虑将常用消息格式封装为共享扩展方法

通过这些方法，我们可以显著提升集合验证错误消息的可读性和实用性，特别是在处理大型数据集时，能够帮助开发者和最终用户快速定位问题所在。