利用CancellationToken实现异步任务的取消

# 1. 引言

### 1.1 什么是异步任务的取消

在现代的软件开发中，异步操作已经成为了必不可少的一部分。异步任务的好处在于可以提高程序的性能和响应能力，但是在某些情况下，我们可能需要取消正在进行的异步任务。例如，用户可能想要取消一个长时间运行的任务，或者在应用程序关闭时需要立即取消所有未完成的任务。

异步任务的取消是指提前终止正在执行的任务，释放相关资源并结束任务的执行。取消一个任务可以避免不必要的计算、网络或其他资源消耗，同时也可以提高系统的效率。

### 1.2 CancellationToken的概念和作用

CancellationToken是.NET框架中提供的一个用于取消异步任务的机制。它是一个结构体，用于传递取消请求并通知正在执行的任务取消的状态。

CancellationToken的作用可以概括为以下几点：

- 提供一种标准化的方式来请求和取消异步任务。
- 允许我们在异步任务中检测取消请求，并根据需要执行相应的操作。
- 提供了一种机制来传递取消请求给异步任务。

在接下来的章节中，我们将深入探讨CancellationToken的基本用法以及在实际开发中如何使用它来取消异步任务。

# 2. CancellationToken的基本用法

CancellationToken是用于取消异步任务的重要工具，它允许我们在任务进行中主动通知任务应该被取消，从而提供了一种优雅地中止任务的机制。在这一章节中，我们将介绍CancellationToken的基本用法，包括创建和传递CancellationToken、使用CancellationToken取消任务以及检测任务是否被取消。

#### 2.1 CancellationToken的创建和传递

要使用CancellationToken，首先我们需要创建一个CancellationTokenSource对象，它包含了一个用于取消任务的CancellationToken。下面是创建CancellationTokenSource的示例代码：

CancellationTokenSource cts = new CancellationTokenSource();

我们可以将这个CancellationTokneSource对象传递给需要进行取消操作的任务或方法中，以便在需要取消任务时进行通知。下面是一个简单的示例，演示了如何将CancellationToken传递给一个异步任务：

// 创建CancellationTokenSource
CancellationTokenSource cts = new CancellationTokenSource();

// 启动异步任务，并传递CancellationToken
Task task = Task.Run(() => {
    // 异步任务的逻辑代码
}, cts.Token);

在上面的示例中，我们将创建的CancellationTokenSource对象的Token属性传递给了Task.Run方法，这样异步任务在运行过程中就可以检测到取消请求。

#### 2.2 使用CancellationToken取消任务

一旦任务被传递了CancellationToken，我们就可以在任务中的适当位置检测CancellationToken的IsCancellationRequested属性，以确定是否请求取消任务。当我们确定需要取消任务时，可以调用CancellationToken的Cancel方法来触发任务的取消。下面是一个示例，展示了如何取消一个异步任务：

// 创建CancellationTokenSource
CancellationTokenSource cts = new CancellationTokenSource();

// 启动异步任务，并传递CancellationToken
Task task = Task.Run(() => {
    while (!cts.Token.IsCancellationRequested) {
        // 异步任务的逻辑代码
    }
}, cts.Token);

// 等待一段时间后取消任务
Thread.Sleep(1000);
cts.Cancel();

在上面的示例中，我们创建了一个无限循环的异步任务，只要CancellationToken的IsCancellationRequested属性为false，任务就会继续执行。在主线程等待一段时间后，我们调用了CancellationTokenSource的Cancel方法，从而触发了任务的取消。

#### 2.3 如何检测任务是否被取消

除了手动调用CancellationToken的IsCancellationRequested属性来检测任务是否被取消外，我们还可以在任务中使用CancellationToken提供的注册回调函数的机制来进行检测。下面是一个示例，展示了如何在任务取消时执行相应的回调函数：

// 创建CancellationTokenSource
CancellationTokenSource cts = new CancellationTokenSource();

// 启动异步任务，并传递CancellationToken
Task task = Task.Run(() => {
    // 在任务取消时执行回调函数
    cts.Token.Register(() => {
        Console.WriteLine("Task is cancelled");
    });

    while (!cts.Token.IsCancellationRequested) {
        // 异步任务的逻辑代码
    }
}, cts.Token);

// 等待一段时间后取消任务
Thread.Sleep(1000);
cts.Cancel();

在上面的示例中，我们使用CancellationToken的Register方法来注册一个回调函数，在任务被取消时执行。在任务中，我们在取消被请求时检测是否取消，并执行相应的回调函数。

这样，我们就介绍了CancellationToken的基本用法，包括创建和传递CancellationToken、使用CancellationToken取消任务以及检测任务是否被取消。在下一章节中，我们将深入实践异步任务的取消操作。

# 3. 异步任务的取消实践

在实际开发中，取消异步任务是一项非常重要的功能。本章将介绍如何使用CancellationToken来取消异步任务，以及一些常见的取消实践。

#### 3.1 Task和Task\<T\>的取消操作

在使用Task类和Task\<T\>类创建异步任务时，我们可以通过传递CancellationToken来实现任务的取消操作。下面是一个简单的示例：

import asyncio

async def my_task(token):
    while not token.is_canceled:  # 检测任务是否被取消
        await asyncio.sleep(1)
        print("Task is running...")

async def cancel_task():
    # 创建Cancellation Token
    token = asyncio.CancellationToken()
    # 创建任务并传递Cancellation Token
    task = asyncio.create_task(my_task(token))
    await asyncio.sleep(5)
    # 取消任务
    token.cancel()

asyncio.run(cancel_task())

上面的示例中，我们创建了一个异步任务`my_task`，该任务会每秒钟打印一次"Task is running..."。在`cancel_task`函数中，我们创建了一个Cancella