返回Task的接口的同步实现

Question

类似于Implementing an interface that requires a Task return type in synchronous code，尽管我很好奇是否应该忽略我的情况产生的编译器错误。

假设我有一个这样的界面：

public interface IAmAwesome {
    Task MakeAwesomeAsync();
}

在某些实现中，使用 async 和 await 异步完成会带来惊人的好处。这确实是界面试图允许的。

在其他情况下，也许很少见，只需要一个简单的同步方法就可以了。所以让我们假设实现如下所示：

public class SimplyAwesome : IAmAwesome {
    public async Task MakeAwesomeAsync() {
        // Some really awesome stuff here...
    }
}

这可行，但编译器发出警告：

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

编译器实际上是在建议这个解决方案：

public class SimplyAwesome : IAmAwesome {
    public async Task MakeAwesomeAsync() {
        await Task.Run(() => {
            // Some really awesome stuff here, but on a BACKGROUND THREAD! WOW!
        });
    }
}

我的问题是 - 当我选择忽略此编译器警告时应该确定什么？在某些情况下，工作是如此简单，以至于为它生成一个线程无疑会适得其反。

Answer 1

正如其他人已经指出的那样，您有 3 种不同的选择，所以这是一个见仁见智的问题：

1. 保持async，忽略警告
2. 有同步/async重载
3. 删除 async 并返回已完成的任务。

我建议返回 already completed task:

public class SimplyAwesome : IAmAwesome 
{
    public Task MakeAwesomeAsync() 
    {
        // run synchronously
        return TaskExtensions.CompletedTask;
    }
}

有几个原因：

• 由于编译器添加了 try-catch 块，创建一个方法 async 在创建状态机和禁用某些优化（如内联）方面有轻微开销。
• 您需要处理警告，并且任何其他查看此代码的团队成员都想知道await 在哪里。
• 在标记完全同步的方法async 时有些不一致。这就像在你的代码中添加while(false){}，它的作用是一样的，但它并没有传达方法的含义。

Servy 指出，返回一个任务会改变异常处理的语义。虽然这是真的，但我认为这不是问题。

首先，大部分async代码调用一个方法，并在同一个地方（即await MakeAwesomeAsync()）等待返回的任务，这意味着无论该方法是不是async，都会在同一个地方抛出异常与否。

其次，即使是 .Net 框架的任务返回方法也会同步抛出异常。以Task.Delay 哪个throws an exception directly without storing it in the returned task 为例，所以不需要await 任务引发异常：

try
{
    Task.Delay(-2);
}
catch (Exception e)
{
    Console.WriteLine(e);
}

由于 .Net 开发人员需要在 .Net 中同步遇到异常时除外，因此他们也应该从您的代码中除外。

Answer 2

什么时候我选择忽略这个编译器警告？ 在某些情况下，工作是如此简单，以至于为其生成一个线程 不可否认会适得其反。

编译器没有说“在这个方法中使用Task.Run”。它只是告诉你你为他准备了一个async 方法，在你的方法声明中添加了async 修饰符，但你实际上并没有等待任何东西。

您可以采取三种方法：

A.您可以忽略编译器警告，一切仍将执行。请注意，状态机生成会有一点开销，但您的方法调用将同步执行。如果操作很耗时并且可能导致方法执行进行阻塞调用，这可能会使使用该方法的用户感到困惑。

B.将“Awesome”的生成分为同步接口和异步接口：

public interface MakeAwesomeAsync
{
    Task MakeAwesomeAsync();
}

public interface MakeAwesome
{
    void MakeAwesome();
}

C.如果该操作不太耗时，您可以使用Task.FromResult 将其简单地包装在Task 中。在选择这个之前，我肯定会测量运行 CPU 绑定操作需要多长时间。

Answer 3

如果您确实想同步执行工作，您知道您的async 方法将始终同步运行，这在这种情况下是可取的，那么请务必忽略警告。如果您理解警告告诉您的内容并认为它所描述的操作是正确的，那么这不是问题。毕竟这是警告而不是错误是有原因的。

当然，另一种选择是不使用async 方法，而是简单地使用Task.FromResult 来返回一个已经完成的任务。它会改变错误处理语义（除非您还捕获所有异常并将它们包装到您返回的任务中）所以至少要注意这一点。如果您确实希望通过生成的 Task 传播异常，则可能值得离开方法 async 并仅取消警告。