Delen via

CA1051: Niet zichtbare exemplaarvelden declareren

  • Artikel
Eigenschappen Weergegeven als
Regel-id CA1051
Titel Zichtbare exemplaarvelden niet declareren
Categorie Ontwerpen
Oplossing is brekend of niet-brekend Breken
Standaard ingeschakeld in .NET 8 Nee

Oorzaak

Een type heeft een niet-privé-exemplaarveld.

Deze regel kijkt standaard alleen naar extern zichtbare typen, maar dit kan worden geconfigureerd.

Beschrijving van regel

Het primaire gebruik van een veld moet een implementatiedetails zijn. Velden moeten zijn private of internal moeten worden weergegeven met behulp van eigenschappen. Het is net zo eenvoudig om toegang te krijgen tot een eigenschap als voor toegang tot een veld en de code in de toegangsfuncties van een eigenschap kan veranderen als de functies van het type worden uitgebreid zonder wijzigingen die fouten veroorzaken.

Eigenschappen die alleen de waarde van een privé- of intern veld retourneren, zijn geoptimaliseerd om te worden uitgevoerd op basis van toegang tot een veld; de prestatiewinst van het gebruik van extern zichtbare velden in plaats van eigenschappen is minimaal. Extern zichtbaar verwijst naarpublic, protecteden (PublicProtecteden protected internalProtected Friend in Visual Basic) toegankelijkheidsniveaus.

Daarnaast kunnen openbare velden niet worden beveiligd door koppelingsvereisten. (Koppelingsvereisten zijn niet van toepassing op .NET Core-apps.)

Schendingen oplossen

Als u een schending van deze regel wilt oplossen, moet u het veld private of internal het beschikbaar maken met behulp van een extern zichtbare eigenschap.

Wanneer waarschuwingen onderdrukken

Onderdrukt deze waarschuwing alleen als u zeker weet dat consumenten directe toegang tot het veld nodig hebben. Voor de meeste toepassingen bieden weergegeven velden geen prestatie- of onderhoudbaarheidsvoordelen ten opzichte van eigenschappen.

Consumenten hebben mogelijk veldtoegang nodig in de volgende situaties:

  • In ASP.NET inhoudsbesturingselementen voor webformulieren.
  • Wanneer het doelplatform gebruikmaakt van het wijzigen van ref velden, zoals MVVM-frameworks (model-view-viewmodel) voor WPF en UWP.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

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

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

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

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

API's opnemen of uitsluiten

Gebruik de volgende opties om te configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd.

U kunt deze opties configureren voor alleen deze regel, voor alle regels waarop deze van toepassing is, of voor alle regels in deze categorie (ontwerp) waarop deze van toepassing is. Zie de configuratieopties voor de codekwaliteitsregel voor meer informatie.

Specifieke API-oppervlakken opnemen

U kunt instellen op welke onderdelen van uw codebase deze regel moet worden uitgevoerd, op basis van hun toegankelijkheid. Als u bijvoorbeeld wilt opgeven dat de regel alleen moet worden uitgevoerd op het niet-openbare API-oppervlak, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Structs uitsluiten

U kunt (Structurein Visual Basic)-velden uitsluiten struct dat ze worden geanalyseerd.

dotnet_code_quality.ca1051.exclude_structs = true

Voorbeeld

In het volgende voorbeeld ziet u een type (BadPublicInstanceFields) dat deze regel schendt. GoodPublicInstanceFields geeft de gecorrigeerde code weer.

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

Zie ook