CA1032:实现标准异常构造函数

项目
09/07/2023

属性	值
规则 ID	CA1032
标题	实现标准异常构造函数
类别	设计
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	否

原因

类型扩展了 System.Exception，但未声明所有必需的构造函数。

规则说明

异常类型必须实现以下三个公共构造函数：

公共 NewException()
公共 NewException(string)
公共 NewException(string, Exception)

如果不能提供完整的构造函数集，要正确处理异常将变得比较困难。例如，具有签名 NewException(string, Exception) 的构造函数用于创建由其他异常引起的异常。如果没有此构造函数，你无法创建和引发包含内部（嵌套）异常的自定义异常实例，在这种情况下，托管代码应执行此操作。

有关详细信息，请参阅 CA2229：实现序列化构造函数。

如何解决冲突

若要修复此规则的冲突，请将缺少的构造函数添加到异常，并确保它们具有正确的可访问性。

何时禁止显示警告

当冲突是由于对公共构造函数使用不同的访问级别而引起时，可以安全地禁止显示此规则的警告。

抑制警告

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

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

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

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

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

示例

以下示例包含与此规则冲突的异常类型和正确实现的异常类型。

// Violates rule ImplementStandardExceptionConstructors.
public class BadException : Exception
{
    public BadException()
    {
        // Add any type-specific logic, and supply the default message.
    }
}

[Serializable()]
public class GoodException : Exception
{
    public GoodException()
    {
        // Add any type-specific logic, and supply the default message.
    }

    public GoodException(string message) : base(message)
    {
        // Add any type-specific logic.
    }

    public GoodException(string message, Exception innerException) :
       base(message, innerException)
    {
        // Add any type-specific logic for inner exceptions.
    }
}

另请参阅

CA2229:实现序列化构造函数