CA1030: Nach Möglichkeit Ereignisse verwenden.

  • Artikel
Eigenschaft Wert
Regel-ID CA1030
Titel Nach Möglichkeit Ereignisse verwenden.
Kategorie Design
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Methodenname beginnt mit einem der folgenden Bestandteile:

  • AddOn
  • RemoveOn
  • Fire
  • Raise

Standardmäßig werden mit dieser Regel nur extern sichtbare Methoden überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

Diese Regel erkennt Methoden, deren Namen normalerweise für Ereignisse verwendet würden. Ereignisse folgen dem Observer- oder Publish-Subscribe-Entwurfsmuster. Diese werden verwendet, wenn eine Zustandsänderung eines Objekts an andere Objekte übermittelt werden muss. Wenn eine Methode auf eine klar definierte Zustandsänderung hin aufgerufen wird, sollte sie von einem Ereignishandler aufgerufen werden. Objekte, die die Methode aufrufen, sollten Ereignisse auslösen, statt die Methode direkt aufzurufen.

Besonders häufig treten solche Ereignisse in Oberflächenanwendungen auf, bei denen eine Benutzeraktion (z. B. das Klicken auf eine Schaltfläche) bewirkt, dass ein bestimmtes Codesegment ausgeführt wird. Das .NET-Ereignismodell ist nicht nur auf Benutzeroberflächen beschränkt. Es sollte überall dort verwendet werden, wo Zustandsänderungen an ein oder mehrere Objekte übermittelt werden müssen.

Behandeln von Verstößen

Wenn die Methode bei einer Zustandsänderung eines Objekts aufgerufen wird, sollten Sie das Design so ändern, dass das .NET-Ereignismodell verwendet wird.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie eine Warnung dieser Regel, wenn die Methode nicht mit dem .NET-Ereignismodell funktioniert.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Entwurf) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal