C#中取消令牌CancellationTokenSource详解

当前位置:

首页 > c#编程 >

C#中取消令牌CancellationTokenSource详解

king:
在C#中，`CancellationTokenSource` 类是与 `CancellationToken` 类紧密合作，用于取消长时间运行的操作的重要工具。这些类通常用于异步编程场景，特别是在需要支持取消操作的I/O密集型任务中。

### CancellationTokenSource 的基本概念

`CancellationTokenSource` 是一个可以发出取消请求的对象。当你创建一个 `CancellationTokenSource` 实例时，你可以通过调用其 `Cancel` 方法或 `CancelAfter` 方法（指定一个时间延迟后自动取消）来请求取消操作。一旦请求被发出，相关联的 `CancellationToken` 对象的 `IsCancellationRequested` 属性将被设置为 `true`，并且所有注册到该令牌的回调都将被触发。

### 使用 CancellationTokenSource

1. **创建 CancellationTokenSource**：
   首先，你需要创建一个 `CancellationTokenSource` 实例。

   ```csharp
   var cts = new CancellationTokenSource();
   ```

2. **获取 CancellationToken**：
   然后，你可以从 `CancellationTokenSource` 获取一个 `CancellationToken`。这个令牌将被传递给需要支持取消的操作。

   ```csharp
   var token = cts.Token;
   ```

3. **传递 CancellationToken**：
   将 `CancellationToken` 传递给需要支持取消的异步方法。这通常是通过方法参数来完成的。

   ```csharp
   await SomeLongRunningOperationAsync(token);
   ```

   在 `SomeLongRunningOperationAsync` 方法内部，你应该定期检查 `token.IsCancellationRequested` 属性，并在需要时提前退出操作。

4. **请求取消**：
   当需要取消操作时，调用 `CancellationTokenSource` 的 `Cancel` 方法。

cts.Cancel();

这将导致 `token.IsCancellationRequested` 变为 `true`，并且所有注册到该令牌的回调都将被触发。

5. **处理取消**：
在支持取消的操作中，你应该定期检查 `CancellationToken` 的状态，并在收到取消请求时适当地响应。这通常意味着停止当前操作并清理资源。

   public async Task SomeLongRunningOperationAsync(CancellationToken token)
   {
       while (!token.IsCancellationRequested)
       {
           // 执行一些工作...

           // 假设在某个点，我们检查是否需要取消
           await Task.Delay(1000, token); // 这里的Delay也会响应取消请求
       }

       // 清理资源...
   }

### 注册回调

`CancellationToken` 还允许你注册回调，这些回调将在取消请求被发出时执行。这可以用于执行清理操作、通知其他组件等。

token.Register(() =>
{
// 当令牌被取消时执行的代码
Console.WriteLine("Cancellation requested.");
});

### 使用 CancelAfter

`CancellationTokenSource` 还提供了一个 `CancelAfter` 方法，该方法允许你在指定的时间后自动取消操作。

cts.CancelAfter(TimeSpan.FromSeconds(5)); // 5秒后自动取消

### 总结

`CancellationTokenSource` 和 `CancellationToken` 提供了在C#中支持取消操作的强大机制。通过它们，你可以构建出更加健壮和响应式的异步应用程序，这些应用程序能够在用户或系统需要时优雅地停止长时间运行的操作。

最后，如果你对C#语言还有任何疑问或者需要进一步的帮助，请访问https://www.xin3721.com 本站原创，转载请注明出处：https://www.xin3721.com/ArticlecSharp/c49550.html

栏目列表