CA1309:使用按顺序的 StringComparison

属性
规则 ID CA1309
标题 使用按顺序的 StringComparison
类别 全球化
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用

原因

非语义的字符串比较运算不会将 StringComparison 参数设置为 Ordinal 或 OrdinalIgnoreCase 。

规则说明

许多字符串操作(最重要的是 System.String.CompareSystem.String.Equals 方法)现在提供重载,后者接受 System.StringComparison 枚举值作为参数。

指定 StringComparison.Ordinal 或 StringComparison.OrdinalIgnoreCase 时,字符串比较是非语义的 。 也就是说,在制定比较决策时,将忽略特定于自然语言的特征。 忽略自然语言特征意味着决策基于简单的字节比较,而不是按区域性参数化的大小写或相等表。 因此,通过将参数显式设置为 StringComparison.Ordinal 或 StringComparison.OrdinalIgnoreCase,通常可以提高代码的速度、正确性和可靠性 。

如何解决冲突

若要解决此规则的冲突,请将字符串比较方法更改为接受 System.StringComparison 枚举为参数的重载,并指定 Ordinal 或 OrdinalIgnoreCase 。 例如,将 String.Compare(str1, str2) 更改为 String.Compare(str1, str2, StringComparison.Ordinal)

何时禁止显示警告

当库或应用程序仅用于有限的本地受众时,或应使用当前区域性的语义时,可忽略此规则的警告。

抑制警告

如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。

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

若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none

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

有关详细信息,请参阅如何禁止显示代码分析警告

另请参阅