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

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA2234
Stanowisko Przekazuj obiekty System.Uri zamiast ciągów
Kategoria Użycie
Poprawka powodująca niezgodność lub niezgodność Niezgodność
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Wywołanie jest wykonywane do metody, która ma parametr ciągu, którego nazwa zawiera "uri", "Uri", "urn", "Urn", "url" lub "Url", a deklarowany typ metody zawiera odpowiednie przeciążenie metody, które ma System.Uri parametr.

Domyślnie ta reguła analizuje tylko metody i typy widoczne zewnętrznie, ale jest to możliwe do skonfigurowania.

Opis reguły

Nazwa parametru jest podzielona na tokeny na podstawie konwencji wielkości liter wielbłąda, a następnie sprawdzana jest każda token, aby sprawdzić, czy jest równa "uri", "Uri", "urn", "Urn", "url" lub "Url". Jeśli istnieje dopasowanie, przyjmuje się, że parametr reprezentuje jednolity identyfikator zasobu (URI). Reprezentacja ciągu identyfikatora URI jest podatna na analizowanie i kodowanie błędów i może prowadzić do powstawania luk w zabezpieczeniach. Klasa Uri zapewnia te usługi w bezpieczny i bezpieczny sposób. Jeśli istnieje wybór między dwoma przeciążeniami, które różnią się tylko w odniesieniu do reprezentacji identyfikatora URI, użytkownik powinien wybrać przeciążenie, które przyjmuje Uri argument.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, wywołaj przeciążenie, które przyjmuje Uri argument.

Kiedy pomijać ostrzeżenia

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

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

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

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, których dotyczy, lub dla wszystkich reguł w tej kategorii (użycie), do których ma ona zastosowanie. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Przykład

W poniższym przykładzie przedstawiono metodę , ErrorPronektóra narusza regułę i metodę , SaferWayktóra poprawnie wywołuje Uri przeciążenie:

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) { }
    }
}