Fluent 验证:在自定义验证时设置自定义消息

Fluent validation: set custom message on custom validation

提问人:Alberto De Caro 提问时间:8/5/2014 更新时间:8/7/2014 访问量:27958

问:

场景

我有一个自定义规则来验证订单的运费:

public class OrderValidator : BaseValidator<Order>
{

    private string CustomInfo { get; set; }

    public OrderValidator()
    {
        //here I call the custom validation method and I try to add the CustomInfo string in the message
        RuleFor(order => order.ShippingCost).Cascade(CascadeMode.StopOnFirstFailure).NotNull().Must(
            (order, shippingCost) => CheckOrderShippingCost(order, shippingCost)
        ).WithMessage("{PropertyName} not set or not correct: {PropertyValue}." + (String.IsNullOrEmpty(CustomInfo) ? "" : " " + CustomInfo));
    }

    //this is the custom validation method
    private bool CheckOrderShippingCost(Order o, decimal shippingCost)
    {
        bool res = false;

        try
        {
            /*
             * check the actual shippingCost and set the res value
             */
        }
        catch (Exception ex)
        {
            CustomInfo = ex.ToString();
            res = false;
        }

        return res;
    }
}

如果出现异常,我会将异常信息存储到 CustomInfo 私有成员中,并将其添加到验证消息中。

然后我运行验证器:

OrderValidator oVal = new OrderValidator();
oVal.Results = oVal.Validate(order);
if (!oVal.Results.IsValid)
    oVal.Results.Errors.ForEach(delegate(ValidationFailure error) {
        Console.WriteLine(error.ErrorMessage);
    });

问题

一切正常,在异常情况下,CustomInfo 正确设置为 ex。ToString() 值。但最终控制台中显示的错误消息不显示 CustomInfo,而只显示消息的第一部分:

      "Shipping Cost not set or not correct: 5.9"

问题

为什么自定义消息不包含 CustomInfo 字符串? 是否可以以另一种方式将异常信息添加到自定义消息中?

C# FluentValidation 自定义错误

评论


答:

14赞 Icepickle 8/7/2014 #1

根据这个 https://fluentvalidation.codeplex.com/wikipage?title=Customising&referringTitle=Documentation&ANCHOR#CustomError

你应该宁愿使用

.WithMessage("{PropertyName} not set or not correct: {PropertyValue}. {0}", order => order.CustomInfo);

这将要求您的 CustomInfo 位于 Order 类的级别,而不是您的验证器类

编辑

您可以使用:

public static class OrderExtensions
{
    private static IDictionary<Order,string> customErrorMessages;

    public static void SetError(this Order order, string message) {
        if (customErrorMessages == null) {
            customErrorMessages = new Dictionary<Order,string>();
        }
        if (customErrorMessages.ContainsKey(order)) {
            customErrorMessages[order] = message;
            return;
        }
        customErrorMessages.Add(order, message);
    }

    public static string GetError(this Order order) {
        if (customErrorMessages == null || !customErrorMessages.ContainsKey(order)) {
            return string.Empty;
        }
        return customErrorMessages[order];
    }
}

对验证器进行一些小的更改

public class OrderValidator : BaseValidator<Order>
{
    public OrderValidator()
    {
        //here I call the custom validation method and I try to add the CustomInfo string in the message
        RuleFor(order =>     order.ShippingCost).Cascade(CascadeMode.StopOnFirstFailure).NotNull().Must(
            (order, shippingCost) => CheckOrderShippingCost(order, shippingCost)
        ).WithMessage("{PropertyName} not set or not correct: {PropertyValue}. {0}", order => order.GetError()));
    }

    //this is the custom validation method
    private bool CheckOrderShippingCost(Order o, decimal shippingCost)
    {
        bool res = false;

        try
        {
            /*
             * check the actual shippingCost and set the res value
             */
        }
        catch (Exception ex)
        {
            order.SetError(ex.ToString());
            res = false;
        }
        return res;
    }
}

评论

0赞 Alberto De Caro 8/7/2014
好点子。虽然我不被允许修改订单结构。此外,我认为任何验证信息都应该与验证器相关,而不是与已验证的对象相关。
0赞 Icepickle 8/7/2014
您可以创建一个完全继承 Order 类的 OrderWithInfo 类,并在设置或从该类获取信息时进行转换?由于规则是在构造函数中定义的,因此除了要验证的对象之外,似乎很难使用其他任何东西
0赞 Icepickle 8/7/2014
在端节点上,如果可以添加一个扩展方法,该方法会获取错误并设置错误,则不会对订单类进行任何更改,并且可以通过使用order => order.GetError()