Как я могу использовать IValidatableObject? - PullRequest
Новая
       30

Как я могу использовать IValidatableObject?

156 голосов
/ 04 августа 2010

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

Ответы [ 6 ]

150 голосов
/ 04 августа 2010

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

76 голосов
/ 04 августа 2010

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

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

  1. Проверка атрибутов уровня свойства
  2. Если какие-либо валидаторы недействительны, прервать валидацию, возвращая отказ (s)
  3. Проверка атрибутов уровня объекта
  4. Если какие-либо валидаторы недействительны, прервать валидацию, возвращая отказ (s)
  5. Если на десктопе фреймворк и объект реализует IValidatableObject, затем вызовите его Подтвердите метод и верните любой недостаточность (ы)

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

31 голосов
/ 26 марта 2014

Просто добавим пару пунктов:

Поскольку сигнатура метода 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)));
}
3 голосов
/ 21 ноября 2015

Я реализовал абстрактный класс общего использования для проверки 

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


    }
}
0 голосов
/ 17 мая 2017

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

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

0 голосов
/ 01 марта 2017

Проблема с принятым ответом состоит в том, что теперь от вызывающего объекта зависит правильность проверки объекта. Я бы либо удалил 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;
    }
}
...