CA1030: Použijte události, kde je to vhodné

Vlastnost Hodnota
ID pravidla CA1030
Název Použijte události, kde je to vhodné
Kategorie Návrh
Oprava, která může být destruktivní nebo nedestruktivní Nezlomitelný
Povoleno ve výchozím nastavení v .NET 10 Ne
Příslušné jazyky C# a Visual Basic

Příčina

Název metody začíná jedním z následujících způsobů:

  • AddOn
  • RemoveOn
  • Oheň
  • Zvýšit

Ve výchozím nastavení toto pravidlo sleduje pouze externě viditelné metody, ale dá se konfigurovat.

Popis pravidla

Toto pravidlo zjišťuje metody, které mají názvy obvykle používané pro události. Události používají návrhový vzor Pozorovatel nebo Vydavatel/Odběratel, které se používají, když je třeba sdělit změnu stavu v jednom objektu jiným objektům. Pokud se metoda volá v reakci na jasně definovanou změnu stavu, metoda by měla být vyvolána obslužnou rutinou události. Objekty volající tuto metodu by měly místo přímého volání metody vyvolat událost.

Některé běžné příklady událostí se nacházejí v aplikacích uživatelského rozhraní, kde akce uživatele, jako je kliknutí na tlačítko, způsobí spuštění segmentu kódu. Model událostí .NET není omezen na uživatelská rozhraní. Měl by se používat všude, kde musíte sdělit změny stavu jednoho nebo více objektů.

Jak opravit porušení

Pokud je volána metoda při změně stavu objektu, zvažte změnu návrhu na použití modelu událostí .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);
    }
}

Kdy potlačit upozornění

Potlačit varování z tohoto pravidla, pokud metoda nepracuje s modelem událostí .NET.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Návrh), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Nastavením možnosti api_surface můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět na základě jejich přístupnosti. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Poznámka

Nahraďte XXXX část CAXXXX ID příslušného pravidla.

  • Last updated on