CA1051: Non dichiarare campi di istanza visibili

Causa

Un tipo ha un campo di istanza non privata.

Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.

Descrizione regola

L'utilizzo principale di un campo deve essere come dettaglio di implementazione. I campi devono essere private o internal e devono essere esposti usando le proprietà . È facile accedere a una proprietà così com'è accedere a un campo e il codice nelle funzioni di accesso di una proprietà può cambiare man mano che le funzionalità del tipo si espandono senza introdurre modifiche di rilievo.

Le proprietà che restituiscono semplicemente il valore di un campo privato o interno sono ottimizzate per l'esecuzione alla pari con l'accesso a un campo; il miglioramento delle prestazioni rispetto all'uso di campi visibili esternamente anziché proprietà è minimo. Visibile esternamente fa riferimento ai publiclivelli di accessibilità , protectede protected internal (Public, Protectede Protected Friend in Visual Basic).

Inoltre, i campi pubblici non possono essere protetti dalle richieste di collegamento. Le richieste di collegamento non si applicano alle app .NET Core.

Come correggere le violazioni

Per correggere una violazione di questa regola, rendere il campo private o internal esporlo usando una proprietà visibile esternamente.

Quando eliminare gli avvisi

Eliminare questo avviso solo se si è certi che gli utenti necessitano dell'accesso diretto al campo. Per la maggior parte delle applicazioni, i campi esposti non offrono vantaggi in termini di prestazioni o manutenibilità rispetto alle proprietà.

I consumer possono richiedere l'accesso sul campo nelle situazioni seguenti:

• In Web Forms ASP.NET controlli contenuto.
• Quando la piattaforma di ref destinazione usa per modificare i campi, ad esempio framework MVVM (Model-ViewModel) per WPF e UWP.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Includere o escludere API

Usare le opzioni seguenti per configurare le parti della codebase in cui eseguire questa regola.

• Includere superfici API specifiche
• Escludere gli struct

È possibile configurare queste opzioni solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (Progettazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Escludere gli struct

È possibile escludere struct i campi (Structure in Visual Basic) dall'analisi.

dotnet_code_quality.ca1051.exclude_structs = true

Esempio

Nell'esempio seguente viene illustrato un tipo (BadPublicInstanceFields) che viola questa regola. GoodPublicInstanceFields mostra il codice corretto.

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

Vedi anche

• Richieste di collegamento