使用基于任务的异步模式 您所在的位置:网站首页 未找到适用于完成此操作的图像处理组件 使用基于任务的异步模式

使用基于任务的异步模式

2023-11-14 06:22| 来源: 网络整理| 查看: 265

使用基于任务的异步模式 项目 05/09/2023

使用基于任务的异步模式 (TAP) 处理异步操作时,可以使用回叫实现等待,而不会阻塞。 对于任务,这可通过 Task.ContinueWith 等方法实现。 通过允许在正常控制流中等待异步操纵,基于语言的异步支持可隐藏回叫,并且编译器生成的代码可提供此相同 API 级别的支持。

使用 Await 挂起执行

可以使用 C# 中的 await 关键字和 Visual Basic 中的 Await 运算符来异步等待 Task 和 Task 对象。 等待 Task 时,await 表达式的类型为 void。 等待 Task 时,await 表达式的类型为 TResult。 await 表达式必须出现在异步方法的正文内。 (.NET Framework 4.5 中引入了这些语言功能。)

实际上,await 功能通过使用延续任务在任务上安装回叫。 此回叫在挂起点恢复异步方法。 恢复异步方法时,如果等待的操作已成功完成且为 Task,返回的是 TResult。 如果等待的 Task 或 Task 以 Canceled 状态结束,就会抛出 OperationCanceledException 异常。 如果等待的 Task 或 Task 以 Faulted 状态结束,就会抛出导致它发生故障的异常。 一个 Task 可能由于多个异常而出错,但只会传播一个异常。 不过,Task.Exception 属性会返回包含所有错误的 AggregateException 异常。

如果同步上下文(SynchronizationContext 对象)与暂停时正在执行异步方法的线程(例如,SynchronizationContext.Current 属性不是 null)相关联,异步方法使用上下文的 Post 方法,恢复相同的同步上下文。 否则,它依赖暂停时的当前任务计划程序(TaskScheduler 对象)。 通常情况下,这是定目标到线程池的默认任务计划程序 (TaskScheduler.Default)。 此任务计划程序确定等待的异步操作是否应在该操作完成时恢复,或是否应计划该恢复。 默认计划程序通常允许在完成等待操作的线程上延续任务。

调用异步方法时,将同步执行函数的正文,直到遇见尚未完成的可等待实例上的第一个 await 表达式,此时调用返回到调用方。 如果异步方法不返回 void,将会返回 Task 或 Task 对象,以表示正在进行的计算。 在非 void 异步方法中,如果遇到 return 语句或到达方法正文末尾,任务就以 RanToCompletion 最终状态完成。 如果未经处理的异常导致无法控制异步方法正文,任务就以 Faulted 状态结束。 如果异常为 OperationCanceledException,任务改为以 Canceled 状态结束。 通过此方式,最终将发布结果或异常。

此行为有几种重要特殊情况。 出于性能原因,如果任务在等待时已完成,则不会生成控件,并且该函数将继续执行。 返回到原始上下文并不总是所需的行为,可对其进行更改;将在下一节中更详细地描述此内容。

使用 Yield 和 ConfigureAwait 配置挂起和恢复

有多种方法可更好地控制异步方法的执行。 例如,可以使用 Task.Yield 方法,将暂停点引入异步方法:

public class Task : … { public static YieldAwaitable Yield(); … }

这相当于以异步方式发布或计划返回当前上下文。

Task.Run(async delegate { for(int i=0; i pbDownloadProgress.Value = p)); } finally { btnDownload.IsEnabled = true; } }

使用内置的基于任务的连结符

System.Threading.Tasks 命名空间包含多个方法,可用于撰写和处理任务。

Task.Run

Task 类包含多个 Run 方法,以便于将工作作为 Task 或 Task 轻松卸载到线程池,例如:

