CA1826:使用属性,而不是 Linq Enumerable 方法
属性 | 值 |
---|---|
规则 ID | CA1826 |
标题 | 使用属性,而不是 Linq Enumerable 方法 |
类别 | “性能” |
修复是中断修复还是非中断修复 | 非中断 |
在 .NET 8 中默认启用 | 作为建议 |
原因
对支持等效且更高效的属性的类型使用了 Enumerable LINQ 方法。
规则说明
此规则在具有等效但更高效的属性的类型集合上标记 Enumerable LINQ 方法调用,以提取相同的数据。
此规则分析实现 IReadOnlyList<T> 但不实现 IList<T> 的集合类型。
此规则标记针对这些集合类型对以下方法进行的调用:
- System.Linq.Enumerable.Count
- System.Linq.Enumerable.First
- System.Linq.Enumerable.FirstOrDefault
- System.Linq.Enumerable.Last
- System.Linq.Enumerable.LastOrDefault
经过分析的集合类型和方法可能会在将来扩展,以涵盖更多的情况。
如何解决冲突
若要解决冲突,请将 Enumerable 方法调用替换为属性访问。 例如,以下两个代码片段显示了规则冲突及其解决方法:
using System;
using System.Collections.Generic;
using System.Linq;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list.First());
Console.Write(list.Last());
Console.Write(list.Count());
}
}
using System;
using System.Collections.Generic;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list[0]);
Console.Write(list[list.Count - 1]);
Console.Write(list.Count);
}
}
提示
Visual Studio 中为此规则提供了代码修补程序。 若要使用它,请将光标置于冲突上,然后按“Ctrl+.(句点)”。 从显示的选项列表中选择“使用索引器”。
何时禁止显示警告
如果你不关心特定 Enumerable 方法调用造成的性能影响,可禁止显示此规则的冲突警告。
抑制警告
如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。
#pragma warning disable CA1826
// The code that's violating the rule is on this line.
#pragma warning restore CA1826
若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none
。
[*.{cs,vb}]
dotnet_diagnostic.CA1826.severity = none
有关详细信息,请参阅如何禁止显示代码分析警告。
配置代码以进行分析
使用下面的选项来配置代码库的哪些部分要运行此规则。
排除 FirstOrDefault 和 LastOrDefault 方法
可以将此规则配置为从分析中排除 Enumerable.FirstOrDefault 和 Enumerable.LastOrDefault。 如果可读性是一个问题,可以考虑排除这些方法,因为你为替换它们而编写的代码不容易阅读。 要排除这些方法,需将以下键值对添加到项目中的 .editorconfig 文件:
dotnet_code_quality.CA1826.exclude_ordefault_methods = true
相关规则
- CA1827:如果可以使用 Any,请勿使用 Count/LongCount
- CA1828:如果可以使用 AnyAsync,请勿使用 CountAsync/LongCountAsync
- CA1829:使用 Length/Count 属性,而不是 Enumerable.Count 方法