CancellationToken 的默认参数

Question

我有一些异步代码，我想添加一个CancellationToken。但是，有许多实现不需要这样做，所以我想要一个默认参数 - 也许是CancellationToken.None。然而，

Task<x> DoStuff(...., CancellationToken ct = null)

产量

“”类型的值不能用作默认参数，因为 没有标准的类型转换 'System.Threading.CancellationToken'

和

Task<x> DoStuff(...., CancellationToken ct = CancellationToken.None)

'ct' 的默认参数值必须是编译时常量

有没有办法为CancellationToken 设置默认值？

Answer 1

事实证明，以下工作：

Task<x> DoStuff(...., CancellationToken ct = default(CancellationToken))

...或：

Task<x> DoStuff(...., CancellationToken ct = default) // C# 7.1 and later

其中according to the documentation 的解释与CancellationToken.None 相同：

您也可以使用 C# default(CancellationToken) 语句来创建 一个空的取消令牌。

Answer 2

有没有办法为 CancellationToken 设置默认值？

不幸的是，这是不可能的，因为CancellationToken.None 不是编译时间常数，这是可选参数中默认值的要求。

但是，您可以通过创建重载方法而不是尝试使用默认参数来提供相同的效果：

Task<x> DoStuff(...., CancellationToken ct)
{
    //...
}

Task<x> DoStuff(....)
{
    return DoStuff(...., CancellationToken.None);
}

Answer 3

这里有几个解决方案，按一般优点的降序排列：

1。使用default(CancellationToken) 作为默认值：

Task DoAsync(CancellationToken ct = default(CancellationToken)) { … }

从语义上讲，CancellationToken.None 将是默认值的理想候选者，但不能这样使用，因为它不是编译时常量。 default(CancellationToken) 是次优，因为它是一个编译时常量，而officially documented to be equivalent to CancellationToken.None。

2。提供不带CancellationToken 参数的方法重载：

或者，如果您更喜欢方法重载而不是可选参数（请参阅有关该主题的 this 和 this 问题）：

Task DoAsync(CancellationToken ct) { … } // actual method always requires a token
Task DoAsync() => DoAsync(CancellationToken.None); // overload producing a default token

对于接口方法，同样可以使用扩展方法实现：

interface IFoo
{
    Task DoAsync(CancellationToken ct);
}

static class Foo
{
    public static Task DoAsync(this IFoo foo) => foo.DoAsync(CancellationToken.None);
}

这会产生更精简的接口，并使实现者无需显式编写转发方法重载。

3。使参数可以为空并使用null作为默认值：

Task DoAsync(…, CancellationToken? ct = null)
{
    … ct ?? CancellationToken.None …
}

我最不喜欢这个解决方案，因为可空类型的运行时开销很小，并且由于空合并运算符 ?? 对取消令牌的引用变得更加冗长。

Answer 4

另一种选择是使用Nullable<CancellationToken>参数，默认为null，并在方法内部处理：

Task<x> DoStuff(...., CancellationToken? ct = null) {
    var token = ct ?? CancellationToken.None;
    ...
}

Answer 5

较新版本的 C# 允许默认 (CancellationToken) 版本的简化语法。例如：

Task<x> DoStuff(...., CancellationToken ct = default)