CA1051 : Ne pas déclarer de champs d'instances visibles

  • Article
Propriété Value
Identificateur de la règle CA1051
Titre Ne pas déclarer de champs d'instances visibles
Catégorie Conception
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

Un type a un champ d’instance non privé.

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

Description de la règle

Un champ s'utilise principalement en tant que détail d'implémentation. Les champs doivent être private ou internal, et être exposés à l’aide de propriétés. Il est aussi facile d’accéder à une propriété que d’accéder à un champ, et le code dans les accesseurs d’une propriété peut changer à mesure que les fonctionnalités du type se développent sans introduire de changements cassants.

Les propriétés qui retournent simplement la valeur d’un champ privé ou interne sont optimisées pour être identiques à l’accès à un champ ; le gain de performances résultant de l’utilisation de champs visibles en externe au lieu des propriétés est minimal. Visible en externe fait référence aux niveaux d’accessibilité public, protected et protected internal (Public, Protected et Protected Friend dans Visual Basic).

En outre, les champs publics ne peuvent pas être protégés par des demandes de liaison. (Les demandes de liaison ne s’appliquent pas aux applications .NET Core.)

Comment corriger les violations

Pour corriger une violation de cette règle, créez le champ private ou internal, et exposez-le à l’aide d’une propriété visible en externe.

Quand supprimer les avertissements

Supprimez cet avertissement uniquement si vous êtes certain que les consommateurs ont besoin d’un accès direct au champ. Pour la plupart des applications, les champs exposés n’offrent pas d’avantages en matière de performances ou de maintenance par rapport aux propriétés.

Les consommateurs peuvent avoir besoin d’un accès au champ dans les situations suivantes :

  • Dans les contrôles de contenu ASP.NET Web Forms.
  • Lorsque la plateforme cible utilise ref pour modifier des champs, comme les frameworks MVVM (modèle-vue-vue modèle) pour WPF et UWP.

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

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

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

Inclure ou exclure des API

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

Vous pouvez configurer ces options pour cette règle uniquement, pour toutes les règles auxquelles elles s’appliquent ou pour toutes les règles de cette catégorie (Conception) auxquelles elles s’appliquent. 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

Exclure des structs

Vous pouvez exclure les champs struct (Structure en Visual Basic) de l’analyse.

dotnet_code_quality.ca1051.exclude_structs = true

Exemple

L’exemple suivant montre un type (BadPublicInstanceFields) qui enfreint cette règle. GoodPublicInstanceFields affiche le code corrigé.

public class BadPublicInstanceFields
{
    // Violates rule DoNotDeclareVisibleInstanceFields.
    public int instanceData = 32;
}

public class GoodPublicInstanceFields
{
    private int instanceData = 32;

    public int InstanceData
    {
        get { return instanceData; }
        set { instanceData = value; }
    }
}

Voir aussi