如何使 ASP.NET Core Web API 操作异步执行？

Question

我的 ASP.NET Core Web API 的控制器中有一个动作，用于上传和处理文件。文件小没关系，但文件大了怎么办？我希望这个动作异步执行，所以我将方法定义为async，它的返回值只是Task可以等待，并在await Task.Run(() => ...)块中插入连续操作，使动作也async并调用这个方法带有await关键字，但实际上调用该方法后该动作并没有返回。我试图上传大文件，并且不得不等到文件完全上传和处理。那么，我应该怎么做才能让这个动作真正异步执行呢？

Answer 1

Web Api 项目的调用方不知道 C# 细节，不知道 Task 是什么或 await 是什么意思。它可能是 C# 或 JS 甚至是 PHP，或者是在浏览器栏中键入您的 URL 的人。

默认情况下（并且应该！）您的 Web Api 将等待整个处理完成，然后发出成功的信号。这通常通过状态码作为返回值来完成。

现在客户端调用您的 API 不必等待。但那是客户端编程。你不能在你的 API 中做任何事情来解决客户的问题。

否则，您可以让您的 API 将文件放入处理队列中，以便稍后由不同的软件处理。但这需要另一种架构，因为现在调用者需要在不再连接到您的 API 时收到失败成功（或一般结果）的通知，因此您需要回调。

Answer 2

我有这段代码用于处理大文件（这是用于上传大型 CSV 文件）：

    public async Task<IActionResult> UploadAsync(IFormFile file)
    {
        // Ensure the file has contents before processing.
        if (file == null || file.Length == 0)
            throw new ApiException("Csv file should not be null", HttpStatusCode.BadRequest)
                .AddApiExceptionResponseDetails(ErrorTypeCode.ValidationError, ErrorCode.BelowMinimumLength, SOURCE); 

        // Ensure the file is not over the allowed limit.
        if (file.Length > (_settings.MaxCsvFileSize * 1024))
            throw new ApiException("Max file size exceeded, limit of " + _settings.MaxCsvFileSize + "mb", HttpStatusCode.BadRequest)
                .AddApiExceptionResponseDetails(ErrorTypeCode.ValidationError, ErrorCode.ExceedsMaximumLength, SOURCE); 

        // Ensure the file type is csv and content type is correct for the file.
        if (Path.GetExtension(file.FileName) != ".csv" || 
            !Constants.CsvAcceptedContentType.Contains(file.ContentType.ToLower(CultureInfo.InvariantCulture)))
                throw new ApiException("Csv content only accepted").AddApiExceptionResponseDetails(ErrorTypeCode.ValidationError, ErrorCode.Invalid, SOURCE);

        // Read csv content.
        var content = await file.ReadCsvAsync<OrderCsvResponseDto>() as CsvProcessedResponseDto<OrderCsvResponseDto>;

        await ProcessBulkUpload(content);

        // Return information about the csv file.
        return Ok(content);
    }

    internal async Task ProcessBulkUpload(CsvProcessedResponseDto<OrderCsvResponseDto> content)
    {
         // do some processing...
    }

有 web.config 设置可以增加文件上传的允许时间，这可能会有所帮助：How to increase the max upload file size in ASP.NET?

如果您的请求超过允许的最大超时时间，数据将不会按预期返回给您的调用者！

如果你想从 C# 中执行“即发即弃”代码，你可以这样做：

public static void FireAndForget(this Task task)
{
    Task.Run(async() => await task).ConfigureAwait(false);
}

Javascript：

xhr.onreadystatechange = function() { xhr.abort(); }

AngularJS：

var defer = $q.defer();
$http.get('/example', { timeout: defer.promise }).success(callback);
// [...]
defer.resolve();

一些针对 Js 的 async/await 技巧：http://2ality.com/2016/10/async-function-tips.html