通过

CA1864：首选“IDictionary.TryAdd(TKey, TValue)”方法

  • 项目
属性 值
规则 ID CA1864
标题 首选“IDictionary.TryAdd(TKey, TValue)”方法
类别 “性能”
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 作为建议

原因

Dictionary<TKey,TValue>.Add 通过调用 Dictionary<TKey,TValue>.ContainsKey(TKey) 进行保护。

规则说明

Dictionary<TKey,TValue>.ContainsKey(TKey) 和 Dictionary<TKey,TValue>.Add 都执行查找操作，这是冗余设置。 如果字典中已存在键，Dictionary<TKey,TValue>.Add 也会引发异常。 调用 Dictionary<TKey,TValue>.TryAdd 更高效，这会返回一个布尔值，指示是否已添加该值。 如果键已存在，则 TryAdd 不会覆盖该键的值。

如何解决冲突

将调用 Dictionary<TKey,TValue>.ContainsKey(TKey)，然后再调用 Dictionary<TKey,TValue>.Add 替换为对 Dictionary<TKey,TValue>.TryAdd 的单次调用。

示例

以下代码片段演示了 CA1864 冲突：

void Run(IDictionary<int, string> dictionary)
{
    if(!dictionary.ContainsKey(2)) {
        dictionary.Add(2, "Hello World");
    }
}

Sub Run(dictionary As IDictionary(Of Integer, String))
    If Not dictionary.ContainsKey(2) Then
        dictionary.Add(2, "Hello World")
    End If
End Sub

以下代码片段修复了冲突：

void Run(IDictionary<int, string> dictionary)
{
    dictionary.TryAdd(2, "Hello World");
}

Sub Run(dictionary As IDictionary(Of Integer, String))
    dictionary.TryAdd(2, "Hello World")
End Sub

何时禁止显示警告

如果性能不是问题，并且处理了 Dictionary<TKey,TValue>.Add 可能引发的异常，则可以安全地抑制此警告。

抑制警告

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

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

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

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

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