深入解读CancellationToken: .NET异步操作的控制操作做法实用指南-45看点

平时做技术实践时，很多问题不是概念不会，而是细节没串起来。拿“深入解读CancellationToken: .NET异步操作的控制操作……”来说，它看着像小点，放到项目里常会牵出环境、配置、兼容性和维护成本。下面按实际采用顺序，把思路、关键写法和容易踩坑的地方讲清楚，便于大家直接对照操作。

深入解读CancellationToken：.NET异步操作的精准控制

落到代码里，在.NET异步编程里，有效地控制异步操作的执行过程至关重要。CancellationToken提供了一种优雅的方式来取消或停止正在进行的异步操作，确保资源的合理借助，提高应用程序的稳定性和响应性，尤其适用来处理长时间运行的异步任务。

一、技术背景

落到代码里，在异步编程模型里，一旦启动一个异步任务，如网络请求、文件读取或复杂计算，有时需在任务完成前将其终止。比如，用户在下载大文件时改变主意取消下载，或者一个Web请求等待异步任务响应超时，需终止任务以释放资源。传统方式实现异步操作的取消较为复杂，而CancellationToken为开发人员提供了一种标准、简洁的机制，使得异步操作的取消变得更加容易和安全。

二、核心原理

CancellationToken本质上是一个轻量级对象，用来向一个或多个异步操作发出取消信号。它借助一个布尔属性IsCancellationRequested来表示是否已请求取消。当IsCancellationRequested为true时，异步操作应尽快停止执行。

CancellationToken通常与CancellationTokenSource配合采用。CancellationTokenSource负责新建和管理CancellationToken实例。它提供了一个Cancel方法，调用该方法会将关联的CancellationToken的IsCancellationRequested属性设置为true，从而通知所有该令牌的异步操作进行取消。

三、底层实现剖析

从底层实现看，CancellationToken内部采用一个int类型的字段来存储取消状态。当CancellationTokenSource的Cancel方法被调用时，会借助线程安全的方式修改这个字段的值，进而影响IsCancellationRequested属性的得到值。

落到代码里，在异步操作里，开发人员需定期检查CancellationToken的状态。许多.NET框架中的异步方法已经兼容传入CancellationToken参数，这些方法内部会在适当的时机检查令牌状态。比如，Task.Delay方法的重载版本允许传入CancellationToken，在延迟过程中，如果令牌被取消，Task.Delay会提前结束延迟同时抛出OperationCanceledException。

以下是CancellationTokenSource部分核心源码简化示意：

public class CancellationTokenSource : CancellationTokenRegistration, IDisposable
{
    private int _m_state;
    public void Cancel()
    {
        // 通过Interlocked操作确保线程安全地修改取消状态
        Interlocked.Exchange(ref _m_state, 1); 
    }
}

四、示例代码

（一）基础用法

功能说明：演示如何采用CancellationToken取消一个轻松的异步延迟任务。

using System;
using System.Threading;
using System.Threading.Tasks;
class Program
{
    static async Task Main()
    {
        var cancellationTokenSource = new CancellationTokenSource();
        CancellationToken cancellationToken = cancellationTokenSource.Token;
        Task delayTask = Task.Delay(TimeSpan.FromSeconds(5), cancellationToken);
        // 模拟其他工作
        await Task.Delay(TimeSpan.FromSeconds(2)); 
        // 取消任务
        cancellationTokenSource.Cancel();
        try
        {
            await delayTask;
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("任务已取消");
        }
    }
}

关键注释：新建CancellationTokenSource和对应的CancellationToken。启动一个延迟5秒的任务，同时在2秒后取消任务。借助try - catch块捕获OperationCanceledException以处理任务取消的情况。
运行结果：输出“任务已取消”。

（二）进阶场景

功能说明：在一个模拟的长时间运行的计算任务中采用CancellationToken进行取消控制。

using System;
using System.Threading;
using System.Threading.Tasks;
class Program
{
    static async Task LongRunningCalculationAsync(CancellationToken cancellationToken)
    {
        for (int i = 0; i < 1000000; i++)
        {
            if (cancellationToken.IsCancellationRequested)
            {
                Console.WriteLine("计算任务已取消");
                return;
            }
            // 模拟计算
            await Task.Delay(1); 
        }
        Console.WriteLine("计算任务完成");
    }
    static async Task Main()
    {
        var cancellationTokenSource = new CancellationTokenSource();
        CancellationToken cancellationToken = cancellationTokenSource.Token;
        Task calculationTask = LongRunningCalculationAsync(cancellationToken);
        // 模拟其他工作
        await Task.Delay(TimeSpan.FromSeconds(2)); 
        // 取消任务
        cancellationTokenSource.Cancel();
        try
        {
            await calculationTask;
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("任务已取消，异常捕获");
        }
    }
}

