CA1850：首选静态 `HashData` 方法，而非 `ComputeHash`

项目
12/18/2023

属性	值
规则 ID	CA1850
标题	首选静态 `HashData` 方法，而非 `ComputeHash`
类别	“性能”
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	作为建议

原因

创建派生自 HashAlgorithm 的实例类型，用于调用其 ComputeHash 方法，并且该类型具有静态 HashData 方法。

规则说明

.NET 5 中引入了以下类型的静态 HashData 方法：

在只需对某些数据进行哈希处理的情况下，这些方法有助于简化代码。

使用这些静态 HashData 方法比创建和管理 HashAlgorithm 实例来调用 ComputeHash 更高效。

如何解决冲突

通常，通过更改代码以调用 HashData 并删除对 HashAlgorithm 实例的使用，即可修复规则。

public bool CheckHash(byte[] buffer)
{
  using (var sha256 = SHA256.Create())
  {
    byte[] digest = sha256.ComputeHash(buffer);
    return DoesHashExist(digest);
  }
}

Public Function CheckHash(buffer As Byte()) As Boolean
  Using sha256 As SHA256 = SHA256.Create()
    Dim digest As Byte() = sha256.ComputeHash(buffer)
    Return DoesHashExist(digest)
  End Using
End Function

可以将前面的代码更改为直接调用静态 HashData(Byte[]) 方法。

public bool CheckHash(byte[] buffer)
{
    byte[] digest = SHA256.HashData(buffer);
    return DoesHashExist(digest);
}

Public Function CheckHash(buffer As Byte()) As Boolean
  Dim digest As Byte() = SHA256.HashData(buffer)
  Return DoesHashExist(digest)
End Function

何时禁止显示警告

禁止显示此规则的警告是安全的。

抑制警告

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

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

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

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

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

另请参阅

性能规则

通过

CA1850：首选静态 HashData 方法，而非 ComputeHash

原因