CA1065:不要在意外的位置引发异常

  • 项目
属性 值
规则 ID CA1065
标题 不要在意外的位置引发异常
类别 设计
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 否

原因

不应引发异常的方法引发了异常。

规则说明

不应引发异常的方法可分成以下几类：

  • 属性 Get 方法

  • 事件访问器方法

  • Equals 方法

  • GetHashCode 方法

  • ToString 方法

  • 静态构造函数

  • 终结器

  • Dispose 方法

  • 相等运算符

  • 隐式强制转换运算符

以下各节讨论了这些方法类型。

属性 Get 方法

属性基本上都是智能字段。 因此，其行为应尽可能类似于字段。 字段不会引发异常，属性也不应引发异常。 如果有一个引发异常的属性，可考虑将其设为方法。

属性 Get 方法可引发以下异常：

事件访问器方法

事件访问器应是不会引发异常的简单操作。 尝试添加或删除事件处理程序时，事件不应引发异常。

事件访问器可引发以下异常：

Equals 方法

以下 Equals 方法不应引发异常：

Equals 方法应返回 true 或 false 而不是引发异常。 例如，如果 Equals 传递两个不匹配的类型，则应只返回 false 而不是引发 ArgumentException。

GetHashCode 方法

以下 GetHashCode 方法通常不应引发异常：

GetHashCode 应始终返回值。 否则，可能会丢失哈希表中的项。

采用参数的 GetHashCode 版本可能会引发 ArgumentException。 但是，Object.GetHashCode 应始终不会引发异常。

ToString 方法

调试器使用 System.Object.ToString 来帮助以字符串格式显示有关对象的信息。 因此，ToString 不应更改对象的状态，也不应引发异常。

静态构造函数

从静态构造函数引发异常将导致该类型在当前应用程序域中不可用。 从静态构造函数引发异常应具备充分的理由（如安全问题）。

终结器

从终结器引发异常将导致 CLR 快速失败，从而中断过程。 因此，应始终避免在终结器中引发异常。

Dispose 方法

System.IDisposable.Dispose 方法不应引发异常。 Dispose 通常作为 finally 子句中清理逻辑的一部分调用。 因此，从 Dispose 显式引发异常将强制用户在 finally 子句内添加异常处理。

Dispose (false) 代码路径应始终不会引发异常，因为 Dispose 几乎都是从终结器调用的。

相等运算符 (==, !=)

与 Equals 方法一样，相等运算符应返回 true 或 false，而不应引发异常。

隐式强制转换运算符

由于用户通常不知道已调用了隐式强制转换运算符，因此对它引发的异常会感到意外。 因此，隐式强制转换运算符不应引发异常。

如何解决冲突

对于属性 Getter，可更改逻辑，使其不再需要引发异常，或将属性更改为方法。

对于前面列出的所有其他方法类型，可更改逻辑，使其不再必须引发异常。

何时禁止显示警告

如果冲突是由异常声明而不是引发的异常造成的，则可禁止显示此规则发出的警告。

抑制警告

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

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

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

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

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

另请参阅