如何实现返回Task<T>的接口方法？

Question

我有一个界面

interface IFoo
{
  Task<Bar> CreateBarAsync();
}

创建Bar有两种方法，一种是异步的，一种是同步的。我想为这两种方法分别提供一个接口实现。

对于异步方法，实现可能如下所示：

class Foo1 : IFoo
{
  async Task<Bar> CreateBarAsync()
  {
    return await AsynchronousBarCreatorAsync();
  }
}

但是我应该如何实现使用同步方法创建Bar的类Foo2？

我可以实现同步运行的方法：

  async Task<Bar> CreateBarAsync()
  {
    return SynchronousBarCreator();
  }

然后编译器将警告不要在方法签名中使用async：

此异步方法缺少“等待”运算符，将同步运行。考虑使用 'await' 运算符来等待非阻塞 API 调用，或使用 'await Task.Run(...)' 在后台线程上执行 CPU 密集型工作。

或者，我可以实现显式返回Task<Bar>的方法。在我看来，代码会看起来不那么可读：

  Task<Bar> CreateBarAsync()
  {
    return Task.Run(() => SynchronousBarCreator());
  }

从性能的角度来看，我想这两种方法的开销大致相同，或者？

我应该选择哪种方法；同步实现async 方法或将同步方法调用显式包装在Task 中？

编辑

我正在处理的项目实际上是一个 .NET 4 项目，带有来自 Microsoft Async NuGet 包的 async / await 扩展。在 .NET 4 上，Task.Run 然后可以替换为 TaskEx.Run。在上面的示例中，我有意识地使用了 .NET 4.5 方法，希望使主要问题更加清晰。

Answer 1

当您必须从接口实现异步方法并且您的实现是同步的时，您可以使用 Ned 的解决方案：

public Task<Bar> CreateBarAsync()
{
    return Task.FromResult<Bar>(SynchronousBarCreator());
}

使用此解决方案，该方法看起来是异步的，但实际上是同步的。

或者你提出的解决方案：

  Task<Bar> CreateBarAsync()
  {
    return Task.Run(() => SynchronousBarCreator());
  }

这样方法是真正异步的。

您没有通用的解决方案来匹配“如何实现返回任务的接口方法”的所有情况。这取决于上下文：您的实现是否足够快，所以在另一个线程上调用它是没用的？何时调用此方法（它会冻结应用程序）如何使用此接口？甚至可以在另一个线程中调用您的实现吗？

Answer 2

试试这个：

class Foo2 : IFoo
{
    public Task<Bar> CreateBarAsync()
    {
        return Task.FromResult<Bar>(SynchronousBarCreator());
    }
}

Task.FromResult 使用提供的值创建指定类型的已完成任务。

Answer 3

如果您使用的是 .NET 4.0，则可以使用TaskCompletionSource<T>：

Task<Bar> CreateBarAsync()
{
    var tcs = new TaskCompletionSource<Bar>();
    tcs.SetResult(SynchronousBarCreator());
    return tcs.Task
}

最终，如果您的方法没有任何异步，您应该考虑公开一个同步端点 (CreateBar)，它会创建一个新的 Bar。这样就没有惊喜，也不需要用多余的 Task 包装。

Answer 4

为了补充其他答案，还有一个选项，我相信它也适用于 .NET 4.0：

class Foo2 : IFoo
{
    public Task<Bar> CreateBarAsync()
    {
        var task = new Task<Bar>(() => SynchronousBarCreator());
        task.RunSynchronously();
        return task;
    }
}

注意task.RunSynchronously()。与Task<>.FromResult 和TaskCompletionSource<>.SetResult 相比，它可能是最慢的选项，但有一个微妙但重要的区别：错误传播行为。

上述方法将模仿async 方法的行为，其中异常永远不会在同一个堆栈帧上抛出（展开），而是以休眠状态存储在Task 对象中。调用者实际上必须通过await task 或task.Result 观察它，此时它将被重新抛出。

Task<>.FromResult 和 TaskCompletionSource<>.SetResult 不是这种情况，SynchronousBarCreator 抛出的任何异常都将直接传播给调用者，展开调用堆栈。

我在这里有更详细的解释：

Any difference between "await Task.Run(); return;" and "return Task.Run()"?

附带说明，我建议在设计界面时添加取消条款（即使当前未使用/实现取消）：

interface IFoo
{
    Task<Bar> CreateBarAsync(CancellationToken token);
}

class Foo2 : IFoo
{
    public Task<Bar> CreateBarAsync(CancellationToken token)
    {
        var task = new Task<Bar>(() => SynchronousBarCreator(), token);
        task.RunSynchronously();
        return task;
    }
}