CA2249：请考虑使用 String.Contains 而不是 String.IndexOf

项目
11/15/2023

属性	值
规则 ID	CA2249
标题	请考虑使用 String.Contains 而不是 String.IndexOf
类别	使用情况
修复是中断修复还是非中断修复	非中断
在 .NET 9 中默认启用	作为建议

原因

此规则查找对 IndexOf 的调用，其中结果用于检查是否存在 substring，并建议使用 Contains 来提高可读性。

规则说明

当使用 IndexOf 来检查结果是否等于 -1 或大于等于 0 时，可安全地将该调用替换为 Contains，而不会对性能产生影响。

根据所使用的 IndexOf 重载，建议的解决方法可能是添加 comparisonType 参数：

重载	建议的解决方法
`String.IndexOf(char)`	`String.Contains(char)`
`String.IndexOf(string)`	`String.Contains(string, StringComparison.CurrentCulture)`
`String.IndexOf(char, StringComparison.Ordinal)`	`String.Contains(char)`
`String.IndexOf(string, StringComparison.Ordinal)`	`String.Contains(string)`
`String.IndexOf(char, NON StringComparison.Ordinal)`*	`String.Contains(char, NON StringComparison.Ordinal)`*
`String.IndexOf(string, NON StringComparison.Ordinal)`*	`String.Contains(string, NON StringComparison.Ordinal)`*

* StringComparison.Ordinal 之外的任何 StringComparison 枚举值：

如何解决冲突

可以手动解决冲突，在某些情况下，也使用快速操作来修复 Visual Studio 中的代码。

示例

以下两个代码片段显示了 C# 中所有可能的规则冲突及其解决方法：

using System;

class MyClass
{
    void MyMethod()
    {
        string str = "My text";
        bool found;

        // No comparisonType in char overload, so no comparisonType added in resulting fix
        found = str.IndexOf('x') == -1;
        found = str.IndexOf('x') >= 0;

        // No comparisonType in string overload, adds StringComparison.CurrentCulture to resulting fix
        found = str.IndexOf("text") == -1;
        found = str.IndexOf("text") >= 0;

        // comparisonType equal to StringComparison.Ordinal, removes the argument
        found = str.IndexOf('x', StringComparison.Ordinal) == -1;
        found = str.IndexOf('x', StringComparison.Ordinal) >= 0;

        found = str.IndexOf("text", StringComparison.Ordinal) == -1;
        found = str.IndexOf("text", StringComparison.Ordinal) >= 0;

        // comparisonType different than StringComparison.Ordinal, preserves the argument
        found = str.IndexOf('x', StringComparison.OrdinalIgnoreCase) == -1;
        found = str.IndexOf('x', StringComparison.CurrentCulture) >= 0;

        found = str.IndexOf("text", StringComparison.InvariantCultureIgnoreCase) == -1;
        found = str.IndexOf("text", StringComparison.InvariantCulture) >= 0;

        // Suggestion message provided, but no automatic fix offered, must be fixed manually
        int index = str.IndexOf("text");
        if (index == -1)
        {
            Console.WriteLine("'text' Not found.");
        }
    }
}

using System;

class MyClass
{
    void MyMethod()
    {
        string str = "My text";
        bool found;

        // No comparisonType in char overload, so no comparisonType added in resulting fix
        found = !str.Contains('x');
        found = str.Contains('x');

        // No comparisonType in string overload, adds StringComparison.CurrentCulture to resulting fix
        found = !string.Contains("text", StringComparison.CurrentCulture);
        found = string.Contains("text", StringComparison.CurrentCulture);

        // comparisonType equal to StringComparison.Ordinal, removes the argument
        found = !string.Contains('x');
        found = string.Contains('x');

        found = !string.Contains("text");
        found = string.Contains("text");

        // comparisonType different than StringComparison.Ordinal, preserves the argument
        ;found = !string.Contains('x', StringComparison.OrdinalIgnoreCase)
        found = string.Contains('x', StringComparison.CurrentCulture);

        found = !string.Contains("text", StringComparison.InvariantCultureIgnoreCase);
        found = string.Contains("text", StringComparison.InvariantCulture);

        // This case had to be manually fixed
        if (!str.Contains("text"))
        {
            Console.WriteLine("'text' Not found.");
        }
    }
}

提示

Visual Studio 中为此规则提供了代码修补程序。若要使用它，请将光标置于冲突上，然后按“Ctrl+.”（句点）。从显示的选项列表中选择“考虑使用‘String.Contains’而不是‘String.IndexOf’”。

“CA2249 - 考虑使用‘String.Contains’而不是‘String.IndexOf’”的代码修复

何时禁止显示警告

如果无需考虑改进代码可读性，则可禁止显示此规则的冲突。

抑制警告

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

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

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

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

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

另请参阅

用法规则

通过