C# CancellationToken与异步流（IAsyncEnumerable）：取消支持的新视图

# 1. C# CancellationToken与异步流的基础概念

在现代的软件开发中，异步编程已经成为一种标准实践，它使得应用程序能够更加高效地利用系统资源，同时提供更为流畅的用户体验。C# 语言在异步编程方面有着丰富的支持，其中CancellationToken和异步流（IAsyncEnumerable）是两个十分重要的特性。CancellationToken用于优雅地处理异步操作中的取消请求，而异步流则提供了处理异步数据序列的能力。

在本章节中，我们将首先介绍CancellationToken与异步流的基本概念。这将为我们后续探讨这些特性的深入细节打下坚实的基础。理解它们的工作机制和应用场景，对于写出高质量的异步代码至关重要。

## 1.1 CancellationToken的作用
CancellationToken是一个标记对象，它允许用户在运行中的任务被请求取消时向任务发送信号。这个机制在处理如用户界面操作，长时间运行的计算任务，或网络请求等可能出现中断场景时尤为重要。通过它，开发者可以为取消操作提供明确的控制点，并确保相关资源得到释放，同时减少用户操作的响应时间。

## 1.2 异步流的概念
异步流是一种新的编程模式，允许开发者异步地产生一系列值。这对于处理大规模数据集或持续生成数据的场景十分有用，如文件读写、实时数据流等。与传统的同步集合如IEnumerable相比，异步流不会一次性加载所有数据到内存中，而是按需产生数据，这大大提升了内存使用效率，尤其适合处理大数据和进行高性能计算。

理解这些基础概念之后，我们将在接下来的章节中详细探讨CancellationToken和异步流的高级用法，以及它们如何相互作用以解决复杂的编程挑战。

# 2. 深入理解CancellationToken的作用和机制

## 2.1 CancellationToken的创建和生命周期

### 2.1.1 CancellationToken的初始化

CancellationToken 是 C# 中用于表示一个用于通知操作取消的令牌。它不包含取消请求的操作，而是通过改变状态来表示取消已经被请求。创建 CancellationToken 的实例，通常不直接进行，而是通过 CancellationTokenSource 的实例来间接创建。`CancellationToken` 本身是不可变的，这意味着一旦它被创建，其状态就不会再改变。

下面的代码展示了如何创建一个 CancellationTokenSource 并从中获取 CancellationToken：

CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken token = cts.Token;

上述代码中，`CancellationTokenSource` 对象 `cts` 的 `Token` 属性提供了一个 CancellationToken 实例。这个实例代表了取消请求的机制，但是直到 `CancellationTokenSource` 被取消（调用 `Cancel` 方法）之前，它都不会表示有取消请求。

### 2.1.2 CancellationTokenSource的作用和使用

`CancellationTokenSource` 是管理和传递取消信号的主要类。当你需要在多处代码之间共享取消信号时，`CancellationTokenSource` 是必须的。

`CancellationTokenSource` 除了生成 `CancellationToken` 实例外，还可以用于执行以下操作：

- 使用 `Cancel` 方法请求取消。这会将内部状态改变为取消已请求。
- 使用 `CancelAfter` 方法来设置一个延迟，超过该时间后自动请求取消。
- 通过 `Dispose` 方法来清理资源和防止更多的取消操作。

下面的代码展示了如何使用 `CancellationTokenSource`：

using System;
using System.Threading;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        CancellationTokenSource cts = new CancellationTokenSource();
        CancellationToken token = cts.Token;
        // 注册一个取消后执行的操作
        token.Register(() => Console.WriteLine("Operation was cancelled."));

        try
        {
            // 这里是需要异步执行并可能取消的任务
            await Task.Delay(1000, token);
            Console.WriteLine("Task completed without cancellation.");
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("Task was cancelled.");
        }

        // 在程序结束之前取消操作
        cts.Cancel();
        // Disposing a CancellationTokenSource is good practice, even if you no longer need to cancel any tasks.
        cts.Dispose();
    }
}

在此代码中，我们创建了一个 `CancellationTokenSource` 对象，并注册了一个委托，在取消请求发生时执行。在 `Main` 方法中，我们执行了一个异步延迟操作，这个操作使用了我们刚刚创建的 `CancellationToken`。如果取消请求发生，将捕获到 `OperationCanceledException` 异常。

## 2.2 CancellationToken的信号和状态管理

### 2.2.1 CancellationToken的IsCancellationRequested属性

`CancellationToken` 的一个关键状态属性是 `IsCancellationRequested`。它是一个只读属性，用于检查是否已经发出了取消请求。

