CA2009: No llame a ToImmutableCollection en un valor ImmutableCollection

Artículo
06/05/2023

Propiedad	Value
Identificador de la regla	CA2009
Título	No llame a ToImmutableCollection en un valor ImmutableCollection
Categoría	Confiabilidad
La corrección es problemática o no problemática	Poco problemático
Habilitado de forma predeterminada en .NET 8	Como sugerencia

Causa

Se ha llamado innecesariamente al método ToImmutable en una colección inmutable desde el espacio de nombres System.Collections.Immutable.

Descripción de la regla

El espacio de nombres System.Collections.Immutable contiene tipos que definen colecciones inmutables. Esta regla analiza los siguientes tipos de colección inmutable:

Estos tipos definen métodos de extensión que crean una nueva colección inmutable a partir de una colección IEnumerable<T> existente.

ImmutableArray<T> define a ToImmutableArray.
ImmutableList<T> define a ToImmutableList.
ImmutableHashSet<T> define a ToImmutableHashSet.
ImmutableSortedSet<T> define a ToImmutableSortedSet.
ImmutableDictionary<TKey,TValue> define a ToImmutableDictionary.
ImmutableSortedDictionary<TKey,TValue> define a ToImmutableSortedDictionary.

Estos métodos de extensión están diseñados para convertir una colección mutable en una colección inmutable. Sin embargo, el autor de la llamada puede pasar accidentalmente una colección inmutable como entrada a estos métodos. Esto puede representar un problema de rendimiento o funcional.

Problema de rendimiento: conversión boxing, conversión unboxing o comprobaciones de tipo runtime innecesarias en una colección inmutable.
Posible problema funcional: se supone que el autor de la llamada está funcionando en una colección mutable, cuando realmente tiene una colección inmutable.

Cómo corregir infracciones

Para corregir infracciones, elimine la llamada ToImmutable redundante en una colección inmutable. Por ejemplo, en los dos fragmentos de código siguientes se muestra una infracción de la regla y cómo corregirla:

using System;
using System.Collections.Generic;
using System.Collections.Immutable;

public class C
{
    public void M(IEnumerable<int> collection, ImmutableArray<int> immutableArray)
    {
        // This is fine.
        M2(collection.ToImmutableArray());

        // This leads to CA2009.
        M2(immutableArray.ToImmutableArray());
    }

    private void M2(ImmutableArray<int> immutableArray)
    {
        Console.WriteLine(immutableArray.Length);
    }
}

using System;
using System.Collections.Generic;
using System.Collections.Immutable;

public class C
{
    public void M(IEnumerable<int> collection, ImmutableArray<int> immutableArray)
    {
        // This is fine.
        M2(collection.ToImmutableArray());

        // This is now fine.
        M2(immutableArray);
    }

    private void M2(ImmutableArray<int> immutableArray)
    {
        Console.WriteLine(immutableArray.Length);
    }
}

Sugerencia

Hay disponible una corrección de código para esta regla en Visual Studio. Para usarlo, coloque el cursor sobre la infracción y presione Ctrl+. (punto). Elija Quitar llamada redundante en la lista de opciones que se muestra.

Code fix for CA2009 - Do not call ToImmutableCollection on an ImmutableCollection value

Cuándo suprimir las advertencias

No suprima las infracciones de esta regla, a menos que no le preocupe el impacto en el rendimiento de las asignaciones innecesarias de colecciones inmutables.

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

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

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

Compartir a través de