关键注释：LongRunningCalculationAsync方法模拟长时间运行的计算任务，借助循环和await Task.Delay(1)模拟实际计算工作，同时在每次循环中检查CancellationToken状态。在Main方法中启动计算任务，2秒后取消任务，并捕获异常。
运行结果：输出“计算任务已取消”和“任务已取消，异常捕获”。

（三）避坑案例

常用错误：在异步操作中未正确检查CancellationToken状态。

using System;
using System.Threading;
using System.Threading.Tasks;
class Program
{
    static async Task IncorrectCalculationAsync(CancellationToken cancellationToken)
    {
        // 错误：未检查CancellationToken状态
        for (int i = 0; i < 1000000; i++)
        {
            await Task.Delay(1); 
        }
        Console.WriteLine("计算任务完成");
    }
    static async Task Main()
    {
        var cancellationTokenSource = new CancellationTokenSource();
        CancellationToken cancellationToken = cancellationTokenSource.Token;
        Task calculationTask = IncorrectCalculationAsync(cancellationToken);
        // 模拟其他工作
        await Task.Delay(TimeSpan.FromSeconds(2)); 
        // 取消任务
        cancellationTokenSource.Cancel();
        try
        {
            await calculationTask;
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("任务已取消，异常捕获");
        }
    }
}

错误说明：IncorrectCalculationAsync方法在循环中没有检查CancellationToken状态，即使调用了Cancel方法，任务也不会响应取消请求，会继续执行直到完成。
修复方案：在循环中添加对CancellationToken状态的检查。

using System;
using System.Threading;
using System.Threading.Tasks;
class Program
{
    static async Task CorrectCalculationAsync(CancellationToken cancellationToken)
    {
        for (int i = 0; i < 1000000; i++)
        {
            if (cancellationToken.IsCancellationRequested)
            {
                Console.WriteLine("计算任务已取消");
                return;
            }
            await Task.Delay(1); 
        }
        Console.WriteLine("计算任务完成");
    }
    static async Task Main()
    {
        var cancellationTokenSource = new CancellationTokenSource();
        CancellationToken cancellationToken = cancellationTokenSource.Token;
        Task calculationTask = CorrectCalculationAsync(cancellationToken);
        // 模拟其他工作
        await Task.Delay(TimeSpan.FromSeconds(2)); 
        // 取消任务
        cancellationTokenSource.Cancel();
        try
        {
            await calculationTask;
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("任务已取消，异常捕获");
        }
    }
}

运行结果：输出“计算任务已取消”和“任务已取消，异常捕获”。

五、性能对比/实践建议

性能对比：采用CancellationToken带来的性能开销极小，因为它主要依赖轻松的布尔值检查和线程安全的状态修改操作。相较于不采用CancellationToken而让任务无限制运行直至完成，适时取消任务能够显著节省资源，提高系统的整体性能和响应速度。
实践建议：
- 实际处理时，在编写长时间运行的异步任务时，始终考虑接受CancellationToken参数，以便调用者能够在需时取消任务。
- 定期在异步任务的关键节点检查CancellationToken状态，确保任务能及时响应取消请求。但检查频率不宜过高，以免影响性能。
- 注意处理OperationCanceledException，确保在任务取消时资源得到正确清理，如关闭文件句柄、释放网络连接等。

六、常用问题解答

（一）一个CancellationToken能否用来多个异步任务？

能够，一个CancellationToken能够传递给多个异步任务，当调用CancellationTokenSource的Cancel方法时，所有该CancellationToken的异步任务都会收到取消信号。

（二）CancellationToken如何与async/await配合采用？

在async方法中，将CancellationToken作为参数传递，同时在方法内部适当位置检查IsCancellationRequested属性。当采用await等待异步操作时，如果操作兼容CancellationToken，可将令牌传递进去，这样在令牌取消时，异步操作会提前结束并抛出OperationCanceledException。

CancellationToken为.NET异步编程中的任务取消提供了一种简洁且高效的机制。在真实项目中，合理运用CancellationToken能够有效提升应用程序的稳定性和响应性，避免资源浪费。随着.NET平台的发展，预计CancellationToken相关的功能和采用场景将进一步优化和拓展。

到此这篇关于深入解读CancellationToken .NET异步操作的精准控制的文章就介绍到这了,更多相关.net cancellationtoken异步内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多兼容脚本之家！

您可能感兴趣的文章:

.NET Core采用 CancellationToken 取消API请求的操作方法
.NET Core 中实现异步编程并提升性能的操作方法

深入解读CancellationToken: .NET异步操作的控制操作做法实用指南

目录