如何在 C# 中快速读取二进制文件？（ReadOnlySpan 与 MemoryStream）

Question

我正在尝试以最快的速度解析二进制文件。所以这就是我第一次尝试做的事情：

using (FileStream filestream = path.OpenRead()) {
   using (var d = new GZipStream(filestream, CompressionMode.Decompress)) {
      using (MemoryStream m = new MemoryStream()) {
         d.CopyTo(m);
         m.Position = 0;

         using (BinaryReaderBigEndian b = new BinaryReaderBigEndian(m)) {
            while (b.BaseStream.Position != b.BaseStream.Length) {
               UInt32 value = b.ReadUInt32();
}  }  }  }  }

其中BinaryReaderBigEndianclass实现如下：

public static class BinaryReaderBigEndian {
   public BinaryReaderBigEndian(Stream stream) : base(stream) { }

   public override UInt32 ReadUInt32() {
      var x = base.ReadBytes(4);
      Array.Reverse(x);
      return BitConverter.ToUInt32(x, 0);
}  }

然后，我尝试使用 ReadOnlySpan 而不是 MemoryStream 来提高性能。所以，我尝试这样做：

using (FileStream filestream = path.OpenRead()) {
   using (var d = new GZipStream(filestream, CompressionMode.Decompress)) {
      using (MemoryStream m = new MemoryStream()) {
         d.CopyTo(m);
         int position = 0;
         ReadOnlySpan<byte> stream = new ReadOnlySpan<byte>(m.ToArray());

         while (position != stream.Length) {
            UInt32 value = stream.ReadUInt32(position);
            position += 4;
}  }  }  }

其中 BinaryReaderBigEndian class 更改为：

public static class BinaryReaderBigEndian {
   public override UInt32 ReadUInt32(this ReadOnlySpan<byte> stream, int start) {
      var data = stream.Slice(start, 4).ToArray();
      Array.Reverse(x);
      return BitConverter.ToUInt32(x, 0);
}  }

但是，不幸的是，我没有注意到任何改进。那么，我哪里做错了？

Answer 1

我在我的计算机上对您的代码进行了一些测量（Intel Q9400、8 GiB RAM、SSD 磁盘、Win10 x64 家庭版、.NET Framework 4/7/2，使用 15 MB 进行测试（当解压）文件），结果如下：

无跨度版本：520 毫秒
跨度版本：720 毫秒

所以Span版本实际上更慢！为什么？因为 new ReadOnlySpan<byte>(m.ToArray()) 执行整个文件的额外副本并且 ReadUInt32() 执行 Span 的许多切片（切片很便宜，但不是免费的）。由于您执行了更多的工作，因此您不能仅仅因为使用了 Span.

就期望性能会更好

那么我们可以做得更好吗？是的。事实证明，代码中最慢的部分实际上是垃圾回收，这是由于重复分配由 [=14=18=] 调用创建的 4 字节 Array 引起的=] 方法。您可以通过自己实现 ReadUInt32() 来避免它。这非常简单，也消除了 Span 切片的需要。您还可以将 new ReadOnlySpan<byte>(m.ToArray()) 替换为 new ReadOnlySpan<byte>(m.GetBuffer()).Slice(0, (int)m.Length);，它执行便宜的切片而不是整个文件的复制。所以现在代码看起来像这样：

public static void Read(FileInfo path)
{
    using (FileStream filestream = path.OpenRead())
    {
        using (var d = new GZipStream(filestream, CompressionMode.Decompress))
        {
            using (MemoryStream m = new MemoryStream())
            {
                d.CopyTo(m);
                int position = 0;

                ReadOnlySpan<byte> stream = new ReadOnlySpan<byte>(m.GetBuffer()).Slice(0, (int)m.Length);

                while (position != stream.Length)
                {
                    UInt32 value = stream.ReadUInt32(position);
                    position += 4;
                }
            }
        }
    }
}

public static class BinaryReaderBigEndian
{
    public static UInt32 ReadUInt32(this ReadOnlySpan<byte> stream, int start)
    {
        UInt32 res = 0;
        for (int i = 0; i < 4; i++)
            {
                res = (res << 8) | (((UInt32)stream[start + i]) & 0xff);
        }
        return res;
    }
}

通过这些更改，我从 720 毫秒 下降到 165 毫秒（快 4 倍）。听起来不错，不是吗？但我们可以做得更好。我们可以完全避免MemoryStream复制和内联，进一步优化ReadUInt32():

public static void Read(FileInfo path)
{
    using (FileStream filestream = path.OpenRead())
    {
        using (var d = new GZipStream(filestream, CompressionMode.Decompress))
        {
            var buffer = new byte[64 * 1024];

            do
            {
                int bufferDataLength = FillBuffer(d, buffer);

                if (bufferDataLength % 4 != 0)
                    throw new Exception("Stream length not divisible by 4");

                if (bufferDataLength == 0)
                    break;

                for (int i = 0; i < bufferDataLength; i += 4)
                {
                    uint value = unchecked(
                        (((uint)buffer[i]) << 24)
                        | (((uint)buffer[i + 1]) << 16)
                        | (((uint)buffer[i + 2]) << 8)
                        | (((uint)buffer[i + 3]) << 0));
                }

            } while (true);
        }
    }
}

private static int FillBuffer(Stream stream, byte[] buffer)
{
    int read = 0;
    int totalRead = 0;
    do
    {
        read = stream.Read(buffer, totalRead, buffer.Length - totalRead);
        totalRead += read;

    } while (read > 0 && totalRead < buffer.Length);

    return totalRead;
}

现在它只需要不到 90 毫秒（比原来快 8 倍！）。没有 Span！ Span 在允许执行切片并避免数组复制的情况下非常有用，但盲目使用它不会提高性能。毕竟，Span 被设计为具有 performance characteristics on par with Array，但并没有更好（并且仅在对其有特殊支持的运行时，例如 .NET Core 2.1）。

如何在 C# 中快速读取二进制文件？（ReadOnlySpan 与 MemoryStream）

How to read a binary file quickly in c#? (ReadOnlySpan vs MemoryStream)

.net

c#

memorystream

如何在 C# 中快速读取二进制文件？ （ReadOnlySpan 与 MemoryStream）

How to read a binary file quickly in c#? (ReadOnlySpan vs MemoryStream)

.net

c#

memorystream

如何在 C# 中快速读取二进制文件？（ReadOnlySpan 与 MemoryStream）