CA1030: Utilizzare eventi dove appropriato

Proprietà	valore
ID regola	CA1030
Title	Usare eventi dove appropriato
Categoria	Progettazione
La correzione causa un'interruzione o meno	Non causa un'interruzione
Abilitato per impostazione predefinita in .NET 10	No

Causa

Un nome di metodo inizia con uno dei seguenti:

• Add-on
• RemoveOn
• Incendio
• Generazione

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

Descrizione regola

Questa regola rileva i metodi che presentano nomi comunemente utilizzati per gli eventi. Gli eventi seguono il modello di progettazione Observer o Publish-Subscribe; vengono utilizzati quando una modifica dello stato in un oggetto deve essere comunicata ad altri oggetti. Se un metodo viene chiamato in risposta a una modifica dello stato chiaramente definita, il metodo deve essere richiamato da un gestore eventi. Gli oggetti che chiamano il metodo devono generare eventi anziché chiamare direttamente il metodo.

Alcuni esempi comuni di eventi si trovano nelle applicazioni dell'interfaccia utente in cui un'azione dell'utente, ad esempio facendo clic su un pulsante, causa l'esecuzione di un segmento di codice. Il modello di evento .NET non è limitato alle interfacce utente. Deve essere usato ovunque sia necessario comunicare le modifiche dello stato a uno o più oggetti.

Come correggere le violazioni

Se il metodo viene chiamato quando lo stato di un oggetto cambia, è consigliabile modificare la progettazione in modo da usare il modello di eventi .NET.

Example

// This class violates the rule.
public class BadButton
{
    private readonly List<Action> _clickHandlers = new List<Action>();

    public void AddOnClick(Action handler)
    {
        // Some internal logic...

        _clickHandlers.Add(handler);
    }

    public void RemoveOnClick(Action handler)
    {
        // Some internal logic...

        _clickHandlers.Remove(handler);
    }

    public void FireClick()
    {
        foreach (Action handler in _clickHandlers)
        {
            handler();
        }
    }
}

// This class satisfies the rule.
public class GoodButton
{
    private EventHandler? _clickHandler;

    public event EventHandler? ClickHandler
    {
        add
        {
            // Some internal logic...

            _clickHandler += value;
        }
        remove
        {
            // Some internal logic...

            _clickHandler -= value;
        }
    }

    protected virtual void OnClick(EventArgs e)
    {
        _clickHandler?.Invoke(this, e);
    }

    public void Click()
    {
        OnClick(EventArgs.Empty);
    }
}

Quando eliminare gli avvisi

Eliminare un avviso da questa regola se il metodo non funziona con il modello di evento .NET.

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

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

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

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

• Includere superfici API specifiche

È possibile configurare questa opzione 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 alla relativa accessibilità impostando l'opzione api_surface. 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

Nota

Sostituire la parte XXXX di CAXXXX con l'ID della regola applicabile.