Почему я должен создавать операции async WebAPI вместо операций синхронизации?

У меня есть следующая операция в созданном мной веб-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);
}

Вызов этого веб-сервиса выполняется через вызов 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 с учетом моей проблемы и контекста?

В вашем конкретном примере операция не является асинхронной, поэтому вы делаете асинхронную синхронизацию. Вы просто освобождаете один поток и блокируете другой. Для этого нет причин, потому что все потоки являются потоками пула потоков (в отличие от приложения с графическим интерфейсом).

В моем обсуждении «асинхронности вместо синхронизации» я настоятельно рекомендовал, чтобы если у вас есть API, который внутренне реализуется синхронно, вы не должны предоставлять асинхронный аналог, который просто обертывает синхронный метод Task.Run.

От Должен ли я предоставлять синхронные оболочки для асинхронных методов?

Однако при выполнении вызовов WebAPI, asyncкогда выполняется фактическая асинхронная операция (обычно ввод-вывод), вместо блокировки потока, который сидит и ожидает результата, поток возвращается в пул потоков и, таким образом, может выполнять некоторые другие операции. В целом это означает, что ваше приложение может делать больше с меньшими ресурсами, что улучшает масштабируемость.

Одним из подходов может быть (я успешно использовал это в клиентских приложениях), чтобы служба 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);
}