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

TypeName	UriPropertiesShouldNotBeStrings
CheckId	CA1056
Kategoria	Microsoft.Design
Złamanie zmiany	Złamanie

Przyczyna

Typ deklaruje właściwość ciąg, którego nazwa zawiera "uri", "Uri", "urn", "Urn", "adres url" lub "Adres Url".

Opis reguły

Ta reguła dzielony nazwa właściwości tokeny na podstawie Konwencji języka Pascal obudowy i sprawdza, czy każdy token jest równa "uri", "Uri", "urn", "Urn", "adres url" lub "Adres Url".W przypadku dopasowania, reguła zakłada, że właściwość reprezentuje jednolitym identyfikatorem zasobów (URI).Reprezentację ciągu identyfikatora URI jest podatna na analizowanie i błędów kodowania i może prowadzić do luk w zabezpieczeniach.System.Uri Klasy świadczy te usługi w bezpieczny sposób.

Jak naprawić naruszenia

Aby usunąć naruszenie tej zasady, należy zmienić właściwość, aby Uri typu.

Kiedy do pomijania ostrzeżenia

Bezpiecznie wyłączyć ostrzeżenie od tej reguły, jeśli właściwość nie reprezentuje identyfikatora URI.

Przykład

W poniższym przykładzie pokazano typu, ErrorProne, który narusza reguły i typ, SaferWay, która 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");
      }
   };
}

Zasady pokrewne

CA1054: Parametry URI nie powinny być ciągi

CA1055: URI zwracać wartości nie powinny być ciągi

CA2234: Pass System.Uri obiektów zamiast z ciągów znaków

CA1057: Ciąg URI overloads wywołanie System.Uri overloads