Window 8 app:嵌套异步调用

时间:2013-01-02 00:06:55

标签: c# windows-8 repository mvvm-light async-await

我正在构建一个Windows 8应用程序,我遇到异步调用问题。我将尝试尽可能多地提供详细信息,因为我认为我有2个结果:

  • 对于异步调用
  • ,我做的事情完全错了
  • 或者我做错了但是,我可能错误的架构让我解决了这个问题,而这个问题本来就不应该存在。

我是Windows Azure和MVVM的新手,但情况就是这样......

该应用程序现在是为Windows 8构建的,但我也希望能够使用其他平台,因此我首先要做的是创建一个发布到Windows Azure网站的WebAPI项目。这样,我可以使用JSON传输数据,并且WebAPI控制器连接到处理与Window Azure表存储之间的数据请求的存储库。第二部分是MVVM Light Windows 8应用程序,它从Azure网站请求数据。

让我们更详细地了解一下WebAPI项目。在这里,我有一个类别模型。

public class Category : TableServiceEntity
{
    [Required]
    public string Name { get; set; }

    public string Description { get; set; }

    public string Parent { get; set; }
}

类别模型只包含名称和描述(id是的RowKey TableServiceEntity)。如果类别是嵌套的,则还会将字符串引用添加到父类别。第一个问题出现了:父类型应该是类型而不是字符串,并且后端的类别模型是否应该有子类别的集合?

然后我有我的IRepository接口来定义存储库。 (正在进行中;-))它还使用规范模式来传递查询范围。这一切都正常,因为您可以使用浏览器进行测试并浏览到:http://homebudgettracker.azurewebsites.net/api/categories

public interface IRepository<T> where T : TableServiceEntity
{
    void Add(T item);
    void Delete(T item);
    void Update(T item);
    IEnumerable<T> Find(params Specification<T>[] specifications);
    IEnumerable<T> RetrieveAll();
    void SaveChanges();
}

现在存储库已经清楚了,让我们来看看控制器。我有一个CategoriesController,它只是一个包含IRepository存储库的ApiController。 (注入Ninject但不相关)

public class CategoriesController : ApiController
{
    static IRepository<Category> _repository;

    public CategoriesController(IRepository<Category> repository)
    {
        if (repository == null)
        {
            throw new ArgumentNullException("repository");
        }

        _repository = repository;    
        }

控制器包含一些方法,例如:

public Category GetCategoryById(string id)
{    
    IEnumerable<Category> categoryResults =_repository.Find(new ByRowKeySpecification(id));

    if(categoryResults == null)
    {
        throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound));
    }

    if (categoryResults.First<Category>() == null)
    {
        throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound));
    }

    return categoryResults.First<Category>();
}

到目前为止,我们已经看到了后端,让我们继续讨论实际问题:MvvmLight客户端和对WebAPI控制器的异步http请求。

在客户端项目中,我还有一个类别模型。

public class Category
{
    [JsonProperty("PartitionKey")]
    public string PartitionKey { get; set; }

    [JsonProperty("RowKey")]
    public string RowKey { get; set; }

    [JsonProperty("Name")]
    public string Name { get; set; }

    [JsonProperty("Description")]
    public string Description { get; set; }

    [JsonProperty("Timestamp")]
    public string Timestamp { get; set; }

    [JsonProperty("Parent")]
    public string ParentRowKey { get; set; }

    public ObservableCollection<Category> Children { get; set; }
}

不介意PartitionKey和RowKey属性,应该省略分区键,因为它与应用程序无关,Azure表服务授权属性存在。 RowKey实际上可以重命名为Id。但这里实际上并不相关。

主视图的ViewModel如下所示:

public class MainViewModel : CategoryBasedViewModel
{
    /// <summary>
    /// Initializes a new instance of the MainViewModel class.
    /// </summary>
    public MainViewModel(IBudgetTrackerDataService budgetTrackerDataService)
: base(budgetTrackerDataService)
    {
        PageTitle = "Home budget tracker";
    }
}

它从我创建的ViewModel扩展到共享包含Category Observable集合的页面的逻辑。这个ViewModel中的重要内容:

  • 注入ViewModel的IBudgetTrackerDataService,这是一个高级数据服务
  • 包含类别集合的ObservableCollection- ViewModel包装类别
  • 绑定的一些属性(fe:IsLoadingCategories在视图上处理ProgressRing)
  • 之后由IBudgetTrackerDataService调用的getCategoriesCompleted回调方法 异步调用将完成

