如何在C#中使用 CancellationToken 处理异步任务

为了在C#中使用CancellationToken处理异步任务，我们需要先了解CancellationToken的概念。CancellationToken是一个结构体，代表了一个取消请求，可以在异步任务运行期间使用它来取消任务。

下面是使用CancellationToken取消异步任务的完整攻略：

1. 创建CancellationToken实例

在开始任务之前，我们需要创建一个CancellationToken实例，作为异步方法的参数。这个实例可以被用来取消异步任务。代码如下：

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

在这里，我们使用CancellationTokenSource 类来创建CancellationToken实例和 token 变量。

2. 在异步任务中处理token.Cancel()

异步任务应该能够在特定情况下进行取消。为此，我们需要使用 CancellationToken 参数。对于异步方法，我们应该定期检查 CancellationToken 是否已被取消，并根据需要执行取消操作。在异步任务中，可以使用token.IsCancellationRequested检查方法是否被取消，如果已被取消，可以抛出OperationCanceledException 来停止异步任务。此外，应该在异步任务中调用在 step 1 中创建的CancellationTokenSource实例的Cancel方法，以通知异步任务已被取消。代码如下：

async Task MyAsyncMethod(CancellationToken token)
{
    while (!token.IsCancellationRequested) 
    {
        //执行异步任务，并检查Cancellation Token
        //如果在异步任务中token被标记为取消，则抛出OperationCancelledException
        //和停止任务
        if(shouldCancel)
        {
            token.ThrowIfCancellationRequested();
        }
    }
}

3. 在调用异步任务时传递token参数

在调用异步任务时，我们需要将在第一步中创建的CancellationToken实例作为参数传递给异步方法。这可以确保异步方法在异步任务运行期间可以使用CancellationToken。

await MyAsyncMethod(token);

下面是两个示例来帮助您更好地理解如何在C#中使用CancellationToken处理异步任务：

示例1：使用CancellationToken取消一个Web请求

Web请求是异步执行的任务，我们可以使用CancellationToken来取消它。

async Task<string> GetWebData(CancellationToken token)
{
    using (HttpClient client = new HttpClient())
    {
        HttpResponseMessage response = await client.GetAsync("https://www.example.com/", token);
        if (!response.IsSuccessStatusCode)
            throw new Exception("Failed to get web data.");
        string result = await response.Content.ReadAsStringAsync();
        return result;
    }
}

在这里我们使用HttpClient执行异步Web请求，使用HttpResponseMessage检查是否成功获取Web数据，使用了CancellationToken异步请求token。

示例2：使用CancellationToken模拟计算任务

假设我们需要一个长时间运行的计算任务，我们可以将任务放在异步方法中，并在异步方法的while循环中加入CancellationToken检查。

async Task<int> LongRunningTask(CancellationToken token)
{
    int result = 1;
    bool shouldCancel = false;
    while (!shouldCancel)
    {
        //执行计算任务
        result++;
        //检查Cancellation Token
        if (token.IsCancellationRequested)
        {
            shouldCancel = true;
            Console.WriteLine("Calculation cancelled by user.");
            token.ThrowIfCancellationRequested();
        }
        //将CPU Yield给其他线程
        await Task.Delay(200);
    }
    return result;
}

在这里我们使用到了CancellationToken异步请求token和Task.Delay模拟计算过程，同时在异步任务中检查token的取消状态，如果检测到被取消状态，就抛出OperationCancelledException。

到此为止，你已经了解了在C#中使用CancellationToken处理异步任务的完整攻略。