如何在使用RuleForEach时访问要验证的集合项?

时间:2014-11-30 12:08:49

标签: c# validation fluentvalidation

我使用FluentValidation来验证对象,并且因为此对象有一个集合成员,所以我试图使用RuleForEach。例如,假设我们有CustomerOrders,并且我们希望确保没有客户订单的总价值超过该客户允许的最大值:

this.RuleForEach(customer => customer.Orders)
    .Must((customer, orders) => orders.Max(order => order.TotalValue) <= customer.MaxOrderValue)

到目前为止,这么好。但是,我还需要记录有关错误上下文的其他信息(例如,在数据文件中找到错误的位置)。我发现使用FluentValidation很难实现这一点,到目前为止,我最好的解决方案是使用WithState方法。例如,如果我发现客户的地址详细信息不正确,我可能会这样做:

this.RuleFor(customer => customer.Address)
    .Must(...)
    .WithState(customer => GetErrorContext(customer.Address))

(其中GetErrorContext是我提取相关细节的方法。

现在我遇到的问题是,在使用RuleForEach时,方法签名假定我提供的引用 Customer 的表达式,而不是特定的Order导致验证失败。我似乎无法分辨哪个订单有问题。因此,我无法存储适当的上下文信息。

换句话说,我只能这样做:

this.RuleForEach(customer => customer.Orders)
    .Must((customer, orders) => orders.Max(order => order.TotalValue) <= customer.MaxOrderValue)
    .WithState(customer => ...)

......当我真的想这样做时:

this.RuleForEach(customer => customer.Orders)
    .Must((customer, orders) => orders.Max(order => order.TotalValue) <= customer.MaxOrderValue)
    .WithState(order => ...)

是否真的无法访问失败的集合项的详细信息(甚至是索引)?

我想另一种看待它的方式是我希望WithState拥有等效的WithStateForEach ......

1 个答案:

答案 0 :(得分:26)

目前FluentValidation中没有任何功能,允许以您希望的方式设置验证状态。 RuleForEach旨在防止为简单的收集项创建简单的验证器,并且它的实现并未涵盖所有可能的用例。

您可以为Order创建单独的验证程序类,并使用SetCollectionValidator方法应用它。要在Customer.MaxOrderValue方法中访问Must,请将属性添加到Order,向后引用Customer

public class CustomerValidator
{
    public CustomerValidator()
    {
        RuleFor(customer => customer.Orders).SetCollectionValidator(new OrderValidator());
    }
}

public class OrderValidator
{
    public OrderValidator()
    {
         RuleFor(order => order.TotalValue)
             .Must((order, total) => total <= order.Customer.MaxOrderValue)
             .WithState(order => GetErrorInfo(order)); // pass order info into state
    }
}

如果您仍想使用RuleForEach方法,则可以使用错误消息而不是自定义状态,因为它可以访问其中一个重载中的父项和子项实体对象:

public class CustomerValidator
{
    public CustomerValidator()
    {
        RuleForEach(customer => customer.Orders)
            .Must((customer, order) => order.TotalValue) <= customer.MaxOrderValue)
            .WithMessage("order with Id = {0} have error. It's total value exceeds {1}, that is maximum for {2}",
                (customer, order) => order.Id,
                (customer, order) => customer.MaxOrderValue,
                (customer, order) => customer.Name);
    }
}

如果您需要收集失败订单的所有索引(或标识符) - 您可以使用Custom规则执行此操作,例如:

public CustomerValidator()
{
    Custom((customer, validationContext) =>
    {
        var isValid = true;
        var failedOrders = new List<int>();

        for (var i = 0; i < customer.Orders.Count; i++)
        {
            if (customer.Orders[i].TotalValue > customer.MaxOrderValue)
            {
                isValid = false;
                failedOrders.Add(i);
            }
        }

        if (!isValid){
            var errorMessage = string.Format("Error: {0} orders TotalValue exceed maximum TotalValue allowed", string.Join(",", failedOrders));
            return new ValidationFailure("", errorMessage) // return indexes of orders through error message
            {
                CustomState = GetOrdersErrorInfo(failedOrders) // set state object for parent model here
            };
        }

        return null;
    });
}

<强> P.S。

不要忘记您的目标是实施验证,而不是在任何地方使用FluentValidation 。有时我们将验证逻辑实现为一个单独的方法,它与ViewModel一起使用并填充ASP.NET MVC中的ModelState

如果您找不到符合要求的解决方案,那么手动实施将比使用库的 crutchful 实施更好。