CA1054: URI parameters should not be strings

TypeName	UriParametersShouldNotBeStrings
CheckId	ca1054
Category	Microsoft.تصميم
تعطيل تغيير	فصل

السبب

تعريف نوع أسلوباً له معلمة سلسلة يحتوي اسمه على "uri" أو "Uri"، "urn"، "Urn"، "URL" أو "URL" و لا النوع الإعلان عن التحميل الزائد المقابلة تأخذ System.Uriالمعلمة.

وصف القاعدة

تقسيم هذه قاعدة اسم المعامل في الرموز المميزة استناداً اصطلاح لحالة الأحرف camel و التحقق ما إذا كانت تساوي كل رمز "uri" أو "Uri"، "urn"، "Urn"، "URL" أو "URL". إذا كان هناك تطابق، قاعدة يفترض أن يمثل معلمة هو معرّف موارد منتظم (URI). تمثيل سلسلة URI هو عرضه لتحليل الأخطاء، والترميز ويمكن أن يؤدي إلى مشاكل عدم حصانة الأمان. إذا استغرق أسلوب تمثيل سلسلة URI، التحميل الزائد المقابل يجب أن يتم توفير التي تأخذ مثيل Uriفئة، والذي يوفر هذه الخدمات في اﻷمن و الأمن الطريقة.

كيف إلى الإصلاح انتهاكات

لإصلاح انتهاكا لهذه قاعدة، قم بتغيير معلمة إلى Uriاكتب؛ هذا هو تغيير الامتداد. بدلاً من ذلك، تقدم التحميل الزائد الأسلوب الذي يكون Uriمعلمة؛ هذا هو تغيير غير منقسمة.

عند إلى منع التحذيرات

هو آمن لمنع ظهور تحذير من القيم بالموضع هو قاعدة إذا كانت معلمة لا تمثل URI.

مثال

يوضح المثال التالي نوع، ErrorProne، التي تخالف هذه قاعدة، نوع، SaferWay، الذي يفي بقاعدة.

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

القواعد ذات الصلة

ca1056: لا يجب أن يكون URI خصائص السلاسل

ca1055: إرجاع URI لا يجب أن تكون قيم سلاسل

ca2234: تمرير الكائنات النظام.Uri بدلاً من السلاسل

CA1057: String URI overloads call System.Uri overloads