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

Článek
09/06/2023

Vlastnost	Hodnota
ID pravidla	CA1030
Název	Použijte události, kde je to vhodné
Kategorie	Návrh
Oprava způsobující chybu nebo chybu způsobující chybu	Nenarušující
Povoleno ve výchozím nastavení v .NET 8	No

Příčina

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

Addon
RemoveOn
Požáru
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 se řídí vzorem návrhu pozorovatele nebo publikování odběru; používají se, když se změna stavu v jednom objektu musí sdělit 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.

Kdy potlačit upozornění

Potlačit upozornění z tohoto pravidla, pokud metoda nefunguje 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.

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

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

Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. 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

Sdílet prostřednictvím