C# 方法执行超时时间封装

最新推荐文章于 2024-08-23 08:00:00 发布

原创最新推荐文章于 2024-08-23 08:00:00 发布 · 1k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#c# #开发语言

C# 专栏收录该内容

4 篇文章

订阅专栏

本文介绍了如何在C#中通过Task和CancellationToken实现方法执行的超时控制。提供了一个静态泛型方法示例，该方法接收一个委托和超时时间参数，返回一个Task对象表示执行结果。当执行超过设定时间时，会抛出TimeoutException异常。在实际应用中，应确保被限制的函数是可取消的，以防止资源占用问题。

在 C# 中，我们可以使用 CancellationToken 和 Task.Delay 方法实现对方法执行时间的限制。下面给出一个基于 Task 的方法执行超时时间的示例：

public static async Task<T> RunWithTimeout<T>(Func<T> function, TimeSpan timeout)
{
    var cts = new CancellationTokenSource();
    var delayTask = Task.Delay(timeout, cts.Token);
    var functionTask = Task.Run(function, cts.Token);

    if (await Task.WhenAny(functionTask, delayTask) == functionTask)
    {
        cts.Cancel();
        return await functionTask;
    }

    throw new TimeoutException("操作超时！");
}

在上述代码中，我们定义了一个名为 RunWithTimeout 的静态泛型方法，该方法接收两个参数：一个待执行的 Func<T> 类型的委托以及一个超时时间 TimeSpan。该方法返回一个 Task<T> 对象，表示执行结果。

在方法内部，我们创建了一个 CancellationTokenSource 对象和两个 Task 对象，分别用于表示延迟任务和目标函数执行任务。然后我们使用 await Task.WhenAny(...) 异步等待这两个任务中的任意一个完成，并获取完成的任务。如果是目标函数执行任务完成，则将其结果作为方法的返回值；否则抛出超时异常。

以下是一个调用示例：

try
{
    var result = await RunWithTimeout(() =>
    {
        // TODO: 执行需要限时的操作
        return default(T);
    }, TimeSpan.FromSeconds(5));

    // TODO: 处理返回结果
}
catch (TimeoutException ex)
{
    // TODO: 处理超时异常
}

说明：

在上述代码中，我们创建了一个匿名委托作为待执行的目标函数，并将其作为参数传递给 RunWithTimeout 方法。在该委托中，我们需要实现具体待执行的操作，例如访问某个 Web API、读写文件等。如果执行时间超出指定的限制，就会抛出 TimeoutException 异常。

需要注意的事项，使用该方法进行限时操作时，应该尽量保证被限制的函数或操作是可取消的，以便在触发超时时及时中止它们的执行。否则可能会出现无法停止的死循环、线程锁死等问题。