CA1832:使用 AsSpan 或 AsMemory 而不是基于范围的索引器来获取数组

2022-02-25 23:44:19 浏览数 (1)

规则 ID

CA1832

类别

“性能”

修复是中断修复还是非中断修复

非中断

原因

对数组使用范围索引器并向 ReadOnlySpan<T> 或 ReadOnlyMemory<T> 隐式赋值。

规则说明

对数组使用范围索引器并分配给内存或范围类型:Span<T> 上的范围索引器是非复制的 Slice 操作,但对于数组上的范围索引器,将使用方法 GetSubArray 而不是 Slice,这会生成数组所请求部分的副本。 此副本在隐式用作 ReadOnlySpan<T> 或 ReadOnlyMemory<T> 值时常常是不必要的。 如果不需要副本,请使用 AsSpan 或 AsMemory 方法来避免不必要的副本。 如果需要副本,请先将其分配给本地变量,或者添加显式强制转换。 仅在对范围索引器操作的结果使用隐式强制转换时,分析器才会报告。

检测

隐式转换:

ReadOnlySpan<SomeT> slice = arr[a..b];

ReadOnlyMemory<SomeT> slice = arr[a..b];

不检测

显式转换:

ReadOnlySpan<SomeT> slice = (ReadOnlySpan<SomeT>)arr[a..b];

ReadOnlyMemory<SomeT> slice = (ReadOnlyMemory<SomeT>)arr[a..b];

如何解决冲突

若要解决此规则的冲突,请执行以下操作:使用 AsSpan 或 AsMemory 扩展方法以避免创建不必要的数据副本。

代码语言:javascript复制
class C
{
    public void TestMethod(byte[] arr)
    {
        // The violation occurs for both statements below
        ReadOnlySpan<byte> tmp1 = arr[0..2];
        ReadOnlyMemory<byte> tmp3 = arr[5..8];
        ...
    }
}
class C
{
    public void TestMethod(byte[] arr)
    {
        // The violations fixed with AsSpan or AsMemory accordingly
        ReadOnlySpan<byte> tmp1 = arr.AsSpan()[0..2];
        ReadOnlyMemory<byte> tmp3 = arr.AsMemory()[5..8];
        ...
    }
}
提示

Visual Studio 中为此规则提供了代码修复。 若要使用它,请将光标置于数组冲突上,然后按 Ctrl 。 (句点)。 从显示的选项列表中选择“在数组上使用 AsSpan 而不是基于范围的索引器”。

何时禁止显示警告

如果需要创建副本,则可禁止显示此规则的冲突。 若要禁止显示此警告,只需添加显式强制转换即可。

代码语言:javascript复制
class C
{
    public void TestMethod(byte arr[])
    {
        // The violation occurs
        ReadOnlySpan<byte> tmp1 = arr[0..2];
        ReadOnlyMemory<byte> tmp3 = arr[5..8];
        ...
    }
}
class C
{
    public void TestMethod(byte arr[])
    {
        // The violation fixed with explicit casting
        ReadOnlySpan<byte> tmp1 = (ReadOnlySpan<byte>)arr[0..2];
        ReadOnlyMemory<byte> tmp3 = (ReadOnlyMemory<byte>)arr[5..8];
        ...
    }
}

相关规则

CA1831:在合适的情况下,为字符串使用 AsSpan 而不是基于范围的索引器

CA1833:使用 AsSpan 或 AsMemory 而不是基于范围的索引器来获取数组的 Span 或 Memory 部分

另请参阅

性能规则

0 人点赞