public async void button1_Click(object sender, EventArgs e) { textBox1.Text = await Task.Run(() => { // … do compute-bound work here return answer; }); }

其中部分 Run 方法(如 Task.Run(Func) 重载)以 TaskFactory.StartNew 方法的简约表示形式存在。 借助此重载,可以在卸载的工作内使用 await,例如:

public async void button1_Click(object sender, EventArgs e) { pictureBox1.Image = await Task.Run(async() => { using(Bitmap bmp1 = await DownloadFirstImageAsync()) using(Bitmap bmp2 = await DownloadSecondImageAsync()) return Mashup(bmp1, bmp2); }); }

此类重载在逻辑上相当于结合使用 TaskFactory.StartNew 方法和任务并行库中的 Unwrap 扩展方法。

Task.FromResult

FromResult 方法的适用情景为,数据可能已存在,且只需通过提升到 Task 的任务返回方法返回:

public Task GetValueAsync(string key) { int cachedValue; return TryGetCachedValue(out cachedValue) ? Task.FromResult(cachedValue) : GetValueAsyncInternal(); } private async Task GetValueAsyncInternal(string key) { … } Task.WhenAll

WhenAll 方法可用于异步等待多个表示为任务的异步操作。 该方法所具有的多个重载支持一组非泛型任务或一组不统一的常规任务(如异步等待多个返回 void 的操作,或异步等待多个返回值的方法,其中每个值可能具有不同类型),并支持一组统一的常规任务(如异步等待多个 TResult 返回方法)。

假设你想要向多个客户发送电子邮件。 你可以重叠发送邮件,因此发送邮件时无需等待上一封邮件完成发送。 还可以查看发送操作完成的时间,以及是否发生了错误:

IEnumerable asyncOps = from addr in addrs select SendMailAsync(addr); await Task.WhenAll(asyncOps);

此代码不显式处理可能发生的异常,而是通过对 WhenAll 生成的任务执行 await 传播异常。 若要处理该异常,可以使用以下代码:

IEnumerable asyncOps = from addr in addrs select SendMailAsync(addr); try { await Task.WhenAll(asyncOps); } catch(Exception exc) { ... }

在这种情况下,如果任意异步操作失败,所有异常都会合并到 AggregateException 异常中,此异常存储在 WhenAll 方法返回的 Task 中。 但是,仅通过 await 关键字传播其中一个异常。 如果想要检查所有异常,可以重写前面的代码,如下所示:

Task [] asyncOps = (from addr in addrs select SendMailAsync(addr)).ToArray(); try { await Task.WhenAll(asyncOps); } catch(Exception exc) { foreach(Task faulted in asyncOps.Where(t => t.IsFaulted)) { … // work with faulted and faulted.Exception } }

让我们考虑一下以异步方式从 Web 下载多个文件的示例。 在此示例中,所有异步操作具有相同的结果类型,并很容易对结果进行访问:

string [] pages = await Task.WhenAll( from url in urls select DownloadStringTaskAsync(url));

可以使用上一个返回 void 方案中所讨论的异常处理技术:

Task [] asyncOps = (from url in urls select DownloadStringTaskAsync(url)).ToArray(); try { string [] pages = await Task.WhenAll(asyncOps); ... } catch(Exception exc) { foreach(Task faulted in asyncOps.Where(t => t.IsFaulted)) { … // work with faulted and faulted.Exception } } Task.WhenAny

WhenAny 方法可用于异步等待多个表示为要完成的任务的异步操作之一。 此方法适用于四个主要用例:

冗余:多次执行一个操作并选择最先完成的一次(例如,联系能够生成一个结果的多个股市行情 Web 服务并选择完成最快的一个)。

交错:启动多个操作并等待所有这些操作完成,但是在完成这些操作时对其进行处理。

限制:允许其他操作完成时开始附加操作。 这是交错方案的扩展。

早期释放:例如,用任务 t1 表示的操作可以与任务 t2 组成 WhenAny 任务,您可以等待 WhenAny 任务。 任务 t2 可以表示超时、取消或其他一些导致 WhenAny 任务先于 t1 完成的信号。

冗余

假设你想要决定是否购买股票。 你信任一些股票建议 Web 服务,但每个服务最终会在不同的时间段变得很慢,具体取决于每日负载。 WhenAny 方法可用于在任何操作完成时接收通知:

var recommendations = new List() { GetBuyRecommendation1Async(symbol), GetBuyRecommendation2Async(symbol), GetBuyRecommendation3Async(symbol) }; Task recommendation = await Task.WhenAny(recommendations); if (await recommendation) BuyStock(symbol);

WhenAll 返回已成功完成的所有任务的取消包装结果。与它不同,WhenAny 返回已完成的任意任务。 如果任务失败,重要的是知道该任务失败,如果任务成功,重要的是知道返回值与哪个任务相关联。 因此,你需要访问返回任务的结果,或进一步等待,如本示例中所示。

与 WhenAll 一样,必须能够容纳异常。 因为接收到完成的任务后,可以等待返回的任务传播错误,并适当地进行 try/catch,例如:

Task [] recommendations = …; while(recommendations.Count > 0) { Task recommendation = await Task.WhenAny(recommendations); try { if (await recommendation) BuyStock(symbol); break; } catch(WebException exc) { recommendations.Remove(recommendation); } }

此外,即使第一个任务成功完成,后续任务也可能会失败。 此时,可以有多个选择来处理异常:可以等待所有启动的任务完成,这种情况可以使用 WhenAll 方法,或者决定所有异常是否重要且必须记录。 为此,可以使用延续任务以在任务异步完成时接收通知:

foreach(Task recommendation in recommendations) { var ignored = recommendation.ContinueWith( t => { if (t.IsFaulted) Log(t.Exception); }); }

或:

foreach(Task recommendation in recommendations) { var ignored = recommendation.ContinueWith( t => Log(t.Exception), TaskContinuationOptions.OnlyOnFaulted); }

或者甚至:

private static async void LogCompletionIfFailed(IEnumerable tasks) { foreach(var task in tasks) { try { await task; } catch(Exception exc) { Log(exc); } } } … LogCompletionIfFailed(recommendations);

最后,若要取消所有剩余操作:

var cts = new CancellationTokenSource(); var recommendations = new List() { GetBuyRecommendation1Async(symbol, cts.Token), GetBuyRecommendation2Async(symbol, cts.Token), GetBuyRecommendation3Async(symbol, cts.Token) }; Task recommendation = await Task.WhenAny(recommendations); cts.Cancel(); if (await recommendation) BuyStock(symbol); 交错

假设你要从 Web 下载图像,并且处理每个图像(例如,将图像添加到 UI 控件)。 可以在 UI 线程上按顺序处理图像,但建议尽可能同时下载图像。 此外,建议不要直到所有图像都下载完成才将图像添加到 UI。 建议在完成下载时添加它们。

List imageTasks = (from imageUrl in urls select GetBitmapAsync(imageUrl)).ToList(); while(imageTasks.Count > 0) { try { Task imageTask = await Task.WhenAny(imageTasks); imageTasks.Remove(imageTask); Bitmap image = await imageTask; panel.AddImage(image); } catch{} }

还可以将交错应用于涉及下载图像 ThreadPool 的计算密集型处理的方案;例如:

List imageTasks = (from imageUrl in urls select GetBitmapAsync(imageUrl) .ContinueWith(t => ConvertImage(t.Result)).ToList(); while(imageTasks.Count > 0) { try { Task imageTask = await Task.WhenAny(imageTasks); imageTasks.Remove(imageTask); Bitmap image = await imageTask; panel.AddImage(image); } catch{} } 遏制

请考虑交错示例,因用户大量下载图像而导致下载必须受到遏制除外;例如,你希望仅能同时下载特定数目的内容。 为此,可以启动异步操作的子集。 操作完成后,你可以启动其他操作对其进行替代:

const int CONCURRENCY_LEVEL = 15; Uri [] urls = …; int nextIndex = 0; var imageTasks = new List(); while(nextIndex < CONCURRENCY_LEVEL && nextIndex < urls.Length) { imageTasks.Add(GetBitmapAsync(urls[nextIndex])); nextIndex++; } while(imageTasks.Count > 0) { try { Task imageTask = await Task.WhenAny(imageTasks); imageTasks.Remove(imageTask); Bitmap image = await imageTask; panel.AddImage(image); } catch(Exception exc) { Log(exc); } if (nextIndex < urls.Length) { imageTasks.Add(GetBitmapAsync(urls[nextIndex])); nextIndex++; } } 早期释放

假设正在异步等待某个操作完成的同时,对用户的取消请求(例如,用户单击取消按钮)进行响应。 以下代码阐释了此方案:

private CancellationTokenSource m_cts; public void btnCancel_Click(object sender, EventArgs e) { if (m_cts != null) m_cts.Cancel(); } public async void btnRun_Click(object sender, EventArgs e) { m_cts = new CancellationTokenSource(); btnRun.Enabled = false; try { Task imageDownload = GetBitmapAsync(txtUrl.Text); await UntilCompletionOrCancellation(imageDownload, m_cts.Token); if (imageDownload.IsCompleted) { Bitmap image = await imageDownload; panel.AddImage(image); } else imageDownload.ContinueWith(t => Log(t)); } finally { btnRun.Enabled = true; } } private static async Task UntilCompletionOrCancellation( Task asyncOp, CancellationToken ct) { var tcs = new TaskCompletionSource(); using(ct.Register(() => tcs.TrySetResult(true))) await Task.WhenAny(asyncOp, tcs.Task); return asyncOp; }

一旦决定退出,此实现将重新启用用户界面,但不会取消基础异步操作。 另一种选择是决定退出时,取消挂起的操作,但在操作完成之前不重新建立用户界面,可能会由于取消请求而提前结束:

private CancellationTokenSource m_cts; public async void btnRun_Click(object sender, EventArgs e) { m_cts = new CancellationTokenSource(); btnRun.Enabled = false; try { Task imageDownload = GetBitmapAsync(txtUrl.Text, m_cts.Token); await UntilCompletionOrCancellation(imageDownload, m_cts.Token); Bitmap image = await imageDownload; panel.AddImage(image); } catch(OperationCanceledException) {} finally { btnRun.Enabled = true; } }

另一个早期释放示例涉及结合使用 WhenAny 方法和 Delay 方法,下一部分将对此进行介绍。

Task.Delay

Task.Delay 方法可用于将暂停引入异步方法的执行中。 这对于许多功能都非常有用,包括构建轮询循环和延迟预定时间段的用户输入处理。 Task.Delay 方法还可以与 Task.WhenAny 结合使用,以对 await 实现超时。

如果某任务属于较大型异步操作(如 ASP.NET Web 服务)中的一部分,由于花费时间过长而不能完成,则整体操作可能会受到影响(尤其是此任务一直不能完成的情况下)。 因此,等待异步操作时可以超时非常重要。 虽然同步 Task.Wait、Task.WaitAll 和 Task.WaitAny 方法接受超时值,但相应的 TaskFactory.ContinueWhenAll/TaskFactory.ContinueWhenAny 和前述 Task.WhenAll/Task.WhenAny 方法不接受。 相反,可以将 Task.Delay 与 Task.WhenAny结合使用,以实现超时。

例如,在 UI 应用程序中,假设你想要下载图像,并在图像下载期间禁用该 UI。 但是,如果下载时间过长,你希望重新启用 UI 并放弃下载:

public async void btnDownload_Click(object sender, EventArgs e) { btnDownload.Enabled = false; try { Task download = GetBitmapAsync(url); if (download == await Task.WhenAny(download, Task.Delay(3000))) { Bitmap bmp = await download; pictureBox.Image = bmp; status.Text = "Downloaded"; } else { pictureBox.Image = null; status.Text = "Timed out"; var ignored = download.ContinueWith( t => Trace("Task finally completed")); } } finally { btnDownload.Enabled = true; } }

这同样适用于多个下载,因为 WhenAll 返回任务:

public async void btnDownload_Click(object sender, RoutedEventArgs e) { btnDownload.Enabled = false; try { Task downloads = Task.WhenAll(from url in urls select GetBitmapAsync(url)); if (downloads == await Task.WhenAny(downloads, Task.Delay(3000))) { foreach(var bmp in downloads.Result) panel.AddImage(bmp); status.Text = "Downloaded"; } else { status.Text = "Timed out"; downloads.ContinueWith(t => Log(t)); } } finally { btnDownload.Enabled = true; } } 构建基于任务的连结符

因为任务可以完全代表异步操作、提供同步和异步功能来加入操作、检索其结果等,所以可以构建组成任务的连结符的库以构建更大的模式。 如前一部分所述,.NET 包括一些内置连结符,但是,你也可以构建自己的连结符。 以下各节提供了一些潜在的连结符方法和类型的示例。

RetryOnFault

在许多情况下,如果上次尝试失败,你可能想要重试操作。 对于同步代码,你可能会构建一个帮助器方法来实现此目的,如下例中的 RetryOnFault:

public static T RetryOnFault( Func function, int maxTries) { for(int i=0; i Task.Delay(1000)); NeedOnlyOne

有时,你可以利用冗余改进操作延迟和提高成功的可能性。 假设有多个 Web 服务提供股票报价,但在一天中的不同时间,每个服务可能提供不同级别的质量和响应时间。 为了应对这些波动,你可能会向所有 Web 服务发出请求,并且只要从其中一个获得响应,立刻取消剩余的请求。 你可以通过 helper 函数更轻松地实现此启动多个操作的通用模式:等待任何操作,然后取消其余部分。 以下示例中的 NeedOnlyOne 函数阐释了这种方案:

public static async Task NeedOnlyOne( params Func [] functions) { var cts = new CancellationTokenSource(); var tasks = (from function in functions select function(cts.Token)).ToArray(); var completed = await Task.WhenAny(tasks).ConfigureAwait(false); cts.Cancel(); foreach(var task in tasks) { var ignored = task.ContinueWith( t => Log(t), TaskContinuationOptions.OnlyOnFaulted); } return completed; }

然后,你可以使用此函数,如下所示:

double currentPrice = await NeedOnlyOne( ct => GetCurrentPriceFromServer1Async("msft", ct), ct => GetCurrentPriceFromServer2Async("msft", ct), ct => GetCurrentPriceFromServer3Async("msft", ct)); 交错操作

处理大型任务集时,如果使用 WhenAny 方法支持交错方案,可能存在潜在性能问题。 每次调用 WhenAny 都会向每个任务注册延续。 对于 N 个任务,这将导致在交错操作的操作期间创建 O(N2) 次延续。 如果处理大型任务集,则可以使用连结符(以下示例中的 Interleaved)来解决性能问题:

static IEnumerable Interleaved(IEnumerable tasks) { var inputTasks = tasks.ToList(); var sources = (from _ in Enumerable.Range(0, inputTasks.Count) select new TaskCompletionSource()).ToList(); int nextTaskIndex = -1; foreach (var inputTask in inputTasks) { inputTask.ContinueWith(completed => { var source = sources[Interlocked.Increment(ref nextTaskIndex)]; if (completed.IsFaulted) source.TrySetException(completed.Exception.InnerExceptions); else if (completed.IsCanceled) source.TrySetCanceled(); else source.TrySetResult(completed.Result); }, CancellationToken.None, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default); } return from source in sources select source.Task; }

然后,可以在任务完成时,使用连结符来处理任务的结果,例如:

IEnumerable tasks = ...; foreach(var task in Interleaved(tasks)) { int result = await task; … } WhenAllOrFirstException

在特定的分散/集中情况下,你可能想要等待集中的所有任务,除非某个任务发生错误。在这种情况下,你希望在异常发生时停止等待。 你可以通过使用连结符方法(如 WhenAllOrFirstException)实现该目的,如下所示:

public static Task WhenAllOrFirstException(IEnumerable tasks) { var inputs = tasks.ToList(); var ce = new CountdownEvent(inputs.Count); var tcs = new TaskCompletionSource(); Action onCompleted = (Task completed) => { if (completed.IsFaulted) tcs.TrySetException(completed.Exception.InnerExceptions); if (ce.Signal() && !tcs.Task.IsCompleted) tcs.TrySetResult(inputs.Select(t => t.Result).ToArray()); }; foreach (var t in inputs) t.ContinueWith(onCompleted); return tcs.Task; } 构建基于任务的数据结构

除了能够生成基于任务的自定义组合器,在 Task 和 Task(表示异步操作结果和联接所必需的同步操作结果)中包含数据结构,还可以使其成为功能非常强大的类型,基于该类型可生成在异步方案中使用的自定义数据结构。

AsyncCache

任务的重要方面之一是,它可能会分发到多个使用者,所有使用者都可以等待任务、向任务注册延续、获取任务结果或异常(如果是 Task 的话)等。 这样一来,Task 和 Task 就非常适用于异步缓存基础结构。 下面的示例演示了基于 Task 生成的功能非常强大的小型异步缓存:

public class AsyncCache { private readonly Func _valueFactory; private readonly ConcurrentDictionary _map; public AsyncCache(Func valueFactory) { if (valueFactory == null) throw new ArgumentNullException("valueFactory"); _valueFactory = valueFactory; _map = new ConcurrentDictionary(); } public Task this[TKey key] { get { if (key == null) throw new ArgumentNullException("key"); return _map.GetOrAdd(key, toAdd => new Lazy(() => _valueFactory(toAdd))).Value; } } }

AsyncCache 类接受需要使用 TKey 且返回 Task 的函数作为构造函数的委托。 以前从缓存访问的所有值都存储在内部字典中,AsyncCache 可以确保每个密钥仅生成一个任务,即便同时访问缓存也是如此。

例如,你可以生成下载网页的缓存:

private AsyncCache m_webPages = new AsyncCache(DownloadStringTaskAsync);

然后可以在任何需要网页内容的时候,以异步方式使用此缓存。 AsyncCache 类可确保下载尽可能少的页面,并缓存结果。

private async void btnDownload_Click(object sender, RoutedEventArgs e) { btnDownload.IsEnabled = false; try { txtContents.Text = await m_webPages["https://www.microsoft.com"]; } finally { btnDownload.IsEnabled = true; } } AsyncProducerConsumerCollection

你还可以使用任务来构建协调异步活动的数据结构。 请考虑经典的并行设计模式之一:制造者/使用者。 在此模式下,制造者生成数据,使用者使用数据,制造者和使用者可能会并行运行。 例如,使用者处理之前由制造者生成的第 1 项,而制造者现在正在制造第 2 项。 对于制造者/使用者模式,总是需要某种数据结构来存储制造者创建的工作,以便使用者可以收到新数据的通知并及时发现新数据。

以下是基于任务构建的简单数据结构,可以将异步方法用作生成方和使用方:

public class AsyncProducerConsumerCollection { private readonly Queue m_collection = new Queue(); private readonly Queue m_waiting = new Queue(); public void Add(T item) { TaskCompletionSource tcs = null; lock (m_collection) { if (m_waiting.Count > 0) tcs = m_waiting.Dequeue(); else m_collection.Enqueue(item); } if (tcs != null) tcs.TrySetResult(item); } public Task Take() { lock (m_collection) { if (m_collection.Count > 0) { return Task.FromResult(m_collection.Dequeue()); } else { var tcs = new TaskCompletionSource(); m_waiting.Enqueue(tcs); return tcs.Task; } } } }

通过该数据结构,可以编写如下所示的代码:

private static AsyncProducerConsumerCollection m_data = …; … private static async Task ConsumerAsync() { while(true) { int nextItem = await m_data.Take(); ProcessNextItem(nextItem); } } … private static void Produce(int data) { m_data.Add(data); }

System.Threading.Tasks.Dataflow 命名空间包括 BufferBlock 类型,可以类似方式使用它,但无需生成自定义集合类型:

private static BufferBlock m_data = …; … private static async Task ConsumerAsync() { while(true) { int nextItem = await m_data.ReceiveAsync(); ProcessNextItem(nextItem); } } … private static void Produce(int data) { m_data.Post(data); }

注意

System.Threading.Tasks.Dataflow 命名空间作为 NuGet 包提供。 若要安装包含 System.Threading.Tasks.Dataflow 命名空间的程序集,请在 Visual Studio 中打开项目,选择“项目”菜单中的“管理 NuGet 包”,再在线搜索 System.Threading.Tasks.Dataflow 包。

请参阅 基于任务的异步模式 (TAP) 实现基于任务的异步模式 与其他异步模式和类型互操作


【本文地址】

公司简介

联系我们

今日新闻

    推荐新闻

    专题文章
      CopyRight 2018-2019 实验室设备网 版权所有