CA2249：請考慮使用 String.Contains 而非 String.IndexOf

發行項
11/12/2024

屬性	值
規則識別碼	CA2249
職稱	請考慮使用 String.Contains 而非 String.IndexOf
類別	使用方式
修正程式是中斷或非中斷	不中斷
預設在 .NET 9 中啟用	建議

原因

此規則會找出用來檢查子字串是否存在的呼叫 IndexOf ，並建議改 Contains 用來改善可讀性。

檔案描述

當用來檢查結果是否等於-1或大於或等於 0時IndexOf，可以安全地取代 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

如需詳細資訊，請參閱如何隱藏程式代碼分析警告。

另請參閱

使用規則

共用方式為