CA1070:不要将事件字段声明为“虚拟”

项目
12/18/2023

属性	值
规则 ID	CA1070
标题	不要将事件字段声明为“虚拟”
类别	设计
修复是中断修复还是非中断修复	重大
在 .NET 9 中默认启用	作为建议

原因

将类似字段的事件声明为了虚拟事件。

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

规则说明

遵循这些 .NET 设计指南，在派生类中引发基类事件。不要在基类中声明虚拟事件。派生类中的重写事件具有未定义的行为。 C# 编译器不会正确处理此事件，并且无法预知派生事件的订阅者是否实际上会订阅基类事件。

using System;
public class C
{
    // CA1070: Event 'ThresholdReached' should not be declared virtual.
    public virtual event EventHandler ThresholdReached;
}

如何解决冲突

遵循这些 .NET 设计指南，并避免出现类似字段的虚拟事件。

何时禁止显示警告

如果该方法是一个外部可见的公共 API，该 API 已是已发布库的一部分，则可以安全地禁止显示此规则的警告，以避免库使用者遇到中断性变更。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

包含特定的 API 图面

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

另请参阅

设计规则

通过