CA1054: URI parametreleri dizeler olmamalıdır

TypeName	UriParametersShouldNotBeStrings
CheckId	CA1054
Kategori	Microsoft.Design
Değişiklik kesiliyor	Bölme

Neden

Bir tür "URI", "Uri", "urn", "Urn", "url" veya "Url" adını içeren bir dize parametresi yöntemiyle bildirir ve türü götüren bir karşılık gelen aşırı bildirmiyor bir Uri parametresi.

Kural Tanımı

Bu kural, camel kasasını kuralına dayanan belirteçler parametre adı bölündüğü ve her token "URI", "Uri", "urn", "Urn", "url" veya "Url" a eşit olup olmadığını denetler.Bir eşleşme varsa, kural parametresi bir Tekdüzen Kaynak Tanımlayıcısı (URI) temsil ettiğini varsayar.Dize halinde temsilini URI ayrıştırma ve hataları kodlama açıktır ve güvenlik açıklarına yol açabilecek.Bir yöntem, URI dize halinde temsilini sürerse, karşılık gelen aşırı örneğini alır, sağlanan olmalıdır Uri güvenli bir şekilde bu hizmetleri sağlayan sınıf.

İhlalleri düzeltmek nasıl

Bu kuralı ihlal düzeltmek için parametre değiştirme bir Uri yazın; Bu bölme farklıdır.Alternatif olarak, aşırı yöntemini yüklenmesini sağlamak bir Uri parametresi; Bu bölünemez bir değişikliktir.

Uyarıları ne zaman

Parametre bir URI'yı temsil etmiyor, bir uyarı bu kuraldan bastırmak güvenlidir.

Örnek

Aşağıdaki örnek, bir tür gösterir ErrorProne, bu kural ve bir tür ihlal ediyor SaferWay, kural karşılar.

Imports System

Namespace DesignLibrary

   Public Class ErrorProne

      Dim someUriValue As String  

      ' Violates rule UriPropertiesShouldNotBeStrings. 
      Property SomeUri As String 
         Get  
            Return someUriValue 
         End Get 
         Set 
            someUriValue = Value 
         End Set 
      End Property 

      ' Violates rule UriParametersShouldNotBeStrings. 
      Sub AddToHistory(uriString As String)
      End Sub 

      ' Violates rule UriReturnValuesShouldNotBeStrings. 
      Function GetRefererUri(httpHeader As String) As String 
         Return "https://www.adventure-works.com" 
      End Function 

   End Class 

   Public Class SaferWay

      Dim someUriValue As Uri 

      ' To retrieve a string, call SomeUri.ToString(). 
      ' To set using a string, call SomeUri = New Uri(string). 
      Property SomeUri As Uri
         Get  
            Return someUriValue 
         End Get 
         Set 
            someUriValue = Value 
         End Set 
      End Property 

      Sub AddToHistory(uriString As String)
         ' Check for UriFormatException.
         AddToHistory(New Uri(uriString))
      End Sub 

      Sub AddToHistory(uriString As Uri)
      End Sub 

      Function GetRefererUri(httpHeader As String) As Uri
         Return New Uri("https://www.adventure-works.com")
      End Function 

   End Class 

End Namespace

using System;

namespace DesignLibrary
{
   public class ErrorProne
   {
      string someUri;

      // Violates rule UriPropertiesShouldNotBeStrings. 
      public string SomeUri
      {
         get { return someUri; }
         set { someUri = value; }
      }

      // Violates rule UriParametersShouldNotBeStrings. 
      public void AddToHistory(string uriString) { }

      // Violates rule UriReturnValuesShouldNotBeStrings. 
      public string GetRefererUri(string httpHeader)
      {
         return "https://www.adventure-works.com";
      }
   }

   public class SaferWay
   {
      Uri someUri;

      // To retrieve a string, call SomeUri.ToString(). 
      // To set using a string, call SomeUri = new Uri(string). 
      public Uri SomeUri
      {
         get { return someUri; }
         set { someUri = value; }
      }

      public void AddToHistory(string uriString)
      {
         // Check for UriFormatException.
         AddToHistory(new Uri(uriString));
      }

      public void AddToHistory(Uri uriType) { }

      public Uri GetRefererUri(string httpHeader)
      {
         return new Uri("https://www.adventure-works.com");
      }
   }
}

#using <system.dll>
using namespace System;

namespace DesignLibrary
{
   public ref class ErrorProne
   {
   public:
      // Violates rule UriPropertiesShouldNotBeStrings. 
      property String^ SomeUri;

      // Violates rule UriParametersShouldNotBeStrings. 
      void AddToHistory(String^ uriString) { }

      // Violates rule UriReturnValuesShouldNotBeStrings.
      String^ GetRefererUri(String^ httpHeader)
      {
         return "https://www.adventure-works.com";
      }
   };

   public ref class SaferWay
   {
   public:
      // To retrieve a string, call SomeUri()->ToString(). 
      // To set using a string, call SomeUri(gcnew Uri(string)). 
      property Uri^ SomeUri;

      void AddToHistory(String^ uriString)
      {
         // Check for UriFormatException.
         AddToHistory(gcnew Uri(uriString));
      }

      void AddToHistory(Uri^ uriType) { }

      Uri^ GetRefererUri(String^ httpHeader)
      {
         return gcnew Uri("https://www.adventure-works.com");
      }
   };
}

İlgili kuralları

CA1056: URI özellikleri dizeler olmamalıdır

CA1055: URI dönüş değerleri dizeler olmamalıdır

CA2234: Dizeler yerine System.Uri nesneleri gönderin

CA1057: Dize URI aşırı yüklemeleri System.Uri aşırı yüklemelerini çağırır