當適合時，請對字串使用 AsSpan，而不是使用基於 Range 的索引器。

屬性 值
規則識別碼 CA1831
職稱 在適用情況下，請對字串使用 AsSpan，而非範圍型索引子。
類別 效能
修正是造成中斷還是不中斷 不中斷
在 .NET 10 中預設啟用 作為警告
適用語言 C# 與 Visual Basic

原因

範圍索引器用於字串，且值會隱含指派給 ReadOnlySpan<char>。

規則描述

當您在字串上使用區間索引器並將其指派給 Span 類型時，就會觸發此規則。 上的 Span<T> 範圍索引器是非複製 Slice 作業，但對於字串上的範圍索引器，將會使用 方法 Substring ，而不是 Slice。 這會產生字串所要求部分的複本。 當此複本隱含使用為 ReadOnlySpan<T> 或 ReadOnlyMemory<T> 值時，通常不需要此複本。 如果複製並非預期，請使用 AsSpan 方法來避免不必要的複製。 如果需要進行複製，請先將該值指派給局部變數，或添加顯式轉型。 只有在對範圍索引器作業結果使用隱式轉換時，分析器才會報告。

偵測

隱含轉換：

ReadOnlySpan<char> slice = str[a..b];

不會偵測

明確轉換：

ReadOnlySpan<char> slice = (ReadOnlySpan<char>)str[a..b];

如何修正違規

為了解決此規則的違規問題，請使用AsSpan而不是以Range為基礎的索引器，來避免建立不必要的資料複本。

public void TestMethod(string str)
{
    // The violation occurs
    ReadOnlySpan<char> slice = str[1..3];
    ...
}

public void TestMethod(string str)
{
    // The violation fixed with AsSpan extension method
    ReadOnlySpan<char> slice = str.AsSpan()[1..3];
    ...
}

提示

在 Visual Studio 中，可以使用針對此規則的程式碼修正。 若要使用它，請將游標放在違規上，然後按 Ctrl+。（句號）。 從所呈現的選項清單中，選擇在字串上使用 AsSpan 而非字串的 Range 索引器。

CA1831 的程式代碼修正 - 適當時使用 AsSpan，而不是以範圍為基礎的索引器

您也可以新增明確的轉換，以避免出現這個警告。

public void TestMethod(string str)
{
    // The violation occurs.
    ReadOnlySpan<char> slice = str[1..3];
    ...
}

public void TestMethod(string str)
{
    // The violation avoided with explicit casting.
    ReadOnlySpan<char> slice = (ReadOnlySpan<char>)str[1..3];
    ...
}

隱藏警告的時機

如果意圖建立複本，則抑制此規則的違反是安全的。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

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

若要停用檔案、資料夾或專案的規則，請在組態檔中將其嚴重性設為 none。

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

若要停用此整個規則類別，請將組態檔中類別的嚴重性設定為 none。

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Performance.severity = none

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

另請參閱

  • Last updated on