使用 FluentValidation/MVC 3 验证客户端上的复选框

Question

我正在尝试验证是否使用 FluentValidation 在客户端上选中了复选框。我一辈子都想不通。

可以使用不显眼的验证来完成吗？

Answer 1

假设您有以下模型：

[Validator(typeof(MyViewModelValidator))]
public class MyViewModel
{
    public bool IsChecked { get; set; }
}

使用以下验证器：

public class MyViewModelValidator : AbstractValidator<MyViewModel>
{
    public MyViewModelValidator()
    {
        RuleFor(x => x.IsChecked).Equal(true).WithMessage("Please check this checkbox");
    }
}

和一个控制器：

public class HomeController : Controller
{
    public ActionResult Index()
    {
        return View();
    }

    [HttpPost]
    public ActionResult Index(MyViewModel model)
    {
        return View(model);
    }
}

有对应的视图：

@model MyViewModel
@using (Html.BeginForm())
{
    @Html.LabelFor(x => x.IsChecked)
    @Html.CheckBoxFor(x => x.IsChecked)
    @Html.ValidationMessageFor(x => x.IsChecked)
    <button type="submit">OK</button>
}

并且在Global.asax 中您已经注册了流畅的验证模型验证器提供者：

FluentValidationModelValidatorProvider.Configure();

到目前为止，我们已经启动了服务器端验证并且运行良好。那挺好的。这始终是我们必须设置的第一部分。我见过人们过于关注客户端验证，以至于他们忘记了服务器端验证，当你禁用 javascript（或者如果你偶然发现一个怀有恶意的用户时更糟），那么糟糕的事情就会发生。 到目前为止，我们很有信心，因为我们知道即使客户端出现问题，我们的域也会受到服务器端验证的保护。

---

现在让我们来处理客户端验证。开箱即用的 FluentValidation.NET 支持 EqualTo 验证器的自动客户端验证，但在与另一个属性值进行比较时，它相当于 [Compare] 数据注释。

但在我们的例子中，我们是在与一个固定值进行比较。所以我们没有开箱即用的客户端验证。当我们没有从盒子里拿出东西时，我们需要把它放进盒子里。

所以我们首先定义一个自定义的 FluentValidationPropertyValidator：

public class EqualToValueFluentValidationPropertyValidator : FluentValidationPropertyValidator
{
    public EqualToValueFluentValidationPropertyValidator(ModelMetadata metadata, ControllerContext controllerContext, PropertyRule rule, IPropertyValidator validator)
        : base(metadata, controllerContext, rule, validator)
    {
    }

    public override IEnumerable<ModelClientValidationRule> GetClientValidationRules()
    {
        if (!this.ShouldGenerateClientSideRules())
        {
            yield break;
        }
        var validator = (EqualValidator)Validator;

        var errorMessage = new MessageFormatter()
            .AppendPropertyName(Rule.GetDisplayName())
            .AppendArgument("ValueToCompare", validator.ValueToCompare)
            .BuildMessage(validator.ErrorMessageSource.GetString());

        var rule = new ModelClientValidationRule();
        rule.ErrorMessage = errorMessage;
        rule.ValidationType = "equaltovalue";
        rule.ValidationParameters["valuetocompare"] = validator.ValueToCompare;
        yield return rule;
    }
}

我们将在Application_Start注册：

FluentValidationModelValidatorProvider.Configure(provider =>
{
    provider.AddImplicitRequiredValidator = false;
    provider.Add(typeof(EqualValidator), (metadata, context, description, validator) => new EqualToValueFluentValidationPropertyValidator(metadata, context, description, validator));
});

到目前为止，我们已将自定义 FluentValidationPropertyValidator 与 EqualValidator 相关联。

最后一部分是编写自定义适配器：

(function ($) {
    $.validator.unobtrusive.adapters.add('equaltovalue', ['valuetocompare'], function (options) {
        options.rules['equaltovalue'] = options.params;
        if (options.message != null) {
            options.messages['equaltovalue'] = options.message;
        }
    });

    $.validator.addMethod('equaltovalue', function (value, element, params) {
        if ($(element).is(':checkbox')) {
            if ($(element).is(':checked')) {
                return value.toLowerCase() === 'true';
            } else {
                return value.toLowerCase() === 'false';
            }
        }
        return params.valuetocompare.toLowerCase() === value.toLowerCase();
    });
})(jQuery);    

差不多就是这样。剩下的就是包含客户端脚本：

<script src="@Url.Content("~/Scripts/jquery.validate.js")" type="text/javascript"></script>
<script src="@Url.Content("~/Scripts/jquery.validate.unobtrusive.js")" type="text/javascript"></script>
<script src="@Url.Content("~/Scripts/customadapter.js")" type="text/javascript"></script>

