基于任务的异步模式

基于任务的异步模式 (TAP) 是基于 System.Threading.Tasks 命名空间中的 System.Threading.Tasks.TaskSystem.Threading.Tasks.Task<TResult> 类型,这些类型用于表示任意异步操作。 TAP 是用于新开发的建议的异步设计模式。

命名、参数和返回类型

TAP 使用单个方法表示异步操作的开始和完成。 这与异步编程模型(APM 或 IAsyncResult)模式和基于事件的异步模式 (EAP) 形成对比。 APM 需要 BeginEnd 方法。 EAP 需要后缀为 Async 的方法,以及一个或多个事件、事件处理程序委托类型和 EventArg 派生类型。 TAP 中的异步方法在返回可等待类型(如 TaskTask<TResult>ValueTaskValueTask<TResult>)的方法的操作名称后面添加 Async 后缀。 例如,返回 Task<String> 的异步 Get 操作可命名为 GetAsync。 若要将 TAP 方法添加到已包含带 Async 后缀的 EAP 方法名称的类中,请改用后缀 TaskAsync。 例如,如果类具有 GetAsync 方法,请使用名称 GetTaskAsync。 如果方法启动异步操作,但不返回可等待类型,它的名称应以 BeginStart 或表明此方法不返回或抛出操作结果的其他某谓词开头。

TAP 方法返回 System.Threading.Tasks.TaskSystem.Threading.Tasks.Task<TResult>,具体取决于相应同步方法返回的是 void 还是类型 TResult

TAP 方法的参数应与其同步对应方法的参数匹配,并应以相同顺序提供。 但是,outref 参数不受此规则的限制,并应完全避免。 应该将通过 outref 参数返回的所有数据改为作为由 TResult 返回的 Task<TResult> 的一部分返回,且应使用元组或自定义数据结构来容纳多个值。 即使 TAP 方法的同步对应项没有提供 CancellationToken 参数,也应考虑添加此参数。

专用于创建、控制或组合任务的方法无需遵循此命名模式,因为方法名称或方法所属类型的名称已明确指明方法的异步用途;此类方法通常称为“组合器”。 组合器的示例包括 WhenAllWhenAny使用基于任务的异步模式一文的使用基于任务的内置组合器部分对此进行了介绍。

有关展示了 TAP 语法与旧异步编程模式(如异步编程模型 (APM) 和基于事件的异步模式 (EAP))语法区别的示例,请参阅异步编程模式

初始化异步操作

基于 TAP 的异步方法可以同步完成少量工作,如在返回结果任务之前,验证自变量和启动异步操作。 应将同步工作保持最小,以便异步方法可以快速返回。 快速返回的原因包括:

  • 可以从用户界面 (UI) 线程调用异步方法,因此,所有长期运行的同步工作可能会降低应用程序的响应能力。

  • 可以同时启动多个异步方法。 因此,在异步方法的同步部分中的任何长时间运行的工作都可以延迟其他异步操作的启动,从而减少并发的优点。

在某些情况下,完成操作所需的工作量要比异步启动操作所需的工作量少。 读取流时,按照在内存中已缓冲好的数据来满足该读取,这就是此类情形的一个示例。 在这样的情况下,操作可能会同步完成,同时返回已完成的任务。

异常

异步方法应引发仅将引发异步方法调用的异常,以响应用法错误。 用法错误决不应该出现在成品代码中。 例如,如果将空引用(在 Visual Basic 中为 Nothing)作为方法的某个参数传递导致了错误状态(通常由 ArgumentNullException 异常表示),则可以修改调用代码以确保绝对不传递空引用。 对于所有其他错误,在运行异步方法时发生的异常应分配给返回的任务,即使该异步方法碰巧在任务返回前同步完成。 通常,任务最多包含一个异常。 但是,如果任务表示多个操作(例如,WhenAll),则多个异常可能与单个任务关联。

目标环境

在实现 TAP 方法时,你可以确定异步执行发生的位置。 可选择在线程池上执行工作负载,通过使用异步 I/O 实现它(不必绑定到大部分操作执行的线程),在特定线程(如 UI 线程)上运行它,或者使用任何数目的潜在上下文。 TAP 方法甚至可能没有要执行的代码,可能只返回 Task 表示系统其他位置发生的情况(例如,表示到达已排入队列数据结构的数据的任务)。

