如何从 getter 或 setter 调用异步方法？

Question

在 C# 中从 getter 或 setter 调用异步方法的最优雅的方式是什么？

这里有一些伪代码来帮助解释我自己。

async Task<IEnumerable> MyAsyncMethod()
{
    return await DoSomethingAsync();
}

public IEnumerable MyList
{
    get
    {
         //call MyAsyncMethod() here
    }
}

Answer 1

没有技术原因在 C# 中不允许使用 async 属性。这是一个有目的的设计决策，因为“异步属性”是矛盾的。

属性应该返回当前值；他们不应该启动后台操作。

通常，当有人想要一个“异步属性”时，他们真正想要的是以下之一：

1. 返回值的异步方法。在这种情况下，请将属性更改为 async 方法。
2. 可用于数据绑定但必须异步计算/检索的值。在这种情况下，要么对包含对象使用 async 工厂方法，要么使用 async InitAsync() 方法。在计算/检索该值之前，数据绑定值将是 default(T)。
3. 创建成本高，但应缓存以备将来使用的值。在这种情况下，请使用 AsyncLazy from my blog 或 AsyncEx library。这将为您提供awaitable 属性。

更新：我在最近的一篇“异步 OOP”博文中介绍了 asynchronous properties。

Answer 2

你不能异步调用它，因为没有异步属性支持，只有异步方法。因此，有两种选择，都利用了 CTP 中的异步方法实际上只是返回 Task<T> 或 Task 的方法这一事实：

// Make the property return a Task<T>
public Task<IEnumerable> MyList
{
    get
    {
         // Just call the method
         return MyAsyncMethod();
    }
}

或者：

// Make the property blocking
public IEnumerable MyList
{
    get
    {
         // Block via .Result
         return MyAsyncMethod().Result;
    }
}

Answer 3

由于我的解耦架构，我真的需要调用源自 get 方法。所以我想出了以下实现。

用法： 标题位于 ViewModel 或您可以静态声明为页面资源的对象中。绑定到它，当 getTitle() 返回时，该值将被填充而不会阻塞 UI。

string _Title;
public string Title
{
    get
    {
        if (_Title == null)
        {   
            Deployment.Current.Dispatcher.InvokeAsync(async () => { Title = await getTitle(); });
        }
        return _Title;
    }
    set
    {
        if (value != _Title)
        {
            _Title = value;
            RaisePropertyChanged("Title");
        }
    }
}

Answer 4

你可以像这样使用Task：

public int SelectedTab
        {
            get => selected_tab;
            set
            {
                selected_tab = value;

                new Task(async () =>
                {
                    await newTab.ScaleTo(0.8);
                }).Start();
            }
        }

Answer 5

我认为我们可以等待只返回第一个 null 的值，然后获取真正的值，所以对于 Pure MVVM（例如 PCL 项目），我认为以下是最优雅的解决方案：

private IEnumerable myList;
public IEnumerable MyList
{
  get
    { 
      if(myList == null)
         InitializeMyList();
      return myList;
     }
  set
     {
        myList = value;
        NotifyPropertyChanged();
     }
}

private async void InitializeMyList()
{
   MyList = await AzureService.GetMyList();
}

Answer 6

我认为 .GetAwaiter().GetResult() 正是解决这个问题的方法，不是吗？ 例如：

string _Title;
public string Title
{
    get
    {
        if (_Title == null)
        {   
            _Title = getTitle().GetAwaiter().GetResult();
        }
        return _Title;
    }
    set
    {
        if (value != _Title)
        {
            _Title = value;
            RaisePropertyChanged("Title");
        }
    }
}

Answer 7

由于您的“异步属性”在视图模型中，您可以使用AsyncMVVM：

class MyViewModel : AsyncBindableBase
{
    public string Title
    {
        get
        {
            return Property.Get(GetTitleAsync);
        }
    }

    private async Task<string> GetTitleAsync()
    {
        //...
    }
}

它将为您处理同步上下文和属性更改通知。

Answer 8

当我遇到这个问题时，尝试从 setter 或构造函数运行异步方法同步使我陷入 UI 线程的死锁，并且使用事件处理程序需要对一般设计进行太多更改。
解决方案通常是明确地写出我想要隐式发生的事情，即让另一个线程处理操作并让主线程等待它完成：

string someValue=null;
var t = new Thread(() =>someValue = SomeAsyncMethod().Result);
t.Start();
t.Join();

