CA1030:在适用处使用事件

  • 项目
属性 值
规则 ID CA1030
标题 在适用处使用事件
类别 设计
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 否

原因

方法名称以下列项之一开头：

  • AddOn
  • RemoveOn
  • Fire
  • Raise

默认情况下，此规则仅查看外部可见的方法，但这是可配置的。

规则说明

该规则检测名称通常用于事件的方法。 事件遵循“观察者”或“发布-订阅”设计模式；当必须将一个对象的状态更改传达给其他对象时，它们适用。 如果为响应明确定义的状态更改而调用一个方法，则应由事件处理程序调用该方法。 调用该方法的对象应引发事件而不是直接调用该方法。

用户界面应用程序中发现了一些常见事件示例，其中用户操作（如单击按钮）会导致执行一段代码。 .NET 事件模型并不局限于用户界面。 它应在必须将状态更改传达给一个或多个对象的任何位置使用。

如何解决冲突

如果在对象状态发生变化时调用该方法，请考虑更改设计以使用 .NET 事件模型。

何时禁止显示警告

如果该方法不能与 .NET 事件模型一起使用，则禁止显示此规则的警告。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

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

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

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

有关详细信息，请参阅如何禁止显示代码分析警告。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

可以仅为此规则、为适用的所有规则或为适用的此类别（设计）中的所有规则配置此选项。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal