c# - 如何使用 IValidatableObject？

Question

我知道它IValidatableObject用于以一种让人们相互比较属性的方式来验证对象。

我仍然希望有属性来验证单个属性，但我想在某些情况下忽略某些属性的失败。

在以下情况下，我是否试图错误地使用它？如果没有，我该如何实现？

public class ValidateMe : IValidatableObject
{
    [Required]
    public bool Enable { get; set; }

    [Range(1, 5)]
    public int Prop1 { get; set; }

    [Range(1, 5)]
    public int Prop2 { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (!this.Enable)
        {
            /* Return valid result here.
             * I don't care if Prop1 and Prop2 are out of range
             * if the whole object is not "enabled"
             */
        }
        else
        {
            /* Check if Prop1 and Prop2 meet their range requirements here
             * and return accordingly.
             */ 
        }
    }
}

score 190 · Accepted Answer

首先，感谢@paper1337 为我指出了正确的资源……我没有注册，所以我不能投票给他，如果其他人读到这个，请这样做。

这是完成我想做的事情的方法。

可验证的类：

public class ValidateMe : IValidatableObject
{
    [Required]
    public bool Enable { get; set; }

    [Range(1, 5)]
    public int Prop1 { get; set; }

    [Range(1, 5)]
    public int Prop2 { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        var results = new List<ValidationResult>();
        if (this.Enable)
        {
            Validator.TryValidateProperty(this.Prop1,
                new ValidationContext(this, null, null) { MemberName = "Prop1" },
                results);
            Validator.TryValidateProperty(this.Prop2,
                new ValidationContext(this, null, null) { MemberName = "Prop2" },
                results);

            // some other random test
            if (this.Prop1 > this.Prop2)
            {
                results.Add(new ValidationResult("Prop1 must be larger than Prop2"));
            }
        }
        return results;
    }
}

如果验证失败，使用Validator.TryValidateProperty()将添加到结果集合中。如果没有失败的验证，则不会将任何内容添加到结果集合中，这表明成功。

进行验证：

    public void DoValidation()
    {
        var toValidate = new ValidateMe()
        {
            Enable = true,
            Prop1 = 1,
            Prop2 = 2
        };

        bool validateAllProperties = false;

        var results = new List<ValidationResult>();

        bool isValid = Validator.TryValidateObject(
            toValidate,
            new ValidationContext(toValidate, null, null),
            results,
            validateAllProperties);
    }

validateAllProperties将此方法设置为 false很重要。当validateAllProperties为 false 时，仅[Required]检查具有属性的属性。这允许该IValidatableObject.Validate()方法处理条件验证。

score 85 · Accepted Answer

引用Jeff Handley 在 Validator 中验证对象和属性的博客文章：

验证对象时，在 Validator.ValidateObject 中应用以下过程：

验证属性级属性

如果任何验证器无效，则中止验证返回失败

验证对象级属性

如果任何验证器无效，则中止验证返回失败

如果在桌面框架上并且对象实现了 IValidatableObject，则调用其 Validate 方法并返回任何失败

这表明您尝试执行的操作不会开箱即用，因为验证将在第 2 步中止。您可以尝试创建从内置属性继承的属性，并在执行正常验证之前专门检查是否存在已启用的属性（通过接口）。或者，您可以将用于验证实体的所有逻辑放入Validate方法中。

您也可以在这里查看Validator类的确切实现

score 39 · Accepted Answer

只是补充几点：

