【问题标题】:How to use async / await with a method returning an ObservableCollection<T>如何通过返回 ObservableCollection<T> 的方法使用 async / await
【发布时间】:2017-01-03 13:20:25
【问题描述】:

我正在使用 MVVM 模式编写 WPF 应用程序。我必须说我(还)不熟悉 .NET 异步编程模型(只是学习它),但多年来一直在用 C/C++ 和 Java 编写多线程应用程序。

这个想法是在与 UI 线程不同的线程中开始长时间运行的查询,这样我就有机会在操作运行时显示微调器或进度条。

我的大多数内部服务方法返回集合或其他复杂类型,如 DTO 等。结果通常绑定到用户控件,如 GridViews、ListViews 等。我总是收到编译器错误,说我的返回类型不包含'GetAwaiter'。所以我一定是做错了什么。

这是我的 ViewModel 中这种方法的一个示例,它调用执行数据库查询并返回 ObservableCollection 的服务。

    private async void GetInvoices()
    {
        IsOperationRunning = true; //Binding for a RadBusyIndicator
        Invoices = await _uiContractService.GetInvoices(SelectedInvoiceState, SelectedSupplierItem.Id, SelectedInvoiceDateFilter, FilterStartDate, FilterEndDate);
        IsOperationRunning = false;
        RaisePropertyChanged(() => Invoices);
        if (Invoices.Count == 0)
            SendUserInfoMsg($"NO invoices matched your search criteria.", UiUserNotificationMessageType.Warning);
    }

这种情况下的编译器错误是: ObservableCollection&lt;InvoiceDto&gt;' does not contain a definition for 'GetAwaiter' and no extension method 'GetAwaiter' accepting a first argument of type 'ObservableCollection&lt;InvoiceDto&gt;' could be found

Invoices 集合和服务声明为

    public ObservableCollection<InvoiceDto> Invoices { get; set; }
    var _uiContractService = SimpleIoc.Default.GetInstance<UiContractService>();

服务方法的签名如下:

public ObservableCollection<InvoiceDto> GetInvoices(InvoiceState invoiceState, Guid supplierId, UiInvoiceDateFilters dateType, DateTime begin, DateTime end)

非常感谢任何能引导我走向正确方向的帮助。

【问题讨论】:

  • 您显示的代码都没有返回任务。您需要先将服务中的 GetInvoices 修复为异步

标签: c# wpf async-await


【解决方案1】:

您的代码应返回Task。

public Task<ObservableCollection<InvoiceDto>> GetInvoices(InvoiceState invoiceState, Guid supplierId, UiInvoiceDateFilters dateType, DateTime begin, DateTime end)
{
  // your code
}

