c# - 契约(Contract)异步和同步代码

Question

有很多问题询问是否混合异步和同步代码。

大多数答案都说为异步方法公开同步包装器和为同步方法公开异步包装器是个坏主意。

但是，没有一个答案解决您必须混合使用异步和同步代码的特定场景，以及如何避免由此产生的常见陷阱。

请看下面的例子:

class Program
{
    static void Main(string[] args)
    {
        IContract signatory = new SyncSignatory();
        signatory.FullfillContractAsync().Wait();
        signatory = new AsyncSignatory();
        signatory.FullfillContractAsync().Wait();
    }
}

---

using System.Threading.Tasks;

interface IContract
{
    Task FullfillContractAsync();
}

---

using System.Threading.Tasks;

class AsyncSignatory : IContract
{
    public async Task FullfillContractAsync()
    {
        await Task.Delay(5000);
    }
}

---

using System.Threading;
using System.Threading.Tasks;

class SyncSignatory : IContract
{
    public Task FullfillContractAsync()
    {
        Thread.Sleep(5000);
        return Task.FromResult<object>(null);
    }
}

或者:

using System.Threading;
using System.Threading.Tasks;

class SyncSignatory : IContract
{
    public Task FullfillContractAsync()
    {
        return Task.Run(() => Thread.Sleep(5000));
    }
}

在此示例中，SyncSignatory 和 AsyncSignatory 代表两个可互换的类，因为它们执行相似的功能，但是它们以不同的方式执行这些功能 - 同步和异步。

如何在避免常见陷阱的情况下混合使用契约(Contract)同步和异步代码？

如果用户希望 syncSig 运行异步，但它却运行同步呢？

如果用户本来可以通过异步运行它来优化 syncSig，但由于他们认为它已经异步运行而不再这样做，那该怎么办？

Answer 1

Is this the proper way to mix async and sync?

大部分是。如果您有一个通用接口(interface)，其中一些实现将能够提供同步实现，而其他实现只能提供异步实现，返回 Task<T>说得通。一个简单的return Task.FromResult可以适当。但也有异常(exception)，见下文。

How about a user that expects syncSig to run async, but instead it runs sync?

接口(interface)的某些方面无法用代码表达。

如果这是您的要求 IContract在返回 Task 之前它不会阻塞调用线程超过 X 毫秒(在这种确切的形式中不是一个合理的硬性要求，但你明白了基本的想法)，它无论如何都会阻塞线程，这是违反契约(Contract)的，用户应该将它作为一个错误报告给任何实现 syncSig 的人。

如果这是您的要求 IContract它不会抛出同步异常，使用 Task.FromException 报告任何错误或等价物，并且您的 syncSig 无论如何都会抛出同步异常，这也是违反契约(Contract)的。

除此之外，如果 syncSig 只是立即返回正确的结果，就没有理由让任何用户感到困扰。

What about a user who could have optimized syncSig by running it async, but not longer does because they assume it already runs async?

如果同步运行syncSig不会造成任何问题，那没关系，还不需要优化。

如果同步运行的 syncSig 确实导致问题，基本的调试工具应该很快就会告诉开发人员 syncSig 导致了问题并且应该进行调查。