通过

CA2250：使用 ThrowIfCancellationRequested

  • 项目
属性 值
规则 ID CA2250
标题 使用 ThrowIfCancellationRequested
类别 使用情况
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 作为建议

原因

此规则标记在引发 OperationCanceledException 之前检查 IsCancellationRequested 的条件语句。

规则说明

可以通过调用 CancellationToken.ThrowIfCancellationRequested() 来完成相同的任务。

如何解决冲突

若要解决冲突，请将条件语句替换为对 ThrowIfCancellationRequested() 的调用。

using System;
using System.Threading;

public void MySlowMethod(CancellationToken token)
{
    // Violation
    if (token.IsCancellationRequested)
        throw new OperationCanceledException();

    // Fix
    token.ThrowIfCancellationRequested();

    // Violation
    if (token.IsCancellationRequested)
        throw new OperationCanceledException();
    else
        DoSomethingElse();

    // Fix
    token.ThrowIfCancellationRequested();
    DoSomethingElse();
}

Imports System
Imports System.Threading

Public Sub MySlowMethod(token As CancellationToken)

    ' Violation
    If token.IsCancellationRequested Then
        Throw New OperationCanceledException()
    End If

    ' Fix
    token.ThrowIfCancellationRequested()

    ' Violation
    If token.IsCancellationRequested Then
        Throw New OperationCanceledException()
    Else
        DoSomethingElse()
    End If

    ' Fix
    token.ThrowIfCancellationRequested()
    DoSomethingElse()
End Sub

何时禁止显示警告

可以安全地禁止显示此规则的警告。

抑制警告

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

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

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

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

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

另请参阅