等待超时的任务

时间:2016-02-26 07:26:53

标签: c# .net async-await task

我正在尝试编写一个帮助方法,它允许我传递任意任务和超时。如果任务在超时之前完成,则调用成功委托,否则调用错误委托。该方法如下所示:

    public static async Task AwaitWithTimeout(Task task, int timeout, Action success, Action error)
    {
        if (await Task.WhenAny(task, Task.Delay(timeout)) == task)
        {
            if (success != null)
            {
                success();
            }
        }
        else
        {
            if (error != null)
            {
                error();
            }
        }
    }

现在这个似乎大部分时间都在工作,但我也想写一些测试来确保。令我意外的是,这个测试失败了,并调用错误委托而不是成功:

        var taskToAwait = Task.Delay(1);
        var successCalled = false;

        await TaskHelper.AwaitWithTimeout(taskToAwait, 10, () => successCalled = true, null);

        Assert.IsTrue(successCalled);

然而,这个测试是绿色的:

        var taskToAwait = Task.Run(async () =>
        {
            await Task.Delay(1);
        });

        var successCalled = false;

        await TaskHelper.AwaitWithTimeout(taskToAwait, 10, () => successCalled = true, null);

        Assert.IsTrue(successCalled);

如何将两项测试都设为绿色?我对Task.WhenAny的使用是否不正确?

1 个答案:

答案 0 :(得分:11)

计时器不准确。默认情况下,它们的准确度约为15毫秒。低于此值的任何内容都将在15毫秒间隔内触发。 Refer related answer.

假设您有1ms计时器和10ms计时器;两者大致相等,因此你得到的结果不一致。

您在Task.Run中包含并声称正在运作的代码只是巧合。当我多次尝试时,结果不一致。由于提到的原因,它有时会失败。

您最好不要增加超时或只是传入已完成的任务。

例如,以下测试应始终如一地通过。请记住,您的测试应该是一致的而不是脆弱的。

[Test]
public async Task AwaitWithTimeout_Calls_SuccessDelegate_On_Success()
{
    var taskToAwait = Task.FromResult(0);

    var successCalled = false;

    await TaskHelper.AwaitWithTimeout(taskToAwait, 10, () => successCalled = true, ()=>{ });

    Assert.IsTrue(successCalled);
}

对于永无止境的任务,请使用TaskCompletionSource并且不要设置其结果。

[Test]
public async Task AwaitWithTimeout_Calls_ErrorDelegate_On_NeverEndingTask()
{
    var taskToAwait = new TaskCompletionSource<object>().Task;

    var errorCalled = false;

    await TaskHelper.AwaitWithTimeout(taskToAwait, 10, () => { }, ()=> errorCalled = true);

    Assert.IsTrue(errorCalled);
}

另外,我建议您避免使用null。您只需将空委托作为参数传递即可。然后,您不希望在代码库中分散空检查。

我将助手方法编写为:

public static async Task AwaitWithTimeout(this Task task, int timeout, Action success, Action error)
{
    if (await Task.WhenAny(task, Task.Delay(timeout)) == task)
    {
        success();
    }
    else
    {
        error();
    }
}

注意上述方法是一种扩展方法;所以你可以用任务实例调用它。

await taskToAwait.AwaitWithTimeout(10, () => { }, ()=> errorCalled = true);//No nulls, just empty delegate