语言

CA2027:在 Task.WhenAny 完成后取消 Task.Delay

Property 价值
规则 ID CA2027
Title 在Task.Delay完成后取消Task.WhenAny
类别 可靠性
修复是中断修复还是非中断修复 Non-breaking
在 .NET 10 中默认启用 No
默认在 .NET 11 中启用 作为一种建议
适用的语言 C# 和 Visual Basic

Cause

对 WhenAny 的调用包含一个对 Delay 的调用,而后者不接受 CancellationToken。

规则说明

当另一个任务首先完成时,不可取消的延迟会继续运行,直到其超时到期。 未使用的计时器消耗资源。

如何修复违规行为

如果只需等待带超时限制的操作,请使用 Task.WaitAsync(TimeSpan)。 如果在超时之前操作未完成,则会引发 TimeoutException。

如果需要调用 Task.WhenAny,请向 Task.Delay 传递取消令牌,并在另一个任务完成时取消该令牌源。

Examples

以下代码显示了 CA2027 的违规:

Task winner = await Task.WhenAny(operation, Task.Delay(timeout));
Dim winner = Await Task.WhenAny(operation, Task.Delay(timeout))

仅当需要超时时使用 Task.WaitAsync :

await operation.WaitAsync(timeout);
Await operation.WaitAsync(timeout)

或者在 Task.WhenAny 返回后取消延迟:

using var cts = new CancellationTokenSource();
Task winner = await Task.WhenAny(operation, Task.Delay(timeout, cts.Token));
cts.Cancel();
Using cts As New CancellationTokenSource()
    Dim winner = Await Task.WhenAny(operation, Task.Delay(timeout, cts.Token))
    cts.Cancel()
End Using

何时禁止显示警告

仅当延迟应在另一个任务完成后继续时,才禁止显示警告。

禁止显示警告

若要取消单个违规,请将预处理器指令添加到源文件以禁用,然后重新启用规则。

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

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

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

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

另请参阅