反序列化一个字节数组

Question

如果我想从一个二进制文件中填充一个结构体，我会使用类似这样的代码：

using (BinaryReader br = new BinaryReader(File.Open(filename, FileMode.Open)))
{
    myStruct.ID = br.ReadSingle();
    myStruct.name = br.ReadBytes(20);
}

然而，我必须先将整个文件读入字节数组再进行反序列化，因为我想要进行一些预处理。是否有任何托管的方法可以从字节数组中填充我的结构体，最好类似于上面的方法？

- skink

---

你应该考虑使你的类型可序列化。如果你有兴趣，我可以提供一个示例。查看“BinaryFormatter”以进行二进制序列化。 - Glenn Ferrie

根据我的经验，“BinaryFormatter” 很少是序列化数据的正确选择。 - CodesInChaos

这在很大程度上取决于情况。我通常需要一个明确定义的文件格式，因此我使用类似 Linq-to-Json 或 Linq-to-Xml 的东西在内存表示和文件格式之间进行转换。有时候 protobuf 很好，因为它非常紧凑。在一些罕见的情况下，如果您不需要版本控制并且可以接受其深度侵入性，则 BinaryFormatter 可能是正确的选择。在游戏中的保存游戏是适合 BinaryFormatter 的少数情况之一。 - CodesInChaos

关于 BinaryFormatter 的另一个重大问题是，您必须绝对信任该文件。创建该文件的人很可能能够在您的程序上下文中执行代码。 - CodesInChaos

Linq-To-Json/Xml 技术上并不是序列化。表示之间的转换是手动完成的，这显然需要更多的工作。但我认为对于稳定的文件格式，内存表示和存储格式的清晰分离通常值得额外的工作。 - CodesInChaos

Answer 1

这是一个示例，将一些数据（实际上是 System.Data.DataSet）序列化为字节数组，并使用 DeflateStream 进行压缩。

try
{
    var formatter = new BinaryFormatter();
    byte[] content;
    using (var ms = new MemoryStream())
    {
         using (var ds = new DeflateStream(ms, CompressionMode.Compress, true))
         {
             formatter.Serialize(ds, set);
         }
         ms.Position = 0;
         content = ms.GetBuffer();
         contentAsString = BytesToString(content);
     }
}
catch (Exception ex) { /* handle exception omitted */ }

这是反序列化代码：

        var set = new DataSet();
        try
        {
            var content = StringToBytes(s);
            var formatter = new BinaryFormatter();
            using (var ms = new MemoryStream(content))
            {
                using (var ds = new DeflateStream(ms, CompressionMode.Decompress, true))
                {
                    set = (DataSet)formatter.Deserialize(ds);                        
                }
            }
        }
        catch (Exception ex)
        {
            // removed error handling logic!
        }

希望这能有所帮助。正如 Nate 所暗示的那样，我们在这里使用了 MemoryStream。

- Glenn Ferrie

---

非常感谢，这对于大型结构应该更有帮助。只是一个问题 - 改变结构对齐方式会影响反序列化结果吗？ - skink

我认为结构体对齐会影响序列化和反序列化，但我不确定。 - Glenn Ferrie

@Angel，就记录而言，我强烈建议不要使用BinaryFormatter进行任何类型的存储。它有几个讨厌的怪癖，老实说，我已经失去了帮助人们解决丢失数据等问题的次数。存在其他序列化程序 (基于广泛的序列化工作，我认为) 更强大，更方便，对CPU和带宽都更高效。 - Marc Gravell

嗨，马克 - 我正在使用我现在正在开发的代码中的这个示例，我之前使用了XmlSerializer，但是现在切换到了BinaryFormatter。我应该回去吗？还有其他选项吗？ - Glenn Ferrie

@Glenn 这取决于您想要使用序列化器做什么。 - CodesInChaos

Answer 2

看一下BitConverter类。它可能会满足你的需求。

- Joel Coehoorn

---

谢谢你的回答，那个类确实满足了我的需求。唯一的小不便是我需要手动跟踪位置。 - skink

Answer 3

对于那些非Serializable且仅包含基本类型的非常简单的结构体，这个方法可以使用。我用它来解析已知格式的文件。出于清晰起见，错误检查已删除。

using System;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;

namespace FontUtil
{
    public static class Reader
    {
        public static T Read<T>(BinaryReader reader, bool fileIsLittleEndian = false)
        {
            Type type = typeof(T);
            int size = Marshal.SizeOf(type);
            byte[] buffer = new byte[size];
            reader.Read(buffer, 0, size);
            if (BitConverter.IsLittleEndian != fileIsLittleEndian)
            {
                FieldInfo[] fields = type.GetFields();
                foreach (FieldInfo field in fields)
                {
                    int offset = (int)Marshal.OffsetOf(type, field.Name);
                    int fieldSize = Marshal.SizeOf(field.FieldType);
                    for (int b = offset, t = fieldSize + b - 1; b < t; ++b, --t)
                    {
                        byte temp = buffer[t];
                        buffer[t] = buffer[b];
                        buffer[b] = temp;
                    }
                }
            }
            GCHandle h = GCHandle.Alloc(buffer, GCHandleType.Pinned);
            T obj = (T)Marshal.PtrToStructure(h.AddrOfPinnedObject(), type);
            h.Free();
            return obj;
        }
    }
}

结构体需要像这样声明（不能包含数组，我想，没有尝试过 - 字节序交换可能会混淆）。

[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct NameRecord
{
    public UInt16 uPlatformID;
    public UInt16 uEncodingID;
    public UInt16 uLanguageID;
    public UInt16 uNameID;
    public UInt16 uStringLength;
    public UInt16 uStringOffset; //from start of storage area
}

- Charlie Skilbeck