Как использовать IValidatableObject?

Я понимаю, что 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.
             */ 
        }
    }
}

ОТВЕТЫ

Ответ 1

Прежде всего, спасибо @paper1337 за то, что указали мне нужные ресурсы... Я не зарегистрирован, поэтому я не могу его проголосовать, пожалуйста, сделайте это, если кто-нибудь еще прочтет это.

Здесь, как выполнить то, что я пытался сделать.

Validatable class:

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 является ложным, проверяются только свойства с атрибутом [Required]. Это позволяет методу IValidatableObject.Validate() обрабатывать условные проверки.

Ответ 2

Цитата из Сообщение Джеффа Хэндли о публикации объектов и свойств проверки с помощью Validator:

При проверке объекта, следующий процесс применяется в Validator.ValidateObject:

  • Подтвердить атрибуты уровня собственности
  • Если какие-либо валидаторы недействительны, прекратите проверку, возвращая недостаточность (ы)
  • Подтвердить атрибуты уровня объекта
  • Если какие-либо валидаторы недействительны, прекратите проверку, возвращая недостаточность (ы)
  • Если на рабочем столе и на объекте реализовано IValidatableObject, затем вызовите его Подтвердить метод и вернуть недостаточность (ы)

Это означает, что то, что вы пытаетесь сделать, не будет работать из-за-коробки, потому что проверка будет отменена на шаге 2. Вы можете попытаться создать атрибуты, которые наследуются от встроенных, и специально проверить наличие включенного свойства (через интерфейс) перед выполнением их обычной проверки. В качестве альтернативы вы можете поместить всю логику для проверки объекта в методе Validate.

Ответ 3

Просто добавьте пару пунктов:

Поскольку подпись метода Validate() возвращает IEnumerable<>, yield return может использоваться для ленивого генерации результатов - это полезно, если некоторые проверки проверяют интенсивность ввода-вывода или процессора.

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

Ответ 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;
        }


    }
}

Ответ 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;
    }
}

Ответ 6

Мне понравился ответ 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;
    }
}

Это работает намного лучше! Он не сбой и создает приятное сообщение об ошибке. Надеюсь, это поможет кому-то!