通过 ASP.NET Web API 有效地使用 async/await

Question

我正在尝试在我的 Web API 项目中使用 ASP.NET 的 async/await 功能。我不太确定它是否会对我的 Web API 服务的性能产生任何影响。请在下面找到我的应用程序的工作流程和示例代码。

工作流程：

UI 应用 → Web API 端点（控制器） → 在 Web API 服务层调用方法 → 调用另一个外部 Web 服务。 （这里有数据库交互等）

控制器：

public async Task<IHttpActionResult> GetCountries()
{
    var allCountrys = await CountryDataService.ReturnAllCountries();

    if (allCountrys.Success)
    {
        return Ok(allCountrys.Domain);
    }

    return InternalServerError();
}

服务层：

public Task<BackOfficeResponse<List<Country>>> ReturnAllCountries()
{
    var response = _service.Process<List<Country>>(BackOfficeEndpoint.CountryEndpoint, "returnCountries");

    return Task.FromResult(response);
}

我测试了上面的代码并且正在运行。但我不确定async/await的正确用法是否正确。请分享您的想法。

Answer 1

您没有有效地利用 async / await 因为请求线程将在执行 同步 方法时被阻塞 ReturnAllCountries()

分配给处理请求的线程将在ReturnAllCountries() 工作时空闲等待。

如果您可以将ReturnAllCountries() 实现为异步的，那么您将看到可扩展性优势。这是因为线程可以释放回 .NET 线程池以处理另一个请求，而 ReturnAllCountries() 正在执行。通过更有效地利用线程，这将使您的服务具有更高的吞吐量。

Answer 2

我不太确定这是否会对我的 API 性能产生任何影响。

请记住，服务器端异步代码的主要好处是可扩展性。它不会神奇地使您的请求运行得更快。我在article on async ASP.NET 中介绍了几个“我应该使用async”的注意事项。

我认为您的用例（调用其他 API）非常适合异步代码，请记住“异步”并不意味着“更快”。最好的方法是首先让您的 UI 响应式和异步；这将使您的应用感觉更快，即使它稍微慢一些。

就代码而言，这不是异步的：

public Task<BackOfficeResponse<List<Country>>> ReturnAllCountries()
{
  var response = _service.Process<List<Country>>(BackOfficeEndpoint.CountryEndpoint, "returnCountries");
  return Task.FromResult(response);
}

您需要一个真正的异步实现来获得async 的可扩展性优势：

public async Task<BackOfficeResponse<List<Country>>> ReturnAllCountriesAsync()
{
  return await _service.ProcessAsync<List<Country>>(BackOfficeEndpoint.CountryEndpoint, "returnCountries");
}

或者（如果你在这个方法中的逻辑真的只是一个传递）：

public Task<BackOfficeResponse<List<Country>>> ReturnAllCountriesAsync()
{
  return _service.ProcessAsync<List<Country>>(BackOfficeEndpoint.CountryEndpoint, "returnCountries");
}

请注意，像这样从“由内而外”而不是“由外而内”工作更容易。换句话说，不要从异步控制器操作开始，然后强制下游方法异步。相反，识别自然异步操作（调用外部 API、数据库查询等），并首先在 最低 级别使这些异步操作 (Service.ProcessAsync)。然后让async 慢慢上升，最后一步使您的控制器操作异步。

在这种情况下，在任何情况下都不应使用Task.Run。

Answer 3

它是正确的，但也许没有用。

由于没有什么可以等待 - 没有调用可以异步操作的阻塞 API - 那么您正在设置结构来跟踪异步操作（有开销），但随后不使用该功能。

例如，如果服务层使用支持异步调用的实体框架执行数据库操作：

public Task<BackOfficeResponse<List<Country>>> ReturnAllCountries()
{
    using (db = myDBContext.Get()) {
      var list = await db.Countries.Where(condition).ToListAsync();

       return list;
    }
}

您将允许工作线程在查询数据库时执行其他操作（从而能够处理另一个请求）。

Await 往往是需要一直向下的东西：很难改造到现有系统中。

Answer 4

我会将您的服务层更改为：

public Task<BackOfficeResponse<List<Country>>> ReturnAllCountries()
{
    return Task.Run(() =>
    {
        return _service.Process<List<Country>>(BackOfficeEndpoint.CountryEndpoint, "returnCountries");
    }      
}

正如你所拥有的那样，你仍然在同步运行你的_service.Process 调用，并且从等待它中获得的好处很少或没有。

使用这种方法，您可以将可能很慢的调用包装在 Task 中，启动它，然后将其返回以等待。现在您可以等待Task。