CA1043:将整型或字符串参数用于索引器

  • 项目
属性 值
规则 ID CA1043
标题 将整型或字符串参数用于索引器
类别 设计
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 否

原因

类型包含索引器，该索引器使用的索引类型不是 System.Int32、System.Int64、System.Object 或 System.String。

默认情况下，此规则仅查看外部可见的类型，但这是可配置的。

规则说明

索引器（即索引属性）应将整数或字符串类型用于索引。 这些类型通常用于为数据结构编制索引，并可提高库的可用性。 应仅限于在设计时无法指定特定整数或字符串类型的情况下使用 Object 类型。 如果设计需要其他类型的索引，请重新考虑该类型是否表示逻辑数据存储。 如果它不表示逻辑数据存储，请使用方法。

如何解决冲突

若要解决此规则的冲突，请将索引更改为整数或字符串类型，或者使用方法代替索引器。

何时禁止显示警告

仅在仔细考虑了对非标准索引器的需求之后，才能禁止显示此规则的警告。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

示例

以下示例显示了使用 Int32 索引的索引器。

string[] Month = new string[] { "Jan", "Feb", "..." };

public string this[int index]
{
    get => Month[index];
}

Private month() As String = {"Jan", "Feb", "..."}

Default ReadOnly Property Item(index As Integer) As String
    Get
        Return month(index)
    End Get
End Property