契约异步和同步代码

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

大多数答案都表示，为异步方法公开同步包装器以及为同步方法公开异步包装器都是一个坏主意。

然而，没有一个答案解决了必须混合异步和同步代码的特定场景，以及如何避免因此而出现的常见陷阱。

请参见以下示例：

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);
    }
}

Or:

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

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

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

如何混合契约同步和异步代码，同时避免常见的陷阱场景？

如果用户希望syncSig 运行异步，但实际上却运行同步，该怎么办？

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

这是混合异步和同步的正确方法吗？

大多数情况下是的。如果您有一个通用接口，其中某些实现将能够提供同步实现，但其他实现只能提供异步实现，返回Task<T>说得通。一个简单的return Task.FromResult可以适当的。但也有例外，见下文。

如果用户希望syncSig 运行异步，但实际上却运行同步，该怎么办？

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

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

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

除此之外，如果syncSig只是立即返回正确的结果，那么没有理由打扰任何用户。

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

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

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