Answer 2

我喜欢 Darin Dimitrov 的回答，但如果你想快速完成，这是我的替代方法。

在您的模型中创建一个附加属性，例如：

public bool ValidationTrue { get; set; }

并在模型的构造函数中将其值设置为true。

在您的视图中使用它来保存请求中的值：

@Html.HiddenFor(x => x.ValidationTrue)

现在添加这样的验证规则：

public class MyViewModelValidator : AbstractValidator<MyViewModel>
{
    public MyViewModelValidator()
    {
        RuleFor(x => x.ValidationTrue)
            .Equal(true); // check it for security reasons, if someone has edited it in the source of the page

        RuleFor(x => x.HasToBeChecked)
            .Equal(x => x.ValidationTrue) // HasToBeChecked has to have the same value as ValidationTrue (which is always true)
            .WithMessage("Required");
    }
}

开箱即用的非侵入式验证器支持该验证。

Answer 3

我在 ASP.NET MVC5 中编码，当涉及复选框时，Darin 的代码会在引用 value.ToLowerCase() 的行上产生一个 javascript 错误。另一个问题是此代码使两个属性之间的客户端相等比较无效。它似乎只在与字面值比较时才有效......这可能是他的意图，但我需要它适用于两种情况：

这是一种可能的解决方法，只涉及对达林回答的两个更改：

首先，我用以下内容更新了 javascript 函数。

$.validator.addMethod('equaltovalue', function (value, element, params) {
    if ($(element).is(':checkbox')) {
        value = $(element).is(':checked') ? "true" : "false";
    }
    return params.valuetocompare.toLowerCase() === value.toLowerCase();
});

其次，我用以下内容更新了 EqualToValueFluentValidationPropertyValidator：

public class EqualToValueFluentValidationPropertyValidator : FluentValidationPropertyValidator
{
    EqualValidator EqualValidator 
    {
        get { return (EqualValidator)Validator; }
    }

    public EqualToValueFluentValidationPropertyValidator(ModelMetadata metadata, ControllerContext controllerContext, PropertyRule rule, IPropertyValidator validator) : base(metadata, controllerContext, rule, validator) {
        ShouldValidate = false;
    }

    public override IEnumerable<ModelClientValidationRule> GetClientValidationRules() {
        if (!ShouldGenerateClientSideRules()) yield break;

        var propertyToCompare = EqualValidator.MemberToCompare as PropertyInfo;
        if(propertyToCompare != null) {
            // If propertyToCompare is not null then we're comparing to another property.
            // If propertyToCompare is null then we're either comparing against a literal value, a field or a method call.
            // We only care about property comparisons in this case.

            var comparisonDisplayName =
                ValidatorOptions.DisplayNameResolver(Rule.TypeToValidate, propertyToCompare, null)
                ?? propertyToCompare.Name.SplitPascalCase();

            var formatter = new MessageFormatter()
                .AppendPropertyName(Rule.GetDisplayName())
                .AppendArgument("ComparisonValue", comparisonDisplayName);


            string message = formatter.BuildMessage(EqualValidator.ErrorMessageSource.GetString());
            yield return new ModelClientValidationEqualToRule(message, CompareAttribute.FormatPropertyForClientValidation(propertyToCompare.Name)) ;
        }
        else
        {
            var validator = (EqualValidator)Validator;

            var errorMessage = new MessageFormatter()
                .AppendPropertyName(Rule.GetDisplayName())
                .AppendArgument("ValueToCompare", validator.ValueToCompare)
                .BuildMessage(validator.ErrorMessageSource.GetString());

            var rule = new ModelClientValidationRule();
            rule.ErrorMessage = errorMessage;
            rule.ValidationType = "equaltovalue";
            rule.ValidationParameters["valuetocompare"] = validator.ValueToCompare;
            yield return rule;
        }
    }
}

这段代码是从fluentvalidation源码中的EqualToFluentValidationPropertyValidator内部类复制过来的，我在else后面加上了Darin的逻辑。这允许客户端验证用于属性比较和值比较......我不确定这是否是一个很好的方法，因为你基本上覆盖了内置的相等验证器并且它可能会在未来的版本中中断流畅的验证....但达林的回答有同样的问题。

可能有更好的方法来处理这个问题。如果有人知道直接包含来自内部 EqualToFluentValidationPropertyValidator 类的逻辑的方法，那么我很想听听。

Answer 4

它基于@cryss 回答

RuleFor(x => x.HasToBeChecked)
        .Equal(x => true)
        .WithMessage("Required");

你不需要使用额外的属性