TAP 方法的调用方可能会同步等待生成的任务,以阻止等待 TAP 方法完成,也可能会在异步操作完成时运行其他(延续)代码。 延续代码的创建者可以控制该代码的执行位置。 你可以通过 Task 类上的方法(例如,ContinueWith)显式创建延续代码,也可以使用基于延续(例如,C# 中的 await、Visual Basic 中的 Await 和 F# 中的 AwaitValue)构建的语言支持隐式创建延续代码。

任务状态

Task 类提供了异步操作的生命周期,且该周期由 TaskStatus 枚举表示。 为了支持派生自 TaskTask<TResult> 的类型的个别案例,并支持调度时分离构造,Task 类公开了 Start 方法。 公共 Task 构造函数创建的任务称为“冷任务”,因为它们在非计划 Created 状态下开始生命周期,并仅在对这些实例调用 Start 时才被排入计划。

所有其他任务在热状态下开始其生命周期,这意味着它们表示的异步操作已启动,并且其任务状态是 TaskStatus.Created 以外的枚举值。 必须激活从 TAP 方法返回的所有任务。 如果 TAP 方法在内部使用任务的构造函数来实例化要返回的任务,TAP 方法必须在返回前先对 Task 对象调用 Start。 TAP 方法的使用者可以安全地假设返回的任务处于活动状态且不应尝试对从 TAP 方法返回的任何 Start 调用 Task。 对活动的任务调用 Start 将引发 InvalidOperationException 异常。

取消(可选)

在 TAP 中,取消是异步方法实现者和异步方法使用者的选项。 如果操作允许取消,则会公开接受取消标记(CancellationToken 实例)的异步方法的重载。 按照约定,该参数命名为 cancellationToken

public Task ReadAsync(byte [] buffer, int offset, int count,
                      CancellationToken cancellationToken)
Public Function ReadAsync(buffer() As Byte, offset As Integer,
                          count As Integer,
                          cancellationToken As CancellationToken) _
                          As Task

该异步操作监视取消请求的此标记。 如果它收到取消请求,则可以选择接受该请求并取消操作。 如果取消请求导致过早地结束工作,则 TAP 方法返回一个在 Canceled 状态下结束的任务;没有可用结果且不引发异常。 Canceled 状态被视为任务的最终(完成)状态,以及 FaultedRanToCompletion 状态。 因此,如果一个任务处于 Canceled 状态,则其 IsCompleted 属性将返回 true。 在 Canceled 状态下完成任务时,将计划或执行向任务注册的任何延续,除非延续选项(如 NotOnCanceled)特定于取消延续。 任何通过使用语言功能异步等待已取消的任务的代码都将继续运行,但不接收 OperationCanceledException 或其中派生的异常。 通过诸如 Wait 的方法同步阻止的代码等待任务,并且 WaitAll 将继续运行但出现异常。

如果取消标记请求在接受调用标记的 TAP 方法之前取消,TAP 方法应返回 Canceled 任务。 但是,如果在运行异步操作时请求取消,则异步操作不需要接受该取消请求。 仅当该操作如取消请求的结果那样结束时,返回的任务才应以 Canceled 状态结束。 如果已请求取消,但仍然生成了结果或异常,则任务应在 RanToCompletionFaulted 状态下结束。

对于要首先对其公开可取消功能的异步方法,无需提供不接受取消令牌的重载。 对于无法取消的方法,不提供接受取消标记的重载;这有助于向调用方指示目标方法是否真正可取消。 不要求取消的使用者代码可以调用接受 CancellationToken 的方法,并提供 None 作为参数值。 None 在功能上等效于默认 CancellationToken

进度报告(可选)

某些异步操作受益于提供进度通知;这些通常用于使用有关该异步操作的进度的信息更新用户界面。

在 TAP 中,通过 IProgress<T> 接口处理进度,此接口作为通常名为 progress 的参数传递给异步方法。 调用异步方法时提供进度接口有助于消除不正确使用导致的争用情况(也就是说,操作启动后未正确注册的事件处理程序可能缺少更新)。 更重要的是,根据所使用的代码,进度接口将支持不同的进度实现。 例如,使用代码可能只关心最新的进度更新,可能需要缓冲所有更新,可能需要为各个更新调用操作,也可能需要控制是否需将该调用封送到特定线程。 通过使用接口的不同实现,所有这些选项都可以满足特定使用方的需要。 与取消一样,仅在 API 支持进度通知时,TAP 实现才应提供 IProgress<T> 参数。

例如,如果本文前面所述的 ReadAsync 方法可以以到目前为止读取的字节数的形式报告中间进度,则进度回调可能为 IProgress<T> 接口:

public Task ReadAsync(byte[] buffer, int offset, int count,
                      IProgress<long> progress)
Public Function ReadAsync(buffer() As Byte, offset As Integer,
                          count As Integer,
                          progress As IProgress(Of Long)) As Task

如果 FindFilesAsync 方法返回满足特定搜索模式的所有文件的列表,则进度回叫可以对已完成工作的百分比和当前部分结果集进行估计。 可通过元组来提供此信息:

public Task<ReadOnlyCollection<FileInfo>> FindFilesAsync(
            string pattern,
            IProgress<Tuple<double,
            ReadOnlyCollection<List<FileInfo>>>> progress)
Public Function FindFilesAsync(pattern As String,
                               progress As IProgress(Of Tuple(Of Double, ReadOnlyCollection(Of List(Of FileInfo))))) _
                               As Task(Of ReadOnlyCollection(Of FileInfo))

也可以使用特定于 API 的数据类型执行此操作:

public Task<ReadOnlyCollection<FileInfo>> FindFilesAsync(
    string pattern,
    IProgress<FindFilesProgressInfo> progress)
Public Function FindFilesAsync(pattern As String,
                               progress As IProgress(Of FindFilesProgressInfo)) _
                               As Task(Of ReadOnlyCollection(Of FileInfo))

在后一种情况下,特殊数据类型应加上后缀 ProgressInfo

如果 TAP 实现提供接受 progress 参数的重载,则必须允许该参数为 null,在这种情况下,不会报告任何进度。 TAP 实现应向 Progress<T> 对象同步报告进度,这使异步方法能够快速提供进度。 它还允许进度使用方确定处理信息的最佳方式和位置。 例如,进度实例可以选择将回调封送,并引发有关捕获到的同步上下文的事件。

IProgress<T> 实现

.NET 提供 Progress<T> 类,该类实现 IProgress<T>Progress<T> 类的声明方式如下:

public class Progress<T> : IProgress<T>  
{  
    public Progress();  
    public Progress(Action<T> handler);  
    protected virtual void OnReport(T value);  
    public event EventHandler<T>? ProgressChanged;  
}  

Progress<T> 的实例公开 ProgressChanged 事件,此事件在异步操作每次报告进度更新时引发。 实例化 ProgressChanged 实例后,会在捕获到的 SynchronizationContext 对象上引发 Progress<T> 事件。 如果没有可用的同步上下文,则使用针对线程池的默认上下文。 可以向此事件注册处理程序。 为了方便起见,也可将单个处理程序提供给 Progress<T> 构造函数,并且行为与 ProgressChanged 事件的事件处理程序一样。 异步引发进度更新以避免延迟异步操作,同时执行事件处理程序。 另一个 IProgress<T> 实现可以选择应用不同的语义。

选择要提供的重载

如果 TAP 实现使用可选的 CancellationToken 和可选的 IProgress<T> 参数,则可能需要多达四次的重载:

public Task MethodNameAsync(…);  
public Task MethodNameAsync(…, CancellationToken cancellationToken);  
public Task MethodNameAsync(…, IProgress<T> progress);
public Task MethodNameAsync(…,
    CancellationToken cancellationToken, IProgress<T> progress);  
Public MethodNameAsync(…) As Task  
Public MethodNameAsync(…, cancellationToken As CancellationToken cancellationToken) As Task  
Public MethodNameAsync(…, progress As IProgress(Of T)) As Task
Public MethodNameAsync(…, cancellationToken As CancellationToken,
                       progress As IProgress(Of T)) As Task  

但是,许多 TAP 实现没有提供取消和进度功能,因此它们需要一个方法:

public Task MethodNameAsync(…);  
Public MethodNameAsync(…) As Task  

如果 TAP 实现支持取消或进度但不同时支持二者,则 TAP 实现可能提供以下两种重载:

public Task MethodNameAsync(…);  
public Task MethodNameAsync(…, CancellationToken cancellationToken);  
  
// … or …  
  
public Task MethodNameAsync(…);  
public Task MethodNameAsync(…, IProgress<T> progress);  
Public MethodNameAsync(…) As Task  
Public MethodNameAsync(…, cancellationToken As CancellationToken) As Task  
  
' … or …  
  
Public MethodNameAsync(…) As Task  
Public MethodNameAsync(…, progress As IProgress(Of T)) As Task  

如果 TAP 实现同时支持取消和进度,则可以公开所有四个重载。 但它也可以只提供以下两个:

public Task MethodNameAsync(…);  
public Task MethodNameAsync(…,
    CancellationToken cancellationToken, IProgress<T> progress);  
Public MethodNameAsync(…) As Task  
Public MethodNameAsync(…, cancellationToken As CancellationToken,
                       progress As IProgress(Of T)) As Task  

若要弥补缺少的两个中间组合,开发人员可以为 cancellationToken 参数传递 None 或默认的 CancellationToken,为 null 参数传递 progress

如果需要 TAP 方法的每种用法都支持取消或进度,则可以忽略不接受相关参数的重载。

如果决定公开多个重载以使取消或进度可选,则不支持取消或进度的重载的行为方式就像其已将取消的 None 或进度的 null 传递给确实支持它们的重载。

Title 描述
异步编程模式 介绍执行异步操作的三种模式:基于任务的异步模式 (TAP)、异步编程模型 (APM) 和基于事件的异步模式 (EAP)。
实现基于任务的异步模式 描述如何使用以下三种方式实现基于任务的异步模式 (TAP):手动使用 Visual Studio 中的 C# 和 Visual Basic 编译器,或通过编译器和手动方法的组合。
使用基于任务的异步模式 描述你可以如何使用任务和回调实现等待,而无需阻止。
与其他异步模式和类型互操作 描述如何使用基于任务的异步模式 (TAP) 实现异步编程模型 (APM) 和基于事件的异步模式 (EAP)。