CA1002 : Ne pas exposer de listes génériques

  • Article
Propriété Value
Identificateur de la règle CA1002
Titre Ne pas exposer de listes génériques
Catégorie Conception
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

Un type contient un membre visible en externe qui est un type System.Collections.Generic.List<T>, retourne un type List<T> ou dont la signature inclut un paramètre List<T>.

Par défaut, cette règle examine uniquement les types visibles en externe, mais elle est configurable.

Description de la règle

System.Collections.Generic.List<T> est une collection générique conçue pour les performances et non l’héritage. List<T> ne contient pas de membres virtuels qui facilitent la modification du comportement d’une classe héritée. Les collections génériques suivantes sont conçues pour l’héritage et doivent être exposées à la place de List<T>.

Comment corriger les violations

Pour corriger une violation de cette règle, remplacez le type System.Collections.Generic.List<T> par une des collections génériques conçues pour l’héritage.

Quand supprimer les avertissements

Ne supprimez pas un avertissement de cette règle, sauf si l’assembly qui déclenche cet avertissement n’est pas destiné à être une bibliothèque réutilisable. Par exemple, il serait sans risque de supprimer cet avertissement dans une application optimisée pour les performances, où un avantage de performances a été obtenu avec l’utilisation de listes génériques.

Supprimer un avertissement

Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.

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

Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.

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

Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.

Configurer le code à analyser

Utilisez l’option suivante pour configurer les parties de votre codebase sur lesquelles exécuter cette règle.

Vous pouvez configurer cette option pour cette règle uniquement, pour toutes les règles auxquelles elle s’applique ou pour toutes les règles de cette catégorie (Conception) auxquelles elle s’applique. Pour plus d’informations, consultez Options de configuration des règles de qualité du code.

Inclure des surfaces d’API spécifiques

Vous pouvez configurer les parties de votre codebase sur lesquelles exécuter cette règle, en fonction de leur accessibilité. Par exemple, pour spécifier que la règle doit s’exécuter uniquement sur la surface d’API non publique, ajoutez la paire clé-valeur suivante à un fichier .editorconfig dans votre projet :

dotnet_code_quality.CAXXXX.api_surface = private, internal

CA1005 : Éviter les paramètres excessifs sur les types génériques

CA1010 : Les collections doivent implémenter une interface générique

CA1000 : Ne pas déclarer de membres statiques sur les types génériques

CA1003 : Utiliser les instances du gestionnaire d'événements génériques

Voir aussi

Génériques