CA2008:不要在未传递 TaskScheduler 的情况下创建任务

属性
规则 ID CA2008
标题 不要在未传递 TaskScheduler 的情况下创建任务
类别 可靠性
修复是中断修复还是非中断修复 非中断
在 .NET 9 中默认启用

原因

任务创建或延续操作使用未指定 TaskScheduler 参数的方法重载。

规则说明

以下 .NET 任务创建和延续方法具有允许指定或省略 TaskScheduler 实例的重载:

始终指定显式 TaskScheduler 参数以避免默认 Current 值,其行为由调用方定义并且在运行时可能会变化。 Current 返回与该线程上当前运行的任何 Task 相关联的计划程序。 如果没有此类任务,则返回 Default,它表示线程池。 在某些情况下,使用 Current 可能会导致死锁或 UI 响应问题,因为原本打算在线程池上创建任务,但却等待返回到 UI 线程。

有关详细信息和详细示例,请参阅 .NET Framework 4.5 中的新 TaskCreationOptions 和 TaskContinuationOptions

注意

VSTHRD105 - 避免使用假定 TaskScheduler.Current 是在 Microsoft.VisualStudio.Threading.Analyzers 包中实现的类似规则的方法重载。

如何解决冲突

若要解决冲突,请调用接受 TaskScheduler 并显式传入 DefaultCurrent 以使意图明确的方法重载。

何时禁止显示警告

此警告主要针对库,在库中,代码可能会在任意环境中执行,并且代码不应该对环境或方法的调用方如何调用或等待作出假设。 对于代表应用程序代码(而不是库代码)的项目,可禁止显示此警告。

抑制警告

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

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

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

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

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

另请参阅