流畅的动态消息验证

Question

我正在尝试在流畅验证库中构建带有动态消息的自定义验证。

例如:

public class CreateProcessValidator : AbstractValidator<CreateProcessVM>
{
    public CreateProcessValidator()
    {
        RuleFor(x => x.ProcessFile).Must((x,e) => IsProcessFileValid(x.ProcessFile))).WithMessage("Parse failed with error : {0}");        
    }
    public bool IsProcessFileValid(HttpPostedFileBase file)
    {
        var errorMessage = "..."  // pass result to validaton message ?
        // logic
        return false;
    }
}

是否有解决方法来传递验证结果?

谢谢

Answer 1

你试过这样的方法吗?

public class IsProcessFileValid : PropertyValidator
{
    public IsProcessFileValid(): base("{ValidationMessage}") {}
    protected override IsValid(PropertyValidatorContext context)
    {
        if (!IsProcessFileValid1(context))
            context.MessageFormatter.AppendArgument("ValidationMessage",
                "Custom validation message #1");
        if (!IsProcessFileValid2(context))
            context.MessageFormatter.AppendArgument("ValidationMessage",
                "Custom validation message #2");
        // ...etc
        return true;
    }
    private bool IsProcessFileValid1(PropertyValidatorContext context)
    {
        // logic
        return false;
    }
    private bool IsProcessFileValid2(PropertyValidatorContext context)
    {
        // logic
        return false;
    }
    // ...etc
}

带扩展方法:

public static class IsProcessFileValidExtensions
{
    public static IRuleBuilderOptions<T, object> MustBeValidProcessFile<T>
        (this IRuleBuilder<T, object> ruleBuilder)
    {
        return ruleBuilder.SetValidator(new IsProcessFileValid());
    }
}

…然后使用它没有自定义的WithMessage:

public CreateProcessValidator()
{
    RuleFor(x => x.ProcessFile).MustBeValidProcessFile();        
}

通过创建自定义PropertyValidator，您可以将默认验证消息封装在该类中，并使其动态。但是，在声明RuleFor时一定不能使用.WithMessage扩展，因为这会覆盖您直接在PropertyValidator中自定义的默认验证消息。

Answer 2

面对同样的问题，而试图插入异常消息到WithMessage()。它与以Func<T, string> messageProvider为参数的方法重载一起工作。

下面是海报示例中的解决方案(工作代码，FluentValidation v 9.1):

public class CreateProcessVM
{
    public object ProcessFile { get; set; }
}
public class CreateProcessValidator : AbstractValidator<CreateProcessVM>
{
    public CreateProcessValidator()
    {
        var message = "Something went wrong.";
        RuleFor(x => x.ProcessFile)
            .Must((x, e) => IsProcessFileValid(x.ProcessFile, out message))
            // .WithMessage(message); will NOT work
            .WithMessage(x => message); //Func<CreateProcessVM, string> as parameter
    }
    public bool IsProcessFileValid(object file, out string errorMessage)
    {
        errorMessage = string.Empty;
        try
        {
            Validate(file);
            return true;
        }
        catch (InvalidOperationException e)
        {
            errorMessage = e.Message;
            return false;
        }
    }
    private void Validate(object file)
    {
        throw new InvalidOperationException("File of type .custom is not allowed.");
    }
}

和一个测试，证明我们确实在错误消息中得到了异常消息:

[Fact]
public void Test()
{
    var validator = new CreateProcessValidator();
    var result = validator.Validate(new CreateProcessVM());
    Assert.False(result.IsValid);
    Assert.Equal("File of type .custom is not allowed.", result.Errors[0].ErrorMessage);
}

Answer 3

我是这样解决的。使用FluentValidation v8.5.0进行测试

class EmptyValidationMessage : IStringSource
{
    public string ResourceName => null;
    public Type ResourceType => null;
    public string GetString(IValidationContext context)
    {
        return string.Empty;
    }
    public static readonly EmptyValidationMessage Instance = new EmptyValidationMessage();
}
public class MyPropValidator : PropertyValidator
{
    public MyPropValidator() : base(EmptyValidationMessage.Instance)
    {
    }
    protected override bool IsValid(PropertyValidatorContext context)
    {
        // if not valid
        Options.ErrorMessageSource = new StaticStringSource("my message");
        // you can do LanguageStringSource, LazyStringSource, LocalizedStringSource, etc
        // example with localized string (https://github.com/clearwaterstream/LocalizedString.FluentValidation)
        Options.ErrorMessageSource = new LocalizedStringSource("my message").InFrench("moi message");
        return false;
    }
}

Answer 4

没有办法。我会将您目前拥有的复杂验证方法拆分为更小的方法(IsProcessFileValid1、IsProcessFileValid2、IsProcessFileValid3，…)，这样您就可以对错误消息进行更细粒度的控制。此外，每个方法将只负责验证一次关注，使它们更可重用(单一责任):

RuleFor(x => x.ProcessFile)
    .Must(IsProcessFileValid1)
    .WithMessage("Message 1")
    .Must(IsProcessFileValid2)
    .WithMessage("Message 2")
    .Must(IsProcessFileValid3)
    .WithMessage("Message 3");

还请注意我是如何简化lambda的，因为该方法可以直接作为参数传递给Must。