如何使用 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.
             */ 
        }
    }
}

Answer 1

首先，感谢@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()

方法处理条件验证。

Answer 2

引自 Jeff Handley 关于使用验证器验证对象和属性的博客文章：

验证对象时，以下过程应用于验证器.ValidateObject：

验证属性级属性

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

验证对象级属性

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

如果在桌面框架上并且对象实现 IValidatableObject，然后调用它的验证方法并返回任何失败

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

Validate

方法中。

您还可以查看

Validator

类的具体实现这里

Answer 3

补充几点：

因为

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)));
}

Answer 4

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

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;
        }


    }
}

Answer 5

已接受答案的问题在于，它现在取决于调用者来正确验证对象。我要么删除 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;
    }
}

Answer 6

使用 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://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.dataannotations.validator?view=net-6.0

Answer 7

你可以让它变得更简单。

假设我们有两个属性：经度和纬度。它们都是必需的，但前提是其中之一被提交。（如果我们填写经度，我们还需要提供纬度，反之亦然）

在类中继承IValidatableObject并实现validate方法

public class MyLocationModel: IValidatableObject

    {
    
public decimal? Longitude { get; set; }

public decimal? Latitude { get; set; }
    
    
             public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
        {
                    if (Latitude.HasValue && !Longitude.HasValue)
                        yield return new ValidationResult(errorMessage: "Longitude is required if latitude is filled in.", new[] { nameof(Longitude) });
        
                    if (Longitude.HasValue && !Latitude.HasValue)
                        yield return new ValidationResult(errorMessage: "Latitude is required if longitude is filled in.", new[] { nameof(Latitude) });
        }
        }

如果您验证 MyLocationModel 的实例，规则将自动应用:)

完整解释这里。

Answer 8

我喜欢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;
    }
}

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

Answer 9

我不喜欢 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
            {

如何使用 IValidatableObject？

问题描述投票：0回答：9

9个回答

最新问题

如何使用 IValidatableObject？

问题描述 投票：0回答：9

9个回答

最新问题

问题描述投票：0回答：9