CA2234: Übergeben Sie System.Uri-Objekte anstelle von Zeichenfolgen.

  • Artikel
Eigenschaft Wert
Regel-ID CA2234
Titel Übergeben Sie System.Uri-Objekte anstelle von Zeichenfolgen.
Kategorie Verwendung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Aufruf erfolgt an eine Methode mit einem Zeichenfolgenparameter, dessen Name „uri“, „Uri“, „urn“, „Urn“, „url“ oder „Url“ enthält. Der deklarierende Typ der Methode enthält eine entsprechende Methodenüberladung mit einem System.Uri-Parameter.

Standardmäßig werden mit dieser Regel nur extern sichtbare Methoden und Typen überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

Ein Parametername wird auf Grundlage der Camel-Case-Schreibweise in verschiedene Token aufgeteilt. Im Anschluss wird jedes Token dahingehend geprüft, ob es „uri“, „Uri“, „urn“, „Urn“, „url“ oder „Url“ entspricht. Wenn ein Match gefunden wird, geht man davon aus, dass es sich bei dem Parameter um einen Uniform Resource Identifier (URI) handelt. Eine Zeichenfolgendarstellung eines URIs ist anfällig für Analyse- und Codierungsfehler und kann zu Sicherheitsmängeln führen. Die Uri-Klasse stellt diese Dienste auf sichere Weise bereit. Wenn eine Wahl zwischen zwei Überladungen getroffen werden kann, die sich nur in Bezug auf die Darstellung eines URIs unterscheiden, sollte der Benutzer die Überladung auswählen, die ein Uri-Argument annimmt.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, müssen Sie die Überladung aufrufen, die das Uri-Argument annimmt.

Wann sollten Warnungen unterdrückt werden?

Eine Warnung dieser Regel kann sicher unterdrückt werden, wenn es sich bei dem Zeichenfolgenparameter nicht um einen URI handelt.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

#pragma warning disable CA2234
// The code that's violating the rule is on this line.
#pragma warning restore CA2234

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

[*.{cs,vb}]
dotnet_diagnostic.CA2234.severity = none

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Verwendung) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Beispiel

Das folgende Beispiel zeigt eine Methode, ErrorProne, die gegen die Regel verstößt, und eine Methode, SaferWay, die Uri-Überladung ordnungsgemäß aufruft:

Imports System

Namespace ca2234

    Class History

        Friend Sub AddToHistory(uriString As String)
        End Sub

        Friend Sub AddToHistory(uriType As Uri)
        End Sub

    End Class

    Public Class Browser

        Dim uriHistory As New History()

        Sub ErrorProne()
            uriHistory.AddToHistory("http://www.adventure-works.com")
        End Sub

        Sub SaferWay()
            Try
                Dim newUri As New Uri("http://www.adventure-works.com")
                uriHistory.AddToHistory(newUri)
            Catch uriException As UriFormatException
            End Try
        End Sub

    End Class

End Namespace

class History
{
    internal void AddToHistory(string uriString) { }
    internal void AddToHistory(Uri uriType) { }
}

public class Browser
{
    History uriHistory = new History();

    public void ErrorProne()
    {
        uriHistory.AddToHistory("http://www.adventure-works.com");
    }

    public void SaferWay()
    {
        try
        {
            Uri newUri = new Uri("http://www.adventure-works.com");
            uriHistory.AddToHistory(newUri);
        }
        catch (UriFormatException) { }
    }
}