Чому я повинен створювати операції 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?

У вашому конкретному прикладі операція зовсім не асинхронна, тому те, що ви робите, - це асинхронізація через синхронізацію. Ви просто випускаєте одну нитку і блокуєте іншу. Причин тому немає, тому що всі потоки є потоками пулу потоків (на відміну від програми GUI).

У своєму обговоренні "асинхронізації через синхронізацію" я настійно запропонував, що якщо у вас є 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);
}