在 C# .NET 中，首选静态 HashData 方法而不是 ComputeHash

news2024/10/7 13:15:59

在 .NET 中，哈希处理是一项常见任务，无论是用于数据完整性检查、密码哈希处理还是其他加密目的。传统上，开发人员使用各种哈希算法（例如 SHA256、MD5）提供的 ComputeHash 方法。但是，随着静态 HashData 方法的引入，现在有一种更现代、更方便的方法来执行哈希操作。本文探讨了使用 HashData 方法而非 ComputeHash 的优势，提供了其使用示例，包括基准测试，并展示了输出。

理解 ComputeHash

ComputeHash 方法是一个实例方法，用于计算给定输入数据的哈希值。此方法在 .NET 中已经广泛使用很长时间了。以下是使用 SHA256 的示例：

using System;
using System.Security.Cryptography;
using System.Text;
class Program
{
    static void Main()
    {
        using (SHA256 sha256 = SHA256.Create())
        {
            byte[] data = Encoding.UTF8.GetBytes("Hello, world!");
            byte[] hash = sha256.ComputeHash(data);

            Console.WriteLine(BitConverter.ToString(hash).Replace("-", ""));
            // Output: 7F83B1657FF1FC53B92DC18148A1D65DFC2D4A2764C3EFA3A5A9D10B6D77A7B4
        }
    }
}

在此示例中，创建了一个 SHA256 实例，并调用 ComputeHash 方法计算输入数据的哈希值。

HashData 介绍

HashData 方法是 .NET 5 中引入的静态方法。它提供了一种更直接、更有效的方法来计算哈希值，而无需实例化哈希算法类。以下是使用 HashData 的等效示例：

using System;
using System.Security.Cryptography;
using System.Text;
class Program
{
    static void Main()
    {
        byte[] data = Encoding.UTF8.GetBytes("Hello, world!");
        byte[] hash = SHA256.HashData(data);

        Console.WriteLine(BitConverter.ToString(hash).Replace("-", ""));
        // Output: 7F83B1657FF1FC53B92DC18148A1D65DFC2D4A2764C3EFA3A5A9D10B6D77A7B4
    }
}

使用 HashData，代码变得更干净、更简洁，因为它无需创建 SHA256 实例。

使用 HashData 的优点

简单性： HashData 方法无需管理算法实例，从而简化了散列过程。
性能： HashData 可以提高性能，因为它避免了对象实例化和处置的开销。
静态性质：作为静态方法，HashData 可在静态上下文中轻松使用，不需要使用语句进行处理。
一致性： HashData 可用于不同的哈希算法，提供一致的 API。

例子

比较 ComputeHash 和 HashData

为了更清楚起见，让我们比较一下这两种方法。

使用 ComputeHash

using System;
using System.Security.Cryptography;
using System.Text;
class Program
{
    static void Main()
    {
        string input = "Hello, world!";
        byte[] data = Encoding.UTF8.GetBytes(input);

        using (SHA256 sha256 = SHA256.Create())
        {
            byte[] hash = sha256.ComputeHash(data);
            Console.WriteLine($"ComputeHash: {BitConverter.ToString(hash).Replace("-", "")}");
            // Output: 7F83B1657FF1FC53B92DC18148A1D65DFC2D4A2764C3EFA3A5A9D10B6D77A7B4
        }
    }
}

使用 HashData

using System;
using System.Security.Cryptography;
using System.Text;
class Program
{
    static void Main()
    {
        string input = "Hello, world!";
        byte[] data = Encoding.UTF8.GetBytes(input);

        byte[] hash = SHA256.HashData(data);
        Console.WriteLine($"HashData: {BitConverter.ToString(hash).Replace("-", "")}");
        // Output: 7F83B1657FF1FC53B92DC18148A1D65DFC2D4A2764C3EFA3A5A9D10B6D77A7B4
    }
}

流的高级用法

HashData 方法还可以与流一起使用，这对于对大文件进行哈希处理而无需将其完全加载到内存中很有用。

using System;
using System.IO;
using System.Security.Cryptography;
class Program
{
    static void Main()
    {
        using (FileStream stream = File.OpenRead("largefile.txt"))
        {
            byte[] hash = SHA256.HashData(stream);
            Console.WriteLine(BitConverter.ToString(hash).Replace("-", ""));
            // Example Output: A5B9CFA0B55EC7D41E332B29F9D7A9A6D1A82AAE1A6DCCF9B1AC2E746D9D7FBF
        }
    }
}

ComputeHash 与 HashData 的基准测试

为了比较 ComputeHash 和 HashData 的性能，我们可以使用 BenchmarkDotNet 库。这是一个基准测试示例。

using System;
using System.Security.Cryptography;
using System.Text;
using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Running;
public class HashBenchmark
{
    private byte[] data;

    [GlobalSetup]
    public void Setup()
    {
        data = Encoding.UTF8.GetBytes("Hello, world!");
    }
    [Benchmark]
    public byte[] ComputeHash()
    {
        using (SHA256 sha256 = SHA256.Create())
        {
            return sha256.ComputeHash(data);
        }
    }
    [Benchmark]
    public byte[] HashData()
    {
        return SHA256.HashData(data);
    }
}
class Program
{
    static void Main(string[] args)
    {
        var summary = BenchmarkRunner.Run<HashBenchmark>();
    }
}