CA1054: Parametry identyfikatora URI nie powinny być ciągami

TypeName	UriParametersShouldNotBeStrings
CheckId	CA1054
Kategoria	Microsoft.Design
Zmiana kluczowa	Kluczowa

Przyczyna

Typ deklaruje metodę, z parametrem będącym ciągiem, którego nazwa zawiera "uri", "Uri", "urn", "Urn", "url" lub "Url"; a typ nie deklaruje odpowiedniego przeciążenia metody, która przyjmuje parametr Uri.

Opis reguły

Ta reguła dzieli nazwę parametru na tokeny na podstawie konwencji CamelCase i sprawdza, czy każdy token jest równy "uri", "Uri", "urn", "Urn", "url" lub "Url".W przypadku dopasowania, reguła zakłada, że parametr reprezentuje jednolity identyfikator zasobów (URI).Reprezentacja ciągu identyfikatora URI jest podatna na analizowanie oraz kodowanie błędów i może prowadzić do powstawania luk w zabezpieczeniach.Jeśli metoda pobiera reprezentację ciągu identyfikatora URI, powinno zostać dostarczone odpowiadające przeciążenie pobierające wystąpienie klasy Uri, które dostarcza te usługi w bezpieczny sposób.

Jak naprawić naruszenia

Aby naprawić naruszenie tej zasady, należy zmienić typ parametru na Uri; jest to zmiana kluczowa.Alternatywnie można dostarczyć przeciążenie metody, które przyjmuje parametr Uri; jest to zmiana niekluczowa.

Kiedy pominąć ostrzeżenia

Można bezpiecznie pominąć ostrzeżenie od tej reguły, jeśli parametr nie reprezentuje identyfikatora URI.

Przykład

Poniższy przykład pokazuje typ ErrorProne, który narusza regułę oraz typ SaferWay, który spełnia regułę.

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

Powiązane reguły

CA1056: Właściwości identyfikatora URI nie powinny być ciągami

CA1055: Wartości zwracane identyfikatora URI nie powinny być ciągami

CA2234: Przekaż obiekty System.Uri zamiast ciągów

CA1057: Przeciążenia identyfikatora URI, który jest ciągiem, wywołują przeciążenia System.Uri