CA1068:CancellationToken 参数必须最后出现

  • 项目
属性 值
规则 ID CA1068
标题 CancellationToken 参数必须最后出现
类别 设计
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 作为建议

原因

此方法具有 CancellationToken 参数，该参数不是最后一个参数。

默认情况下，此规则会分析整个代码库，但这是可配置的。

规则说明

执行长时间运行操作或异步操作并可取消的方法，通常采用取消令牌参数。 每个取消令牌都有一个 CancellationTokenSource，以创建令牌并将其用于可取消的计算。 通常的做法是使用一长的方法调用链，将取消令牌从调用方传递到被调用方。 因此，参与可取消计算的大量方法最终都具有取消令牌参数。 但是，取消令牌本身通常与大多数这些方法的核心功能无关。 将此类参数作为列表中的最后一个参数是一种很好的 API 设计实践。

特殊情况

在以下特殊情况下，不会触发规则 CA1068：

  • 方法具有一个或多个可选参数（在 Visual Basic 中可选），这些参数位于非可选取消令牌参数之后。 编译器要求，在定义完所有非可选参数之后定义所有可选参数。
  • 方法具有一个或多个 ref 或 out 参数（在 Visual Basic 中为 ByRef），这些参数位于取消令牌参数之后。 通常将 ref 或 out 参数放在列表的末尾，因为它们通常指示方法的输出值。

如何解决冲突

更改方法签名，以将取消令牌参数移到列表末尾。 例如，以下两个代码片段显示了规则冲突及其解决方法：

// Violates CA1068
public void LongRunningOperation(CancellationToken token, string usefulParameter)
{
    ...
}

// Does not violate CA1068
public void LongRunningOperation(string usefulParameter, CancellationToken token)
{
    ...
}

何时禁止显示警告

如果该方法是一个外部可见的公共 API，该 API 已是已发货库的一部分，则可以安全地禁止显示此规则的警告，以避免库使用者的中断性变更。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable CA1068
// The code that's violating the rule is on this line.
#pragma warning restore CA1068

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

[*.{cs,vb}]
dotnet_diagnostic.CA1068.severity = none

有关详细信息，请参阅如何禁止显示代码分析警告。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

可以仅为此规则、为适用的所有规则或为适用的此类别（设计）中的所有规则配置这些选项。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal

排除特定符号

可以从分析中排除特定符号，如类型和方法。 例如，若要指定规则不应针对名为 MyType 的类型中的任何代码运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

选项值中允许的符号名称格式（用 | 分隔）：

  • 仅符号名称（包括具有相应名称的所有符号，不考虑包含的类型或命名空间）。
  • 完全限定的名称，使用符号的文档 ID 格式。 每个符号名称都需要带有一个符号类型前缀，例如表示方法的 M:、表示类型的 T:，以及表示命名空间的 N:。
  • .ctor 表示构造函数，.cctor 表示静态构造函数。

示例：

选项值 总结
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType 匹配名为 MyType 的所有符号。
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1|MyType2 匹配名为 MyType1 或 MyType2 的所有符号。
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType) 匹配带有指定的完全限定签名的特定方法 MyMethod。
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)|M:NS2.MyType2.MyMethod2(ParamType) 匹配带有各自的完全限定签名的特定方法 MyMethod1 和 MyMethod2。

排除特定类型及其派生类型

可以从分析中排除特定类型及其派生类型。 例如，若要指定规则不应针对名为 MyType 的类型及其派生类型中的任何代码运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

选项值中允许的符号名称格式（用 | 分隔）：

  • 仅类型名称（包括具有相应名称的所有类型，不考虑包含的类型或命名空间）。
  • 完全限定的名称，使用符号的文档 ID 格式，前缀为 T:（可选）。

示例：

选项值 总结
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType 匹配名为 MyType 的所有类型及其所有派生类型。
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2 匹配名为 MyType1 或 MyType2 的所有类型及其所有派生类型。
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType 匹配带有给定的完全限定名称的特定类型 MyType 及其所有派生类型。
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1|M:NS2.MyType2 匹配带有各自的完全限定名称的特定类型 MyType1 和 MyType2 及其所有派生类型。

另请参阅