如何带参数取消Task？需为无限循环异步操作指定取消原因

我明白你的痛点——原生的CancellationTokenSource.Cancel()确实只能触发OperationCanceledException，没法直接带上取消原因，这对于需要根据不同取消场景做差异化处理的业务逻辑来说确实不方便。下面给你几个实用的解决方案：

方案1：封装带取消原因的CancellationTokenSource #

最直接的方式是扩展原生的CancellationTokenSource，给它增加一个存储取消原因的属性，新增带原因的Cancel方法：

public class CancellationTokenSourceWithReason : CancellationTokenSource
{
    // 用volatile保证线程安全的原因读取
    private volatile string _cancelReason;
    public string CancelReason => _cancelReason;

    public void Cancel(string reason)
    {
        _cancelReason = reason;
        // 调用原生取消逻辑
        base.Cancel();
    }

    public async Task CancelAsync(string reason)
    {
        _cancelReason = reason;
        await base.CancelAsync();
    }
}

在业务代码中这样使用：

// 替换原有CancellationTokenSource实例
private readonly CancellationTokenSourceWithReason _cts = new CancellationTokenSourceWithReason();

private async void ProcessAsync()
{
    while (true)
    {
        try
        {
            var result = await Task.Run(async () =>
            {
                // 务必给每个可取消的异步方法传入令牌
                await Task.Delay(10000, _cts.Token);
                await Task.Delay(10000, _cts.Token);
                return new object();
            }, _cts.Token);
        }
        catch (OperationCanceledException)
        {
            // 直接获取取消原因做差异化处理
            var reason = _cts.CancelReason;
            switch (reason)
            {
                case "用户主动终止":
                    // 处理用户主动取消的逻辑
                    break;
                case "系统资源不足":
                    // 处理资源不足导致的取消
                    break;
                default:
                    // 默认兜底处理
                    break;
            }
            // 如果需要复用令牌源，记得重置原因
            _cancelReason = null;
        }
    }
}

// 取消时调用带原因的方法
_cts.Cancel("用户主动终止");

方案2：用令牌关联取消原因（无需扩展类） #

如果你不想自定义令牌源，可以用线程安全的字典来关联CancellationToken和取消原因：

private readonly CancellationTokenSource _cts = new CancellationTokenSource();
private readonly ConcurrentDictionary<CancellationToken, string> _cancelReasonMap = new ConcurrentDictionary<CancellationToken, string>();

// 自定义带原因的取消方法
public void CancelWithReason(string reason)
{
    _cancelReasonMap.TryAdd(_cts.Token, reason);
    _cts.Cancel();
}

private async void ProcessAsync()
{
    while (true)
    {
        try
        {
            var result = await Task.Run(async () =>
            {
                await Task.Delay(10000, _cts.Token);
                await Task.Delay(10000, _cts.Token);
                return new object();
            }, _cts.Token);
        }
        catch (OperationCanceledException oce)
        {
            // 从字典中取出对应原因并清理
            if (_cancelReasonMap.TryRemove(oce.CancellationToken, out var reason))
            {
                Console.WriteLine($"操作因「{reason}」被取消");
                // 在这里添加对应业务处理逻辑
            }
        }
    }
}

关键注意事项 #

• 确保所有异步操作都传入CancellationToken：比如你的Task.Delay必须带令牌参数，否则即使调用了Cancel，任务也会继续执行到结束，无法及时响应取消。
• 线程安全处理：多线程调用取消方法时，要保证原因的读写是线程安全的，方案1用volatile、方案2用ConcurrentDictionary都是可靠的实现。
• 令牌源复用：如果需要重复使用CancellationTokenSource，记得处理完取消后重置原因或清理字典，避免原因串用。

内容的提问来源于stack exchange，提问作者miechooy