CA1865-CA1867：对于只有一个 char 的字符串，使用“string.Method(char)” ，而不是“string.Method(string)”

  • 项目
属性 值
规则 ID CA1865-CA1867
标题 对于只有一个 char 的字符串，使用“string.Method(char)” ，而不是“string.Method(string)”
类别 “性能”
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 CA1865 - 作为建议
CA1866 - 作为建议
CA1867 — 否

原因

当 string.Method(char) 可用时使用 string.Method(string)。

用于这些规则的 string 上的目标方法：

  • StartsWith
  • EndsWith
  • IndexOf
  • LastIndexOf

下表汇总了每个相关规则 ID 的条件。

诊断 ID 说明 可用的代码修复
CA1865 当可以使用代码修复来自动执行安全转换时，则适用。 是
CA1866 当没有指定的比较时，则适用。 否
CA1867 适用于另两个规则未涵盖的任何其他字符串比较。 否

CA1867 默认处于禁用状态。

规则说明

采用 char 参数的重载的性能优于采用 string 参数的重载。

如何解决冲突

若要解决冲突，请使用 char 参数重载而不是 string 参数重载。

请考虑以下示例：

public bool StartsWithLetterI()
{
    var testString = "I am a test string.";
    return testString.StartsWith("I");
}

Public Function StartsWithLetterI() As Boolean
    Dim testString As String = "I am a test string."
    Return testString.StartsWith("I")
End Function

此代码可以更改为将 'I' 传递给 StartsWith 而不是字符串 "I"。

public bool StartsWithLetterI()
{
    var testString = "I am a test string.";
    return testString.StartsWith('I');
}

Public Function StartsWithLetterI() As Boolean
    Dim testString As String = "I am a test string."
    Return testString.StartsWith("I"c)
End Function

何时禁止显示警告

如果不关心使用字符串调用方法对性能的影响，可禁止显示此规则的冲突警告。

抑制警告

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

#pragma warning disable CA1865 // or CA1866 or CA1867
// The code that's violating the rule is on this line.
#pragma warning restore CA1865 // or CA1866 or CA1867

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

[*.{cs,vb}]
dotnet_diagnostic.CA1865.severity = none
dotnet_diagnostic.CA1866.severity = none
dotnet_diagnostic.CA1867.severity = none

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

另请参阅