2010-08-03 17 views
136

मुझे लगता है कि 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. 
     */ 
    } 
} 
} 

उत्तर

133

सबसे पहले, मुझे सही संसाधनों की ओर इशारा करते के लिए @ paper1337 करने के लिए धन्यवाद ... मैं कर रहा हूँ पंजीकृत नहीं तो मैं उसे वोट नहीं कर सकते हैं, किसी और इस पढ़ता है यदि ऐसा है तो कृपया।

यहां बताया गया है कि मैं क्या करने की कोशिश कर रहा था।

Validatable वर्ग:

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 गलत है तो केवल [Required] विशेषता वाले गुण चेक किए गए हैं। यह IValidatableObject.Validate() विधि सशर्त सत्यापन को संभालता है।क्योंकि Validate() विधि हस्ताक्षर रिटर्न IEnumerable<>

, कि yield return lazily परिणाम उत्पन्न करने के लिए इस्तेमाल किया जा सकता है - यह लाभदायक है अगर सत्यापन जांच के कुछ आईओ हैं या CPU गहन:

+0

मैं ऐसे परिदृश्य के बारे में सोच नहीं सकता जहां मैं इसका उपयोग करूंगा। क्या आप मुझे इसका उदाहरण दे सकते हैं कि आप इसका उपयोग कहां करेंगे? –

+0

यदि आपके पास अपनी तालिका में कॉलम ट्रैक कर रहे हैं (जैसे उपयोगकर्ता ने इसे बनाया है)। डेटाबेस में यह आवश्यक है लेकिन आप इसे संदर्भित करने के लिए संदर्भ में SaveChanges में कदम उठाते हैं (डेवलपर्स को इसे स्पष्ट रूप से सेट करने के लिए याद रखने की आवश्यकता को समाप्त करना)। आप निश्चित रूप से, बचत से पहले मान्य करेंगे। तो आप आवश्यकतानुसार "निर्माता" कॉलम को चिह्नित नहीं करते हैं लेकिन अन्य सभी कॉलम/गुणों के विरुद्ध मान्य करते हैं। – MetalPhoenix

+0

इस समाधान के साथ समस्या यह है कि अब आप अपनी ऑब्जेक्ट को उचित रूप से सत्यापित करने के लिए कॉलर पर निर्भर करते हैं। – cocogza

67

Jeff Handley's Blog Post on Validation Objects and Properties with Validator से उद्धरण:

जब एक वस्तु को मान्य, निम्नलिखित प्रक्रिया Validator.ValidateObject में लागू किया जाता है:

  1. मान्य प्रॉपर्टी-स्तरीय गुण
  2. हैं कोई भी वैधकर्ता अमान्य है,लौटा सत्यापन रद्द करेंविफलता (ओं)
  3. मान्य वस्तु स्तर के जिम्मेदार बताते हैं
  4. किसी भी प्रमाणकों अमान्य हैं, सत्यापन, तो डेस्कटॉप ढांचे पर विफलता (ओं)
  5. लौटने और वस्तु को लागू करता है IValidatableObject गर्भपात, तो इसकी मान्य विधि कॉल और किसी भी विफलता (ओं) लौट

यह बताता है कि क्या आप करने का प्रयास कर रहे हैं बॉक्स के बाहर काम नहीं करेंगे क्योंकि सत्यापन चरण # 2 पर निरस्त हो जाएगा। आप उन अंतर्निहित विशेषताओं को बनाने का प्रयास कर सकते हैं जो अंतर्निहित लोगों से प्राप्त होते हैं और विशेष रूप से सक्षम सत्यापन करने से पहले सक्षम संपत्ति (इंटरफ़ेस के माध्यम से) की उपस्थिति की जांच करते हैं। वैकल्पिक रूप से, आप Validate विधि में इकाई को मान्य करने के लिए सभी तर्क डाल सकते हैं।

+2

+1 जानकारी जानना अच्छा है! – HOKBONG

26

बस अंक के एक जोड़े को जोड़ने के लिए।

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 प्रविष्टियों के रूप में इस प्रकार है (इस उपयोगी यदि आप एक custom model binder में सत्यापन कर रहे हैं हो सकता है) में बदल सकते हैं:

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

अच्छा है! वैध विधि में गुणों और प्रतिबिंब का उपयोग करना सार्थक है? – Schalk

3

मैं सत्यापन के लिए एक सामान्य उपयोग के सार वर्ग कार्यान्वित

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

मुझे नामित पैरामीटर का उपयोग करने की उस शैली से प्यार है, कोड को पढ़ने के लिए बहुत आसान बनाता है। – drizin

0

स्वीकार किए जाते हैं जवाब के साथ समस्या यह है कि अब इस पर निर्भर करता है ऑब्जेक्ट को उचित रूप से सत्यापित करने के लिए कॉलर। मैं या तो रेंज एट्रिब्यूट को हटा दूंगा और वैलिडेट विधि के अंदर रेंज सत्यापन करूँगा या मैं रेंज एट्रिब्यूट को एक कस्टम एट्रिब्यूट सबक्लासिंग कर दूंगा जो आवश्यक संपत्ति का नाम कन्स्ट्रक्टर पर तर्क के रूप में लेता है।

उदाहरण के लिए:

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

मैं छोड़कर cocogza's answer पसंद आया कि बुला base.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; 
    } 
} 

यह बहुत बेहतर काम करता है! यह क्रैश नहीं होता है और एक अच्छा त्रुटि संदेश उत्पन्न करता है। उम्मीद है कि यह किसी की मदद करता है!

संबंधित मुद्दे