在异步按钮点击上重复使用UI处理代码

时间:2015-08-25 15:40:34

标签: c# async-await interceptor

情况

在客户端/服务器体系结构中,通常在长时间运行的操作(例如服务器端通信)期间停用UI控件。 This answer shows a dedicated solution针对非常具体的情况。

// condensed code listing from linked answer
private async void Button_Click_1(object sender, RoutedEventArgs e)
{
    DisableUI(); 
    try { await ViewModel.CreateMessageCommand(); }
    finally { EnableUI(); }
}

有没有办法概括/抽象这种操作并重用它?在某些应用程序中,此代码往往会重复多次。然而,它遵循Stephen Cleary的文章指出的最佳实践,喜欢一直使用async并且除了事件处理之外更喜欢async Task而不是async void。此按钮单击处理程序。 Async Await Best Practices

假设有以下部分可能长时间运行的代码:

// somewhere in an appropriate scope
async Task TheWorkWeGotToDo() { Task.Delay(2000); }

我们测试了一些尝试,以集中围绕这个可能长时间运行的操作启用和禁用代码的UI:

Attemp 1

class OurButton extends SomeKnownButton {
  Action theWork;
  public async void HandleClick(object sender, EventArgs args) {
    DisableUI();
    try { await theWork(); }
    finally { EnableUI(); }
}

由于滥用非await实例,此尝试不允许async Action声明的操作并抛出编译错误。

尝试2

class OurButton extends SomeKnownButton {
  Task theWork;
  public async void HandleClick(object sender, EventArgs args) {
    DisableUI();
    try { await theWork; }
    finally { EnableUI(); }
}

此尝试允许await指定为Task的工作,并允许将任务的创建与其执行分开,如Microsoft async await初学者所指出的那样。 Async-Await Beginners Article from Microsoft

// Signature specifies Task<TResult>
async Task<int> TaskOfTResult_MethodAsync()
{
    int hours;
    // . . .
    // Return statement specifies an integer result.
    return hours;
}

// Calls to TaskOfTResult_MethodAsync
Task<int> returnedTaskTResult = TaskOfTResult_MethodAsync();
int intResult = await returnedTaskTResult;
// or, in a single statement
int intResult = await TaskOfTResult_MethodAsync();

这会编译,但很难定义应该包装的所需工作。对这种情况的一些不满意的尝试是:

尝试2a

OurButton b = /* init */;
b.theWork = TheWorkWeGotToDo; // compile error

尝试2b

OurButton b = /* init */;
b.theWork = new Task(() => TheWorkWeGotToDo());

这会编译,但它的行为并不像预期的那样。

尝试3

另一种可能性是在按钮类中声明virtual成员。子类可以使用async关键字实现此操作。

class T {
    async void Test() { await AsyncWork(); }  
    public virtual async Task AsyncWork() {} // warning: will run synchronously
}

class WrappedOperation : T {
  public override async Task AsyncWork() { await TheWorkWeGotToDo(); }
}

从按钮类中获取每一种情况似乎都是不合适的。

问题

说到一些功能和面向方面的编程背景:是否有可能装饰一个函数来异步拦截一部分代码?

OurButton b = /* init */;
Action someWork = /* some long running task */;
Action guardedWork = someWork.SurroundWithUiGuards(b);
b.Clicked += guardedWork;

// in some appropriate scope
static class Extension {
  public static Action SurroundWithUiGuards(this Action work, SomeKnownButton b) {
    return () => {
      b.Disable();
      try { work(); }
      finally { b.Enable(); }
    };
  }
}

所以在这种情况下:是否有可能采用像Action这样的someWork并包裹拦截代码来保护ui元素并返回一个新的&#39; Action&#39;实例

注释

这是一个有点开放的问题,解决具体问题就足够了。但是,任何回答抽象问题的建议都非常感谢!当前的目标环境是单线程ui框架,Xamarin。

我认为主要的问题是,一方面似乎不可能将异步操作声明为字段。另一方面,可以声明异步lambda表达式,但是如何等待它们呢?我也希望我能监督一些非常明显的事情。

我对c#async await编程非常陌生,但我已经阅读了大量asyncawait篇文章。

1 个答案:

答案 0 :(得分:2)

实际解决的解决方案是使用Task个对象定义所有内容。可以等待Task,因此指出了一个解决方案,用拦截代码包装长时间运行的操作:

static class Ext {
  public static async Task SurroundWithUIGuard(this Task task, SomeButton button) {
    button.Enabled = false;
    try { await task; }
    finally { button.Enabled = true; }
  }
}

这是将任务创建与执行分开并通过修改Task实例在其之前和之后包装代码的功能方法。 要定义一个事件处理程序,只需要输入一些async和await表达式。

SomeButton b = /* init */;
b.Clicked += async (s,e) => await Task.Delay(5000).SurroundWithUIGuard(b);

此外,async lambda表达式是此系列async void操作中唯一的async Task,因此遵循最佳实践。由于大量使用async await关键字,它似乎仍然有点冗长,但允许重复使用这部分代码。