为什么我应该创建异步 WebAPI 操作而不是同步操作？

Question

我在自己创建的 Web API 中有以下操作：

// GET api/<controller>
[HttpGet]
[Route("pharmacies/{pharmacyId}/page/{page}/{filter?}")]
public CartTotalsDTO GetProductsWithHistory(Guid pharmacyId, int page, string filter = null ,[FromUri] bool refresh = false)
{
    return delegateHelper.GetProductsWithHistory(CustomerContext.Current.GetContactById(pharmacyId), refresh);
}

对这个 web 服务的调用是通过 Jquery Ajax 调用完成的：

$.ajax({
      url: "/api/products/pharmacies/<%# Farmacia.PrimaryKeyId.Value.ToString() %>/page/" + vm.currentPage() + "/" + filter,
      type: "GET",
      dataType: "json",
      success: function (result) {
          vm.items([]);
          var data = result.Products;
          vm.totalUnits(result.TotalUnits);
      }          
  });

我见过一些开发者这样实现之前的操作：

// GET api/<controller>
[HttpGet]
[Route("pharmacies/{pharmacyId}/page/{page}/{filter?}")]
public async Task<CartTotalsDTO> GetProductsWithHistory(Guid pharmacyId, int page, string filter = null ,[FromUri] bool refresh = false)
{
    return await Task.Factory.StartNew(() => delegateHelper.GetProductsWithHistory(CustomerContext.Current.GetContactById(pharmacyId), refresh));
}

不过，必须说 GetProductsWithHistory() 是一个相当长的操作。鉴于我的问题和背景，使 webAPI 操作异步对我有什么好处？

Answer 1

在您的具体示例中，操作根本不是异步的，因此您所做的是异步而不是同步。你只是释放一个线程并阻塞另一个线程。没有理由这样做，因为所有线程都是线程池线程（与 GUI 应用程序不同）。

在我对“异步优于同步”的讨论中，我强烈建议如果您有一个内部同步实现的 API，您不应该公开一个简单地将同步方法包装在 Task.Run 中的异步对应物。

来自Should I expose asynchronous wrappers for synchronous methods?

但是，当进行 WebAPI 调用 async 时，其中有一个实际的异步操作（通常是 I/O），而不是阻塞一个等待结果的线程，该线程返回到线程池，因此能够执行一些其他操作手术。总而言之，这意味着您的应用程序可以用更少的资源做更多的事情并提高可扩展性。

Answer 2

一种方法可能是（我已在客户应用程序中成功使用此方法）让 Windows 服务使用工作线程运行冗长的操作，然后在 IIS 中执行此操作以释放线程，直到阻塞操作完成： 请注意，这假定结果存储在一个表中（由 jobId 标识的行），并且一个更清洁的进程在使用后数小时清理它们。

回答这个问题，“考虑到我的问题和背景，使 webAPI 操作异步对我有什么好处？”考虑到它是“相当长的操作”，我在想很多秒而不是毫秒，这种方法可以释放 IIS 线程。显然，您还必须运行一个本身占用资源的 Windows 服务，但这种方法可以防止大量缓慢的查询从系统的其他部分窃取线程。

// GET api/<controller>
[HttpGet]
[Route("pharmacies/{pharmacyId}/page/{page}/{filter?}")]
public async Task<CartTotalsDTO> GetProductsWithHistory(Guid pharmacyId, int page, string filter = null ,[FromUri] bool refresh = false)
{
        var jobID = Guid.NewGuid().ToString()
        var job = new Job
        {
            Id = jobId,
            jobType = "GetProductsWithHistory",
            pharmacyId = pharmacyId,
            page = page,
            filter = filter,
            Created = DateTime.UtcNow,
            Started = null,
            Finished = null,
            User =  {{extract user id in the normal way}}
        };
        jobService.CreateJob(job);

        var timeout = 10*60*1000; //10 minutes
        Stopwatch sw = new Stopwatch();
        sw.Start();
        bool responseReceived = false;
        do
        {
            //wait for the windows service to process the job and build the results in the results table
            if (jobService.GetJob(jobId).Finished == null)
            {
                if (sw.ElapsedMilliseconds > timeout ) throw new TimeoutException();
                await Task.Delay(2000);
            }
            else
            {
                responseReceived = true;
            }
        } while (responseReceived == false);

    //this fetches the results from the temporary results table
    return jobService.GetProductsWithHistory(jobId);
}