所以代码如下:

public abstract class CategoryBasedViewModel : TitledPageViewModel
{
    private IBudgetTrackerDataService _dataService;

    private ObservableCollection<CategoryViewModel> _categoryCollection;

    private Boolean isLoadingCategories;

    public const string CategoryCollectionPropertyName = "CategoryCollection";

    public const string IsLoadingCategoriesPropertyName = "IsLoadingCategories";

    public Boolean IsLoadingCategories
    {
        get
        {
            return isLoadingCategories;
        }
        set
        {
            if (isLoadingCategories != value)
            {
                isLoadingCategories = value;
                RaisePropertyChanged(IsLoadingCategoriesPropertyName);
            }
        }
    }

    public ObservableCollection<CategoryViewModel> CategoryCollection
    {
        get
        {
            return _categoryCollection;
        }
        set
        {
            _categoryCollection = value;
            RaisePropertyChanged(CategoryCollectionPropertyName);
        }
    }

    public CategoryBasedViewModel(IBudgetTrackerDataService budgetTrackerDataService)
    {
        wireDataService(budgetTrackerDataService);
    }

    public CategoryBasedViewModel(IBudgetTrackerDataService budgetTrackerDataService, string pageTitle)
    {
        PageTitle = pageTitle;
        wireDataService(budgetTrackerDataService); 
    }

    private void wireDataService(IBudgetTrackerDataService budgetTrackerDataService)
    {
        _dataService = budgetTrackerDataService;
        CategoryCollection = new ObservableCollection<CategoryViewModel>();
        IsLoadingCategories = true;
        _dataService.GetCategoriesAsync(GetCategoriesCompleted);
    }

    private void GetCategoriesCompleted(IList<Category> result, Exception error)
    {
        if (error != null)
        {
            throw new Exception(error.Message, error);
        }

        if (result == null)
        {
            throw new Exception("No categories found");
        }

        IsLoadingCategories = false;

        CategoryCollection.Clear();

        foreach (Category category in result)
        {
            CategoryCollection.Add(new CategoryViewModel(category, _dataService));
            // Added the dataService as a parameter because the CategoryViewModel will handle the search for Parent Category and Children catagories
        }
    }
}

这一切都有效但现在我希望父/子关系能够处理类别。为此,我有 为CategoryViewModel添加了逻辑,以便在构造时获取子类别...

public CategoryViewModel(Category categoryModel, IBudgetTrackerDataService
budgetTrackerDataService)
{
    _category = categoryModel;
    _dataService = budgetTrackerDataService;

    // Retrieve all the child categories for this category
    _dataService.GetCategoriesByParentAsync(_category.RowKey,
GetCategoriesByParentCompleted);
}

因此,构建CategoryBasedViewModel是获取类别并调用回调方法GetCategoriesCompleted:

_dataService.GetCategoriesAsync(GetCategoriesCompleted);

该回调方法也调用了CategoryViewModel的构造函数。在那里,另一个异步方法用于获取类别的子项。

public CategoryViewModel(Category categoryModel, IBudgetTrackerDataService
budgetTrackerDataService)
{
    _category = categoryModel;
    _dataService = budgetTrackerDataService;

    // Retrieve all the child categories for this category
    _dataService.GetCategoriesByParentAsync(_category.RowKey,
GetCategoriesByParentCompleted);
}

还有我的问题! GetCategoriesByParentAsync是在另一个异步调用中发生的异步调用,代码刚刚中断调用并且什么都不做。

数据服务实现接口:

public interface IBudgetTrackerDataService
{
    void GetCategoriesAsync(Action<IList<Category>, Exception> callback);

    void GetCategoriesByParentAsync(string parent, Action<IList<Category>,
Exception> callback);
}

异步方法包含以下代码:

public async void GetCategoriesAsync(Action<IList<Category>, Exception> callback)
{
    // Let the HTTP client request the data
    IEnumerable<Category> categoryEnumerable = await _client.GetAllCategories();

    // Invoke the callback function passed to this operation
    callback(categoryEnumerable.ToList<Category>(), null);
}

public async void GetCategoriesByParentAsync(string parent, Action<IList<Category>,
Exception> callback)
{
    // Let the HTTP client request the data
    IEnumerable<Category> categoryEnumerable = await
_client.GetCategoriesWithParent(parent);

    // Invoke the callback function passed to this operation
    callback(categoryEnumerable.ToList<Category>(), null);
}

