CA1051: Sichtbare Instanzfelder nicht deklarieren.

  • Artikel
Eigenschaft Wert
Regel-ID CA1051
Titel Sichtbare Instanzfelder nicht deklarieren.
Kategorie Design
Fix führt oder führt nicht zur Unterbrechung Breaking
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Typ verfügt über ein nicht privates Instanzfeld.

Standardmäßig werden mit dieser Regel nur extern sichtbare Typen überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

Ein Feld sollte primär als Implementierungsdetail verwendet werden. Felder sollten privat private oder internal intern sein und durch die Verwendung von Eigenschaften verfügbar gemacht werden. Es ist so einfach, auf eine Eigenschaft zuzugreifen, da Sie auf ein Feld zugreifen kann, und der Code in den Accessoren einer Eigenschaft kann sich ändern, wenn die Funktionen des Typs ohne wichtige Änderungen erweitert werden.

Eigenschaften, die nur den Wert eines privaten oder internen Felds zurückgeben, werden für die Ausführung mit dem Zugriff auf ein Feld optimiert. Der Leistungsgewinn bei der Verwendung extern sichtbarer Felder anstelle von Eigenschaften ist minimal. Extern sichtbar bezieht sich auf die Zugriffsebenen publicprotected und protected internal (Public, Protected und Protected Friend in Visual Basic).

Darüber hinaus können öffentliche Felder nicht durch Link-Aufrufegeschützt werden. (Link-Aufrufe gelten nicht für .NET Core-Apps.)

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, machen Sie das Feld private oder internal und machen Sie es mithilfe einer extern sichtbaren Eigenschaft verfügbar.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie diese Warnung nur, wenn Sie sicher sind, dass Consumer direkten Zugriff auf das Feld benötigen. Bei den meisten Anwendungen bieten verfügbar gemachte Felder keine Leistungs- oder Wartbarkeitsvorteile gegenüber Eigenschaften.

Consumer benötigen in den folgenden Situationen möglicherweise FeldZugriff:

  • Inhaltssteuerelemente in ASP.net Web Forms.
  • Wenn die Zielplattform ref verwendet, um Felder zu ändern, wie z. B. Model-View-ViewModel (MVVM)-Frameworks für WPF und UWP.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Einschließen oder Ausschließen von APIs

Mit den folgenden Optionen können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Entwurf) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Strukturen ausschließen

Sie können struct-Felder (Structure-Felder in Visual Basic) von der Analyse ausschließen.

dotnet_code_quality.ca1051.exclude_structs = true

Beispiel

Das folgende Beispiel zeigt einen Typ (BadPublicInstanceFields), der gegen diese Regel verstößt. GoodPublicInstanceFields zeigt den korrigierten Code an.

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; }
    }
}

Siehe auch