CA1872: preferire 'Convert.ToHexString' e 'Convert.ToHexStringLower' su catene di chiamate basate su 'BitConverter.ToString'

Articolo
10/30/2024

	Valore
ID regola	CA1872
Title	Preferire `Convert.ToHexString` e `Convert.ToHexStringLower` superare le catene di chiamate in base a `BitConverter.ToString`
Categoria	Prestazioni
La correzione causa un'interruzione o meno	Non causa un'interruzione
Abilitato per impostazione predefinita in .NET 9	Come suggerimento

Causa

Una chiamata a BitConverter.ToString seguita da una chiamata a String.Replace per rimuovere i trattini viene usata per codificare i byte in una rappresentazione di stringa esadecimale. Questa regola viene attivata anche se String.ToLower viene usata nella catena di chiamate.

Descrizione regola

Usare Convert.ToHexString o Convert.ToHexStringLower quando si codificano byte in una rappresentazione di stringa esadecimale. Questi metodi sono più efficienti e descrittivi per l'allocazione rispetto all'uso BitConverter.ToString in combinazione con String.Replace per rimuovere trattini e String.ToLower.

Come correggere le violazioni

Per correggere una violazione di questa regola, sostituire la catena di chiamate con Convert.ToHexString o Convert.ToHexStringLower.

Esempio

Il frammento di codice seguente mostra una violazione di 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

Il frammento di codice seguente corregge la violazione:

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

Quando eliminare gli avvisi

È sicuro eliminare un avviso da questa regola; È tuttavia consigliabile usare Convert.ToHexString o Convert.ToHexStringLower.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Condividi tramite