你可以说我滥用了这个框架，但它确实有效。

Answer 9

死灵术。
在 .NET Core/NetStandard2 中，可以使用Nito.AsyncEx.AsyncContext.Run 代替System.Windows.Threading.Dispatcher.InvokeAsync：

class AsyncPropertyTest
{

    private static async System.Threading.Tasks.Task<int> GetInt(string text)
    {
        await System.Threading.Tasks.Task.Delay(2000);
        System.Threading.Thread.Sleep(2000);
        return int.Parse(text);
    }


    public static int MyProperty
    {
        get
        {
            int x = 0;

            // https://stackoverflow.com/questions/6602244/how-to-call-an-async-method-from-a-getter-or-setter
            // https://stackoverflow.com/questions/41748335/net-dispatcher-for-net-core
            // https://github.com/StephenCleary/AsyncEx
            Nito.AsyncEx.AsyncContext.Run(async delegate ()
            {
                x = await GetInt("123");
            });

            return x;
        }
    }


    public static void Test()
    {
        System.Console.WriteLine(System.DateTime.Now.ToString("dd.MM.yyyy HH:mm:ss.fff"));
        System.Console.WriteLine(MyProperty);
        System.Console.WriteLine(System.DateTime.Now.ToString("dd.MM.yyyy HH:mm:ss.fff"));
    }


}

如果您只是选择了System.Threading.Tasks.Task.Run 或System.Threading.Tasks.Task<int>.Run，那么它不会起作用。

Answer 10

您可以创建事件并在属性更改时调用事件。 像这样的：

private event EventHandler<string> AddressChanged;
public YourClassConstructor(){
     AddressChanged += GoogleAddressesViewModel_AddressChanged;
}
private async void GoogleAddressesViewModel_AddressChanged(object sender, string e){
      ... make your async call
}
private string _addressToSearch;
public string AddressToSearch
{
    get { return _addressToSearch; }
    set
    {
        _addressToSearch = value;
        AddressChanged.Invoke(this, AddressToSearch);
    }
}

Answer 11

我认为下面的示例可能遵循@Stephen-Cleary 的方法，但我想给出一个编码示例。这适用于数据绑定上下文，例如 Xamarin。

类的构造函数 - 或者实际上是它所依赖的另一个属性的设置器 - 可能会调用异步 void，它会在任务完成时填充属性，而无需等待或阻塞。当它最终获得一个值时，它将通过 NotifyPropertyChanged 机制更新您的 UI。

我不确定从构造函数调用 aysnc void 的任何副作用。也许评论者会详细说明错误处理等。

class MainPageViewModel : INotifyPropertyChanged
{
    IEnumerable myList;

    public event PropertyChangedEventHandler PropertyChanged;

    public MainPageViewModel()
    {

        MyAsyncMethod()

    }

    public IEnumerable MyList
    {
        set
        {
            if (myList != value)
            {
                myList = value;

                if (PropertyChanged != null)
                {
                    PropertyChanged(this, new PropertyChangedEventArgs("MyList"));
                }
            }
        }
        get
        {
            return myList;
        }
    }

    async void MyAsyncMethod()
    {
        MyList = await DoSomethingAsync();
    }


}

Answer 12

我查看了所有答案，但都存在性能问题。

例如：

string _Title;
public string Title
{
    get
    {
        if (_Title == null)
        {   
            Deployment.Current.Dispatcher.InvokeAsync(async () => { Title = await getTitle(); });
        }
        return _Title;
    }
    set
    {
        if (value != _Title)
        {
            _Title = value;
            RaisePropertyChanged("Title");
        }
    }
}

Deployment.Current.Dispatcher.InvokeAsync(async () => { Title = await getTitle(); });

使用不是一个好的答案的调度程序。

但是有一个简单的解决方案，就去做吧：

string _Title;
    public string Title
    {
        get
        {
            if (_Title == null)
            {   
                Task.Run(()=> 
                {
                    _Title = getTitle();
                    RaisePropertyChanged("Title");
                });        
                return;
            }
            return _Title;
        }
        set
        {
            if (value != _Title)
            {
                _Title = value;
                RaisePropertyChanged("Title");
            }
        }
    }

Answer 13

您可以将属性更改为Task<IEnumerable>

然后做一些类似的事情：

get
{
    Task<IEnumerable>.Run(async()=>{
       return await getMyList();
    });
}

并像使用它一样 等待我的列表；