任务FromResult与TaskCompletionSource SetResult

时间:2014-01-21 10:57:10

标签: c# asp.net-web-api task-parallel-library async-await taskcompletionsource

的功能和含义有什么区别

TaskCompletionSource + SetResult vs 任务+ FromResult

SendAsync方法中的

protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
    if (request.RequestUri.Scheme != Uri.UriSchemeHttps)
    {
        var response = new HttpResponseMessage(HttpStatusCode.Forbidden) {ReasonPhrase = "HTTPS Required"};
        var taskCompletionSource = new TaskCompletionSource<HttpResponseMessage>();
        taskCompletionSource.SetResult(response);
        return taskCompletionSource.Task;
    }
    return base.SendAsync(request, cancellationToken);
}

protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
    if (!request.RequestUri.Scheme.Equals(Uri.UriSchemeHttps, StringComparison.OrdinalIgnoreCase))
    {
        HttpResponseMessage reply = request.CreateErrorResponse(HttpStatusCode.BadRequest, "HTTPS is required for security reason.");
        return Task.FromResult(reply);
    }

    return base.SendAsync(request, cancellationToken);
}

5 个答案:

答案 0 :(得分:31)

Task.FromResult是.NET 4.5中的新增功能。它是一个帮助方法,它创建一个TaskCompletionSource并调用SetResult。如果您使用的是.NET 4或更早版本,则必须使用SetResult。

答案 1 :(得分:4)

如果你想要的只是返回一个已完成的Task<TResult>结果(或已完成的Task没有结果),只需使用Task.FromResult

Task.FromResult是一个使用结果创建已完成任务的简单工具。 TaskCompletionSource是一个更强大的工具,可以支持所有内容。您可以设置例外,返回未完成的任务并在以后设置结果等等

P.S:看起来你正试图通过返回完成的任务来“伪造”异步方法。虽然这是最好的方法,但要确保“假装”异步确实是你想要完成的。

答案 2 :(得分:3)

我很确定Task.FromResult()在封面下做了类似的事情。

TaskCompletionSource的更好的用例场景是您自己实现多线程。在这种情况下,您会立即返回一个等待的任务,在后台线程完成并调用TaskCompletionSource.SetResult()TaskCompletionSource.SetException()之前,其结果不会设置。

答案 3 :(得分:1)

我相信Task.FromResult()效率更高,但您也可以执行以下操作,这更具可读性,IMO:

protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
    if (request.RequestUri.Scheme != Uri.UriSchemeHttps)
        return new HttpResponseMessage(HttpStatusCode.Forbidden) {ReasonPhrase = "HTTPS Required"};
    return await base.SendAsync(request, cancellationToken);
}

您仍然可以覆盖基础的虚拟SendAsync,因为async不会更改方法签名。

答案 4 :(得分:0)

Task.FromResult是一种为同步方法创建任务的便捷方法。尽管一个Task表示一个异步操作,但并非所有Task实际上都是异步的,可能只是同步方法的简单包装。

如果使用Task.FromResult,请在文档中说明您的方法不是“真正的”异步方法,而是糖的语法多维数据集。这将通知调用方不要期望异步行为。

另一方面,如果要手动创建异步函数,请按照SetResult所述使用TaskCompletionSource的TrySetResulthere方法。

不管您的.NET框架版本如何,始终使用TaskCompletionSource而不是Task.FromResult来创建真正的异步函数。

来源:

  1. Task.FromResult
  2. Internal Constructor of Task
  3. TaskCompletionSource.SetResult
  4. TaskCompletionSource.TrySetResult