ContractArgumentValidatorAttribute Sınıf

Tanım

Ad Alanı:

System.Diagnostics.Contracts

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Diagnostics.Contracts.dll

Kaynak:

Contracts.cs

Eski if-then-throw kodunun yeniden kullanım için ayrı yöntemlere ayrılmasına olanak tanır ve oluşan özel durumlar ve bağımsız değişkenler üzerinde tam denetim sağlar.

public ref class ContractArgumentValidatorAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)]
[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public sealed class ContractArgumentValidatorAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)>]
[<System.Diagnostics.Conditional("CONTRACTS_FULL")>]
type ContractArgumentValidatorAttribute = class
    inherit Attribute

Public NotInheritable Class ContractArgumentValidatorAttribute
Inherits Attribute

Devralma

Object

Attribute

ContractArgumentValidatorAttribute

Öznitelikler

AttributeUsageAttribute ConditionalAttribute

Açıklamalar

Kodunuz parametreleri doğrulamak için açık if-then-throw kod kullanıyorsa, aşağıdaki örnekte gösterildiği gibi denetimler gerçekleştiren ve hatada belirli özel durumlar oluşturan yardımcı yöntemleri kullanıyor olabilirsiniz.

using System;

static class ValidationHelper
{
   public static void NotNull(object argument, string parameterName)
   {
      if (argument == null) throw new ArgumentNullException(parameterName,
                                                            "The parameter cannot be null.");
   }
}

public class Example
{
   public void Execute(string value)
   {
      ValidationHelper.NotNull(value, "value");

      // Body of method goes here.
   }
}

Class ValidationHelper 
   Public Shared Sub NotNull(argument As Object, parameterName As String) 
      If argument Is Nothing Then 
         Throw New ArgumentNullException(parameterName, 
                                         "The parameter cannot be null.")
      End If
   End Sub
End Class

Module Example
   Public Sub Execute(value As String)
      ValidationHelper.NotNull(value, "value")
      
      ' Body of method goes here.
   End Sub
End Module

Bu örnekte, Execute parametre değerinin olmaması gerektiğini belirten seçmeli bir önkoşulu vardır null. Sözleşme araçlarının çağrısının bir sözleşmeyi temsil ettiğini algılamasını sağlamak için ValidationHelper.NotNull , çağrılan yöntemi özniteliğiyle ContractArgumentValidatorAttribute işaretleyebilirsiniz. Yöntem çağrısı, Contract.EndContractBlock aşağıdaki gibi, araçların belge oluşturma ve statik denetim için uygun belirtimleri ayıklamasını sağlamak için kullanılmalıdır.

using System;
using System.Diagnostics.Contracts;

static class ValidationHelper
{
   [ContractArgumentValidator]
   public static void NotNull(object argument, string parameterName)
   {
      if (argument == null) throw new ArgumentNullException(parameterName,
                                                            "The parameter cannot be null.");
      Contract.EndContractBlock();
   }
}

Imports System.Diagnostics.Contracts

Class ValidationHelper 
   <ContractArgumentValidator> 
   Public Shared Sub NotNull(argument As Object, parameterName As String) 
      If argument Is Nothing Then 
         Throw New ArgumentNullException(parameterName, 
                                         "The parameter cannot be null.")
         Contract.EndContractBlock()
      End If
   End Sub
End Class

Deyimlere if-then-throw ek olarak, sözleşme doğrulayıcı yöntemlerinin sözleşme bölümü diğer sözleşme doğrulayıcı yöntemlerine çağrılar içerebilir. Ancak, başka hiçbir sözleşmeye (örneğin Contract.Requires, veya Contract.Ensures) izin verilmez. Çağrıyı Contract.EndContractBlock izleyen kod tüm sözleşme araçları tarafından yoksayılır.

Aşağıdaki örnekte, var olan NotNull bir doğrulayıcı yöntemiyle yazılmış bir aralık bağımsız değişken doğrulayıcısı gösterilmektedir.

using System;
using System.Diagnostics.Contracts;

static class ValidationHelper
{
   [ContractArgumentValidator]
   public static void NotNull(object argument, string parameterName)
   {
      if (argument == null) throw new ArgumentNullException(parameterName,
                                                            "The parameter cannot be null.");
      Contract.EndContractBlock();
   }

   [ContractArgumentValidator]
   public static void InRange(object[] array, int index, string arrayName, string indexName)
   {
      NotNull(array, arrayName);

      if (index < 0)
         throw new ArgumentOutOfRangeException(indexName,
                                               "The index cannot be negative.");
      if (index >= array.Length)
         throw new ArgumentOutOfRangeException(indexName,
                                               "The index is outside the bounds of the array.");
      Contract.EndContractBlock();
   }
}

public class Example
{
   public void Execute(object[] data, int position)
   {
      ValidationHelper.InRange(data, position, "data", "position");

      // Body of method goes here.
   }
}

Imports System.Diagnostics.Contracts

Class ValidationHelper 
   <ContractArgumentValidator> 
   Public Shared Sub NotNull(argument As Object, parameterName As String) 
      If argument Is Nothing Then 
         Throw New ArgumentNullException(parameterName, 
                                         "The parameter cannot be null.")
         Contract.EndContractBlock()
      End If
   End Sub

   <ContractArgumentValidator>
   Public Shared Sub InRange(array() As Object, index As Integer, 
                             arrayName As String, indexName As String)
      NotNull(array, arrayName)
      
      If index < 0 Then 
         Throw New ArgumentOutOfRangeException(indexName, 
                                               "The index cannot be negative.")
      End If                                         
      If index >= array.Length Then 
         Throw New ArgumentOutOfRangeException(indexName, 
                                               "The index is outside the bounds of the array.")
      End If                                                                                              
      Contract.EndContractBlock()
   End Sub
End Class

Module Example
   Public Sub Execute(data() As Object, position As Integer)
      ValidationHelper.InRange(data, position, "data", "position")
      
      ' Body of method goes here.
   End Sub
End Module

Belirtim açısından Execute yöntem aşağıdaki üç sözleşmeye sahiptir:

Contract.Requires<ArgumentNullException>(data != null);
Contract.Requires<ArgumentOutOfRangeException>(position >= 0);
Contract.Requires<ArgumentOutOfRangeException>(position < data.Length);

Standart yöntemlerde, sözleşme doğrulayıcı yöntemlerine yapılan çağrılar veya Contract.Ensuresgibi Contract.Requires diğer sözleşmelerle serbestçe karıştırılabilir.

Oluşturucular

Name	Description
ContractArgumentValidatorAttribute()	ContractArgumentValidatorAttribute sınıfının yeni bir örneğini başlatır.

Özellikler

Name	Description
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Name	Description
Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğin karma kodunu döndürür. (Devralındığı yer: Attribute)
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)