CA1872: Prefer 'Convert.ToHexString' and 'Convert.ToHexStringLower' over callchain based on 'BitConverter.ToString'

Artikel
04/01/2024

	Wert
Regel-ID	CA1872
Titel	Bevorzugen Sie 'Convert.ToHexString' und 'Convert.ToHexStringLower' gegenüber Anrufketten basierend auf 'BitConverter.ToString'
Kategorie	Leistung
Fix führt oder führt nicht zur Unterbrechung	Nicht unterbrechend
Standardmäßig in .NET 9 aktiviert	Als Vorschlag

Ursache

Ein Aufruf, BitConverter.ToString gefolgt von einem Aufruf zum String.Replace Entfernen von Gedankenstrichen, wird verwendet, um Bytes in eine Hexadezimalzeichenfolgendarstellung zu codieren. Diese Regel wird auch ausgelöst, wenn String.ToLower sie in der Anrufkette verwendet wird.

Regelbeschreibung

Verwenden Oder Convert.ToHexString Convert.ToHexStringLower wenn Bytes in eine Hexadezimalzeichenfolgendarstellung codiert werden. Diese Methoden sind effizienter und zuordnungsfreundlicher als die Verwendung BitConverter.ToString in Kombination mit dem String.Replace Entfernen von Bindestrichen und String.ToLower.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, ersetzen Sie die Anrufkette durch entweder Convert.ToHexString oder Convert.ToHexStringLower.

Beispiel

Der folgende Codeausschnitt zeigt einen Verstoß gegen CA1872:

using System;
using System.Text;

class HelloWorldEncoder
{
    private readonly byte[] _data = Encoding.ASCII.GetBytes("Hello World");

    public string Encode()
    {
        return BitConverter.ToString(_data).Replace("-", "");
    }

    public string EncodeToLower()
    {
        return BitConverter.ToString(_data).Replace("-", "").ToLower();
    }
}

Imports System
Imports System.Text

Class HelloWorldEncoder
    Private ReadOnly _data As Byte() = Encoding.ASCII.GetBytes("Hello World")

    Public Function Encode() As String
        Return BitConverter.ToString(_data).Replace("-", "")
    End Function

    Public Function EncodeToLower() As String
        Return BitConverter.ToString(_data).Replace("-", "").ToLower()
    End Function
End Class

Der folgende Codeausschnitt korrigiert die Verletzung:

using System;
using System.Text;

class HelloWorldEncoder
{
    private readonly byte[] _data = Encoding.ASCII.GetBytes("Hello World");

    public string Encode()
    {
        return Convert.ToHexString(data);
    }

    public string EncodeToLower()
    {
        return Convert.ToHexStringLower(data);
    }
}

Imports System
Imports System.Text

Class HelloWorldEncoder
    Private ReadOnly _data As Byte() = Encoding.ASCII.GetBytes("Hello World")

    Public Function Encode() As String
        Return Convert.ToHexString(data)
    End Function

    Public Function EncodeToLower() As String
        Return Convert.ToHexStringLower(data)
    End Function
End Class

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, eine Warnung aus dieser Regel zu unterdrücken; Es wird jedoch empfohlen, entweder Convert.ToHexString oder Convert.ToHexStringLower.

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 CA1872
// The code that's violating the rule is on this line.
#pragma warning restore CA1872

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.CA1872.severity = none

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

Teilen über