如何为 Task 添加超时功能

前言

假设有如下代码，功能是首先从缓存获取数据，如果没有命中缓存，则直接从数据库获取：

var data = await GetFromCache();
if (data is null)
{
    data = await GetFromDB();
}

对于获取缓存数据，我们需要限制一下GetFromCache方法的执行时间，比如 3 秒，超过这个时间，可以认为拿不到缓存数据，应该直接从数据库取值。.

那么，能否在不修改GetFromCache方法的前提下，让 Task 超时时自动结束执行？

思路

虽然不能把普通Task变成一个可超时的 Task，但是我们可以定时检查任务状态。如果到达超时时间，原始 Task 仍未执行完成，则跳过该 Task，继续执行后续代码。

实现

为 Task 创建扩展方法：

public static async Task<T> Timeout<T>(this Task<T> task, int milliseconds)
{
    var now = DateTime.Now.AddMilliseconds(milliseconds);
    while (DateTime.Now < now)
    {
        if (task.IsCompleted)
        {
            return await task;
        }

        await Task.Delay(100);
    }

    return default(T);
}

使用也很简单：

var data = await GetFromCache().Timeout(1000);

if (data is null)
{
    data = await GetFromDB();
}

需要注意的是，我们仅仅是不再 await 原始 Task 执行完成，并不代表真正地终止了它的运行，原始 Task 还是会继续执行，只是我们不再关心它的返回结果而已。

结论

今天，我们通过实现 Timeout 扩展方法，为异步任务添加了超时功能。