CancellationToken token = new CancellationTokenSource().Token;
bool cancelled = token.IsCancellationRequested; // 初始时返回 false

在上述代码中，`IsCancellationRequested` 在没有发送取消请求时返回 `false`。一旦取消请求被发起（无论是通过 `CancellationTokenSource.Cancel` 方法或是 `CancelAfter` 方法），此属性将返回 `true`。

### 2.2.2 CancellationToken的Cancel和Token.Register方法

`CancellationToken` 提供的 `Cancel` 方法和 `Register` 方法是控制取消流程的核心部分。`Cancel` 方法将状态设置为取消已请求，并且如果有一个或多个回调注册到该令牌上，那么这些回调将被调用。`Register` 方法用于注册一个回调委托，以便在取消发生时执行。

下面的代码展示了如何使用 `Cancel` 和 `Register` 方法：

CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken token = cts.Token;

// 注册一个取消时的回调
Action callback = () => Console.WriteLine("The operation was cancelled.");
token.Register(callback);

// 模拟一些长时间运行的操作
Task.Run(() =>
{
    // 检查取消请求
    while (!token.IsCancellationRequested)
    {
        // 模拟工作负载
    }

    // 取消发生后执行的操作
    token.ThrowIfCancellationRequested();
}, token);

// 取消操作
cts.Cancel();

// 程序将在这里结束，因为取消后 Token.Register 的回调将被执行

在这里，我们创建了一个长时间运行的任务，并在其中检查 `IsCancellationRequested`。如果检测到取消请求，我们通过调用 `ThrowIfCancellationRequested` 方法抛出一个异常来表示取消。在 `Main` 方法中，我们调用 `Cancel` 来触发取消流程，这将执行我们注册的 `Register` 委托。

## 2.3 CancellationToken在异步操作中的应用

### 2.3.1 与Task结合使用

`CancellationToken` 可以与 `Task` 类结合使用，以便在任务执行期间提供取消点。这通常通过 `CancellationToken` 的构造函数、方法参数或 `CancellationTokenSource.Cancel` 方法来实现。

下面是一个例子，演示了如何使用 `CancellationToken` 来取消一个异步 `Task`：

CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken token = cts.Token;

Task task = Task.Run(() =>
{
    while (!token.IsCancellationRequested)
    {
        // 模拟工作负载
    }
}, token);

// 模拟用户发起取消请求
// ...
cts.Cancel();

在这个例子中，我们创建了一个 `CancellationTokenSource` 并从中获取了 `CancellationToken`。然后，我们将这个令牌传递给 `Task.Run` 方法，这样就可以在任务执行期间检查是否有取消请求。

### 2.3.2 与异步方法（async/await）的协同工作

异步方法与 `CancellationToken` 的配合使用是异步编程中的常见模式。通过 `async` 和 `await` 关键字编写的异步方法能够轻易地集成取消逻辑，以便在不希望继续等待操作完成时中断它们。

下面的代码展示了如何在 `async` 方法中使用 `CancellationToken`：

async Task ExampleAsyncMethod(CancellationToken token)
{
    while (!token.IsCancellationRequested)
    {
        // 执行一些操作...

        // 等待一段时间
        await Task.Delay(1000, token).ConfigureAwait(false);
    }
}

// 使用 CancellationTokenSource 创建一个令牌
CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken token = cts.Token;

// 运行一个异步方法并传递取消令牌
await ExampleAsyncMethod(token);

// 取消操作
cts.Cancel();

在此代码中，`ExampleAsyncMethod` 是一个异步方法，它接受一个 `CancellationToken` 参数。在异步等待 `Task.Delay` 时，我们传递了这个取消令牌。这允许在等待过程中响应取消请求。如果在 `Task.Delay` 中调用取消，它将立即完成，并抛出一个 `OperationCanceledException` 异常。

# 3. 掌握IAsyncEnumerable的异步流操作

## 3.1 IAsyncEnumerable接口的核心概念

### 3.1.1 IAsyncEnumerable与IEnumerable的区别

在C#中，`IEnumerable<T>` 接口表示那些可枚举的集合类型，其枚举器 `IEnumerator<T>` 允许遍历集合中的元素。然而，`IEnumerable` 接口是同步的，意味着它每次只能处理一个元素，并且在处理下一个元素之前必须等待当前元素处理完成。这种方式在处理大量数据时效率低下，并且无法有效地利用现代计算机的多核处理器优势。

与 `IEnumerable` 相对的是 `IAsyncEnumerable<T>` 接口。它在.NET Core