CA1831: Uygun olduğunda dize için Aralık tabanlı dizin oluşturucular yerine AsSpan kullanın

  • Makale
Özellik Değer
Kural Kimliği CA1831
Başlık Uygun olduğunda dize için Aralık tabanlı dizin oluşturucular yerine AsSpan kullanın
Kategori Performans
Hataya neden olan veya bozulmayan düzeltme Hataya neden olmayan
.NET 8'de varsayılan olarak etkin Uyarı olarak

Neden

Bir dizede aralık dizin oluşturucu kullanılır ve değer örtük olarak öğesine ReadOnlySpan<char>atanır.

Kural açıklaması

Bu kural, bir dizede aralık dizin oluşturucu kullandığınızda ve bunu bir span türüne atadığınızda tetiklenir. üzerindeki Span<T> aralık dizin oluşturucu kopyalanamayan Slice bir işlemdir, ancak bir dizedeki aralık dizin oluşturucu için yöntemi Substring yerine Slicekullanılır. Bu, dizenin istenen bölümünün bir kopyasını oluşturur. Bu kopya genellikle örtük olarak veya ReadOnlyMemory<T> değeri olarak kullanıldığında gereksizdirReadOnlySpan<T>. Bir kopya amaçlanmamışsa, gereksiz kopyayı önlemek için yöntemini kullanın AsSpan . Kopya amaçlanıyorsa, önce yerel bir değişkene atayın veya açık bir atama ekleyin. Çözümleyici yalnızca aralık dizin oluşturucu işleminin sonucu üzerinde örtük bir atama kullanıldığında bildirir.

Algı -lar

Örtük dönüştürme:

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

Algılanmaz

Açık dönüştürme:

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

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için, gereksiz veri kopyaları oluşturmamak için dizedeki tabanlı dizin oluşturucu yerine RangekullanınAsSpan.

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];
    ...
}

Bahşiş

Visual Studio'da bu kural için bir kod düzeltmesi kullanılabilir. Bunu kullanmak için imleci ihlalin üzerine getirin ve Ctrl+ tuşuna (nokta) basın. Sunulan seçenekler listesinden bir dizede Aralık tabanlı dizin oluşturucu yerine AsSpan Kullan'ı seçin.

Code fix for CA1831 - Use AsSpan instead of Range-based indexers when appropriate

Bu uyarıyı önlemek için açık bir atama da ekleyebilirsiniz.

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];
    ...
}

Uyarıların ne zaman bastırılması gerekiyor?

Kopya oluşturmanın amacı bu kuralın ihlalini engellemek güvenlidir.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Bu kural kategorisinin tamamını devre dışı bırakmak için, kategorinin önem derecesini noneyapılandırma dosyasında olarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Ayrıca bkz.