长话短说:

  • 为什么在嵌套呼叫时这些呼叫会失败?
  • 其次,我是愚蠢的,我应该处理父母/子女 笼养的关系不同?

1 个答案:

答案 0 :(得分:4)

我现在要回避父/子关系问题,只解决async问题。

首先,我在async/await intro blog post中详细解释了async代码的一些常规指南:

  • 避免使用async void(返回TaskTask<T>)。
  • 适用时使用ConfigureAwait(false)

我已经看到其他人采用了callback委托方式,但我不知道它来自哪里。它与async不兼容,只会使代码复杂化,即IMO。 Task<T>类型旨在表示与Exception结合的结果值,并与await无缝协作。

首先,您的数据服务:

public interface IBudgetTrackerDataService
{
  Task<IList<Category>> GetCategoriesAsync();
  Task<IList<Category>> GetCategoriesByParentAsync(string parent);
}

public async Task<IList<Category>> GetCategoriesAsync()
{
  // Let the HTTP client request the data
  IEnumerable<Category> categoryEnumerable = await _client.GetAllCategories().ConfigureAwait(false);
  return categoryEnumerable.ToList();
}

public async Task<IList<Category>> GetCategoriesByParentAsync(string parent)
{
  // Let the HTTP client request the data
  IEnumerable<Category> categoryEnumerable = await _client.GetCategoriesWithParent(parent).ConfigureAwait(false);
  return categoryEnumerable.ToList();
}

或更好,如果您实际上不需要IList<T>

public interface IBudgetTrackerDataService
{
  Task<IEnumerable<Category>> GetCategoriesAsync();
  Task<IEnumerable<Category>> GetCategoriesByParentAsync(string parent);
}

public Task<IEnumerable<Category>> GetCategoriesAsync()
{
  // Let the HTTP client request the data
  return _client.GetAllCategories();
}

public Task<IEnumerable<Category>> GetCategoriesByParentAsync(string parent)
{
  // Let the HTTP client request the data
  return _client.GetCategoriesWithParent(parent);
}

(此时,您可能会质疑数据服务的用途)。


继续讨论MVVM async问题:async对构造函数的影响不大。我有一篇博文在几周内发布,会详细解决这个问题,但这里有一个要点:

我个人的偏好是使用异步工厂方法(例如public static async Task<MyType> CreateAsync()),但这并非总是可行,特别是如果您正在为您的VM使用DI / IoC。

在这种情况下,我喜欢在需要异步初始化的类型上公开一个属性(实际上,我使用IAsyncInitialization接口,但对于你的代码,一个约定也可以正常工作):{{1} }。

此属性在构造函数中只设置一次,如下所示:

public Task Initialized { get; }

然后,您可以选择让“父”VM等待其“子”虚拟机初始化。目前尚不清楚这是否是您想要的,但我假设您希望public CategoryViewModel(Category categoryModel, IBudgetTrackerDataService budgetTrackerDataService) { _category = categoryModel; _dataService = budgetTrackerDataService; // Retrieve all the child categories for this category Initialized = InitializeAsync(); } private async Task InitializeAsync() { var categories = await _dataService.GetCategoriesByParentAsync(_category.RowKey); ... } IsLoadingCategories,直到所有子虚拟机都已加载:

true

我添加了public CategoryBasedViewModel(IBudgetTrackerDataService budgetTrackerDataService) { _dataService = budgetTrackerDataService; CategoryCollection = new ObservableCollection<CategoryViewModel>(); IsLoadingCategories = true; Initialized = InitializeAsync(); NotifyOnInitializationErrorAsync(); } private async Task InitializeAsync() { var categories = await _dataService.GetCategoriesAsync(); CategoryCollection.Clear(); foreach (var category in categories) { CategoryCollection.Add(new CategoryViewModel(category, _dataService)); } // Wait until all CategoryViewModels have completed initializing. await Task.WhenAll(CategoryCollection.Select(category => category.Initialized)); IsLoadingCategories = false; } private async Task NotifyOnInitializationErrorAsync() { try { await Initialized; } catch { NotifyPropertyChanged("InitializationError"); throw; } } public string InitializationError { get { return Initialized.Exception.InnerException.Message; } } InitializationError来演示一种表达初始化期间可能发生的错误的方法。由于NotifyOnInitializationErrorAsync未实现Task,因此如果初始化失败,则无法自动通知,因此您必须明确表示它。