因为Validate()方法签名返回IEnumerable<>，yield return可以用来延迟生成结果 - 如果某些验证检查是 IO 或 CPU 密集型的，这是有益的。

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
{
    if (this.Enable)
    {
        // ...
        if (this.Prop1 > this.Prop2)
        {
            yield return new ValidationResult("Prop1 must be larger than Prop2");
        }

此外，如果您正在使用MVC ModelState，您可以将验证结果失败转换为如下条目（如果您在自定义模型绑定器ModelState中进行验证，这可能很有用）：

var resultsGroupedByMembers = validationResults
    .SelectMany(vr => vr.MemberNames
                        .Select(mn => new { MemberName = mn ?? "", 
                                            Error = vr.ErrorMessage }))
    .GroupBy(x => x.MemberName);

foreach (var member in resultsGroupedByMembers)
{
    ModelState.AddModelError(
        member.Key,
        string.Join(". ", member.Select(m => m.Error)));
}

score 5 · Accepted Answer

我实现了一个用于验证的通用抽象类

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;

namespace App.Abstractions
{
    [Serializable]
    abstract public class AEntity
    {
        public int Id { get; set; }

        public IEnumerable<ValidationResult> Validate()
        {
            var vResults = new List<ValidationResult>();

            var vc = new ValidationContext(
                instance: this,
                serviceProvider: null,
                items: null);

            var isValid = Validator.TryValidateObject(
                instance: vc.ObjectInstance,
                validationContext: vc,
                validationResults: vResults,
                validateAllProperties: true);

            /*
            if (true)
            {
                yield return new ValidationResult("Custom Validation","A Property Name string (optional)");
            }
            */

            if (!isValid)
            {
                foreach (var validationResult in vResults)
                {
                    yield return validationResult;
                }
            }

            yield break;
        }


    }
}

score 0 · Accepted Answer

已接受答案的问题在于，它现在取决于对象的调用者才能正确验证。我要么删除 RangeAttribute 并在 Validate 方法中进行范围验证，要么创建一个自定义属性子类 RangeAttribute，它将所需属性的名称作为构造函数的参数。

例如：

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
class RangeIfTrueAttribute : RangeAttribute
{
    private readonly string _NameOfBoolProp;

    public RangeIfTrueAttribute(string nameOfBoolProp, int min, int max) : base(min, max)
    {
        _NameOfBoolProp = nameOfBoolProp;
    }

    public RangeIfTrueAttribute(string nameOfBoolProp, double min, double max) : base(min, max)
    {
        _NameOfBoolProp = nameOfBoolProp;
    }

    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        var property = validationContext.ObjectType.GetProperty(_NameOfBoolProp);
        if (property == null)
            return new ValidationResult($"{_NameOfBoolProp} not found");

        var boolVal = property.GetValue(validationContext.ObjectInstance, null);

        if (boolVal == null || boolVal.GetType() != typeof(bool))
            return new ValidationResult($"{_NameOfBoolProp} not boolean");

        if ((bool)boolVal)
        {
            return base.IsValid(value, validationContext);
        }
        return null;
    }
}

score 0 · Accepted Answer

我喜欢cocogza 的回答，除了调用 base.IsValid 会导致堆栈溢出异常，因为它会一次又一次地重新输入 IsValid 方法。因此，我将其修改为用于特定类型的验证，在我的情况下，它用于电子邮件地址。

[AttributeUsage(AttributeTargets.Property)]
class ValidEmailAddressIfTrueAttribute : ValidationAttribute
{
    private readonly string _nameOfBoolProp;

    public ValidEmailAddressIfTrueAttribute(string nameOfBoolProp)
    {
        _nameOfBoolProp = nameOfBoolProp;
    }

    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        if (validationContext == null)
        {
            return null;
        }

        var property = validationContext.ObjectType.GetProperty(_nameOfBoolProp);
        if (property == null)
        {
            return new ValidationResult($"{_nameOfBoolProp} not found");
        }

        var boolVal = property.GetValue(validationContext.ObjectInstance, null);

        if (boolVal == null || boolVal.GetType() != typeof(bool))
        {
            return new ValidationResult($"{_nameOfBoolProp} not boolean");
        }

        if ((bool)boolVal)
        {
            var attribute = new EmailAddressAttribute {ErrorMessage = $"{value} is not a valid e-mail address."};
            return attribute.GetValidationResult(value, validationContext);
        }
        return null;
    }
}

这效果更好！它不会崩溃并产生一个很好的错误消息。希望这对某人有帮助！

score 0 · Accepted Answer

我不喜欢 iValidate 的一点是它似乎只在所有其他验证之后运行。
此外，至少在我们的站点中，它会在保存尝试期间再次运行。我建议您简单地创建一个函数并将所有验证代码放入其中。或者，对于网站，您可以在创建模型后在控制器中进行“特殊”验证。例子：

 public ActionResult Update([DataSourceRequest] DataSourceRequest request, [Bind(Exclude = "Terminal")] Driver driver)
    {

        if (db.Drivers.Where(m => m.IDNumber == driver.IDNumber && m.ID != driver.ID).Any())
        {
            ModelState.AddModelError("Update", string.Format("ID # '{0}' is already in use", driver.IDNumber));
        }
        if (db.Drivers.Where(d => d.CarrierID == driver.CarrierID
                                && d.FirstName.Equals(driver.FirstName, StringComparison.CurrentCultureIgnoreCase)
                                && d.LastName.Equals(driver.LastName, StringComparison.CurrentCultureIgnoreCase)
                                && (driver.ID == 0 || d.ID != driver.ID)).Any())
        {
            ModelState.AddModelError("Update", "Driver already exists for this carrier");
        }

        if (ModelState.IsValid)
        {
            try
            {

score 0 · Accepted Answer

使用 IValidatableObject 或属性级验证（属性）实现验证逻辑，而不是像这样使用 System.ComponentModel.DataAnnotations.Validator 类

var validationContext = new ValidationContext(model,, null, null);
var validations = new Collection<ValidationResult>();
Validator.TryValidaObject(model, validationContext, validations, true)

验证集合中应存在任何错误（ErrorMessage 属性不应为空）。

https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.dataannotations.validator?view=net-6.0

c# - 如何使用 IValidatableObject？

8 回答 8

Related

Reference