CA1862: Usar las sobrecargas del método "StringComparison" para realizar comparaciones de cadenas que no distinguen mayúsculas de minúsculas

  • Artículo
Propiedad Value
Identificador de la regla CA1862
Título Usar las sobrecargas del método "StringComparison" para realizar comparaciones de cadenas que no distinguen mayúsculas de minúsculas
Categoría Rendimiento
La corrección es problemática o no problemática Poco problemático
Habilitado de forma predeterminada en .NET 8 Como sugerencia

Causa

El código compara dos cadenas de una manera que no distingue mayúsculas de minúsculas llamando primero a ToLower(), ToLowerInvariant(), ToUpper()o ToUpperInvariant() en una o ambas cadenas.

Descripción de la regla

Cuando el código llama a ToLower(), ToLowerInvariant(), ToUpper()o ToUpperInvariant(), se realiza una asignación. Si el único motivo para llamar a estos métodos es realizar una comparación de cadenas que no distingue mayúsculas de minúsculas o buscar, la asignación no es necesaria. En su lugar, puede llamar a un método de comparación de cadenas que toma un StringComparison y especifica uno de los valores *IgnoreCase.

Cómo corregir infracciones

Quite la llamada a ToLower(), ToLowerInvariant(), ToUpper()o ToUpperInvariant(), y llame a uno de los métodos StringComparer o a uno de los métodos siguientes que toma un argumento StringComparison:

Nota:

  • Si cambia el código para usar una sobrecarga que toma un argumento StringComparison, puede provocar cambios sutiles en el comportamiento. Es importante realizar pruebas exhaustivas si realiza este cambio o acepta la sugerencia de bombilla de Visual Studio.
  • Si no es necesario comparar las cadenas de forma culturalmente confidencial, considere la posibilidad de pasar StringComparison.OrdinalIgnoreCase.

Ejemplo

En el ejemplo siguiente se muestra una infracción de la regla:

string s1 = "aBc";
string s2 = "aBC";

int _ = s1.ToUpper().CompareTo(s2.ToUpper());

Dim s1 As String = "aBc"
Dim s2 As String = "aBC"

Dim i As Integer = s1.ToUpper().CompareTo(s2.ToUpper())

En el ejemplo siguiente se muestra el código que corrige ambas infracciones:

string s1 = "aBc";
string s2 = "aBC";

int _ = StringComparer.CurrentCultureIgnoreCase.Compare(s1, s2);

Dim s1 As String = "aBc"
Dim s2 As String = "aBC"

Dim i As Integer = StringComparer.CurrentCultureIgnoreCase.Compare(s1, s2)

Cuándo suprimir las advertencias

Es seguro suprimir advertencias de esta regla si el rendimiento no es un problema.

Si usa Entity Framework Core (EF Core), debe suprimir esta regla en escenarios en los que está consultando una base de datos comparando una cadena. EF Core produce una excepción si usa un método como String.Equals(String, StringComparison) que toma un argumento StringComparison, ya que no traducirá dichas consultas a SQL. Para obtener más información, vea Traducción de operaciones integradas de cadena de .NET.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.