【讨论】:

    【解决方案2】:

    GetInvoices 是否异步执行任何操作?如果是,它的签名应该是:
    public async Task&lt;ObservableCollection&lt;InvoiceDto&gt;&gt; GetInvoices(InvoiceState invoiceState, Guid supplierId, UiInvoiceDateFilters dateType, DateTime begin, DateTime end).
    如果你不是,那么你不应该担心 async 并从外部 GetInvoices 方法中删除 async/await 关键字。

    如果你想await 某事,它应该返回Task 或Task&lt;T&gt;。 (我什至不会讨论异步 void 方法)。

    【讨论】:

      【解决方案3】:

      您在 GetInvoices 中执行“假”异步任务:

      public async Task<ObservableCollection<InvoiceDto>> GetInvoicesAsync(InvoiceState invoiceState, Guid supplierId, UiInvoiceDateFilters dateType, DateTime begin, DateTime end)
      {
          return await Task.Run( () =>
          {
               return GetInvoices(invoiceState, supplierId, dateType, begin, end);
           });
      }
      

      这可能被认为是糟糕的代码,这里只是为了展示如何通过调用带有 Async 后缀的方法来使其正式等待

      无论如何,这是 wpf,而不是 asp.net 或 Web 应用程序。因此,如果它是一个纯桌面 GUI,那么在后台运行一个 db 任务是有意义的。如果是在应用服务器上而不是在客户端上,问题就更大了..

          Invoices = await _uiContractService.GetInvoicesAsync(SelectedInvoiceState, SelectedSupplierItem.Id, SelectedInvoiceDateFilter, FilterStartDate, FilterEndDate);
      

      请注意,错误的东西和不理想的东西之间有很大的区别,而且您并不总是可以立即支持升级到最新技术。

      您没有问但看起来很奇怪的另一点是您如何提高财产的变化。 一个更方便的地方是属性的设置者。 然后你不需要在分配之后调用它,除非你使用底层的私有成员。

      为了强调正在进行的工作,我之前也会清理收藏品,但这些都是个人喜好。

      【讨论】:

      • 你甚至不需要做那么多,而是使用Task.FromResult(TResult):创建一个Task&lt;TResult&gt;,它已成功完成并具有指定的结果。
      • @m-y 这完全没有意义,并且表明该方法首先不应该是异步的。
      • 是的,这不仅是为了让它正式异步,还要让它在后台运行
      • @Servy:我明白,我只是说你可以用它来代替建议的Task.Run()。
      • @Servy:设计不好还是代码无效?我同意,设计很糟糕(当它不是异步的时候不要做异步的东西),但是代码会编译和运行。
      【解决方案4】:

      多年来一直在用 C/C++ 和 Java 编写多线程应用程序。

      这种经历可能会误导您。异步代码与多线程代码非常不同。

      await 与线程无关。或者换一种说法,它不会增加使用的线程数;它减少它们。

      我建议您先阅读我的async intro,了解async/await 的实际作用。

      然后,您可以通过以下两种方式之一进行。第一种方法不是理想的,但实际上是您要求的:

      这个想法是在与 UI 线程不同的线程中开始长时间运行的查询,这样我就有机会在操作运行时显示微调器或进度条。

      第一种方法是多线程。在这种情况下,您可以使用async/await 作为从另一个线程上运行的操作(包括干净、正确的异常堆栈)中检索结果的便捷方式:

      private async Task GetInvoicesAsync()
      {
        IsOperationRunning = true; //Binding for a RadBusyIndicator
        Invoices = await Task.Run(() => _uiContractService.GetInvoices(SelectedInvoiceState, SelectedSupplierItem.Id, SelectedInvoiceDateFilter, FilterStartDate, FilterEndDate));
        IsOperationRunning = false;
        RaisePropertyChanged(() => Invoices);
        if (Invoices.Count == 0)
          SendUserInfoMsg($"NO invoices matched your search criteria.", UiUserNotificationMessageType.Warning);
      }
      

      请注意,是Task.Run 引入了多线程——它将工作安排到线程池。 async/await 是 UI 线程假装异步操作的方式。

      这可以从事件处理程序(或ICommand)中调用:

      public async void EventHandler(object sender, ...)
      {
        await GetInvoicesAsync();
      }
      

      请注意,只有事件处理程序应该是async void。请参阅我的article on async best practices 了解更多信息。


      但第一种方法并不理想,因为它并不是真正的异步。这就是我所说的“假异步”;也就是说,UI 假装它是异步的,但实际操作只是同步阻塞另一个线程。

      在编写真正的异步代码时,从 other 端开始会更容易——不是顶层的 UI 方法,而是底层的实际 API 调用。如果您的服务是 HTTP 服务,请查看 HttpClient;如果它们是 WCF 服务,请在启用异步 API 的情况下重新生成代理。

      一旦您拥有可用的最低级别的异步 API,就可以开始使用它们了。最终,你会得到一个异步的GetInvoices:

      public async Task<List<InvoiceDto>> GetInvoicesAsync(InvoiceState invoiceState, Guid supplierId, UiInvoiceDateFilters dateType, DateTime begin, DateTime end);
      

      (请注意,我从您的服务层中删除了ObservableCollection,因为它是面向 UI 的类型)

      那么你可以这样调用这个方法:

      private async Task GetInvoicesAsync()
      {
        IsOperationRunning = true; //Binding for a RadBusyIndicator
        Invoices = new ObservableCollection<InvoiceDto>(await _uiContractService.GetInvoicesAsync(SelectedInvoiceState, SelectedSupplierItem.Id, SelectedInvoiceDateFilter, FilterStartDate, FilterEndDate));
        IsOperationRunning = false;
        RaisePropertyChanged(() => Invoices);
        if (Invoices.Count == 0)
          SendUserInfoMsg($"NO invoices matched your search criteria.", UiUserNotificationMessageType.Warning);
      }
      

      这一次,没有Task.Run 或任何其他显式使用线程池线程。

      更多详情,请参阅我的brownfield async article 的“转换”部分。

      【讨论】:

      • 好帖子,谢谢!我的应用程序可以在单台 PC 上运行,也可以使用应用程序服务器分布在多台机器上。我在那里使用 WCF,是的,使用异步 API 是我将选择的方式。对于独立版本,我正在寻找一些东西,它可以让我通知用户该软件正在运行并且如果操作需要更长的时间并没有崩溃。我使用 DDD 模式已经很久了。独立和 n 层的区别主要在于合同的附加 DLL 和一些错误处理。无论如何,您的文章和您的书可能会有所帮助!
      • 这只是为了纯粹......但单线程不会造成伤害。此外,在打开连接之前,您肯定会受到 I/O 限制,但是一旦收到大量数据,您可能会开始出现 CPU 峰值,这取决于低延迟和大带宽……无论如何,代理都是“假的”外观以及服务的服务器端实现。
      • @Stephen Cleary,ContractService 中的更改将如何反映在此 UI 集合中?假设可以从其他上下文调用 ContractService(例如,从后台线程添加/更新发票)?
      • @Werner:首先,我尝试构建我的代码,以便其他服务的更新不会来自外部。例如,用户发起的刷新甚至民意调查都可以来自 UI 线程,然后自然可以使用async。但是,对于其他线程(或系统)可以推送更新到我的 UI 应用程序的极少数情况,我更喜欢使用 SynchronizationContext 切换到 UI,然后更新 ObservableCollection 或其他可能的-数据绑定实体。
      • @Stephen Cleary 谢谢。到目前为止,我一直在成功使用您的文章。您是否有一篇关于如何将 SynchronizationContext 从 UI 传递到服务的文章(或知道一篇文章)?我有一个用例,其中遥测数据来自硬件,我需要将这些数据从我的服务中冒泡到 UI 图中(服务和视图模型由我的 IoC 容器创建)。
      猜你喜欢
      • 2019-09-13
      • 2016-12-12
      • 1970-01-01
      • 2014-11-01
      • 1970-01-01
      • 2020-05-03
      • 2020-09-21
      • 2018-06-29
      • 2012-12-13
      相关资源
      最近更新 更多