C#和.NET：如何使用BinaryWriter将结构序列化为byte[]数组？

Question

如何使用BinaryWriter将一个相当复杂的结构序列化成byte[]数组?

更新:

• 为了使其正常工作，每个结构体(包括子结构体?)必须用[Serializable]属性进行注释。

• 我不需要实现ISerializable接口，因为这是设计给一个对象对自己的序列化进行控制的。

- Contango

---

protobuf-net工作得非常完美（请参见下面的答案）。强烈推荐。 - Contango

Answer 1

使用BinaryFormatter将对象序列化为字节数组，BinaryWriter仅用于向流中写入字节。

MyObject obj = new MyObject();
byte[] bytes;
IFormatter formatter = new BinaryFormatter();
using (MemoryStream stream = new MemoryStream())
{
   formatter.Serialize(stream, obj);
   bytes = stream.ToArray();
}

- TheCodeKing

---

太棒了！我花了2个小时才解决这个问题，而你只用了几分钟就回答了。你是编程之王！！ - Contango

@Gravitas 注意，BinaryFormatter 与类型模型紧密耦合；在我看来，它适用于在.NET和.NET应用程序之间传输完全相同版本的数据，但是在这个紧密的窗口之外，它会遇到很多问题。序列化是解决方案，但是有其他序列化器的行为比BinaryFormatter好得多。 - Marc Gravell

@Gravitas 关于 ToArray()，请改为使用 using (MemoryStream stream = ... - Marc Gravell

抱歉，更新了，请将类型更改为MemoryStream。 - TheCodeKing

@gdoron 由于 BinaryFormatter 与类型紧密绑定（而不是抽象模式），因此在人们改进其模型时，它的历史悠久且容易出现问题 - 几乎任何重构操作（重命名、移动、将属性更改为自动实现的属性、对程序集进行签名、更改公司名称和程序集等）都可能导致巨大的问题。当然还有一些其他运行时中不存在 BinaryFormatter 的情况。我已经无法计算参与过多少次“帮助，我使用了 BinaryFormatter，现在无法加载我的数据”这样的问题了。数量太多了。 - Marc Gravell

Answer 2

根据评论，原帖的情境需要与应用程序/ .NET未来版本强烈兼容，因此我总是建议不要使用 BinaryFormatter - 它有许多“功能”在版本之间不能很好地工作（也肯定不能在平台之间工作）。

我建议使用基于合同的序列化器；虽然我有偏见，但我倾向于protobuf-net（它映射到Google的protobuf规范）。最简单的方法是通过对类型进行属性注释，使库可以轻松处理它们（尽管也可以在不使用属性的情况下完成），例如：

 [ProtoContract]
 public class Customer {
     [ProtoMember(1)]
     public List<Order> Orders {get {....}}

     [ProtoMember(2)]
     public string Name {get;set;}

     ... etc
 }

(如果你做过任何XmlSerializer或DataContractSerializer工作，那么属性方法就非常熟悉了 - 实际上，如果您不想添加protobuf-net特定的属性，protobuf-net可以使用来自那些序列化器的属性)

然后类似于：

Customer cust = ...
byte[] data;
using(var ms = new MemoryStream()) {
    Serializer.Serialize(ms, cust);
    data = ms.ToArray();
}

这种方式产生的数据是与平台无关的，可以加载到任何匹配的合同上（甚至不需要是 Customer - 它可以通过属性与匹配布局的任何类型相匹配）。实际上，在大多数情况下，它都可以轻松地加载到任何其他 protobuf 实现中 - Java、C++ 等。

- Marc Gravell

---

@Gravitas - 有关信息请查看：http://code.google.com/p/support/issues/detail?id=5809 - Marc Gravell

顺便说一下，我刚刚将protobuf集成到我的代码中，它运行得非常好。看着这个代码库，它是一件真正美丽的艺术品。我发誓，我对真正优雅的代码印象比卢浮宫最好的技能示例还要深刻。 - Contango

@Gravitas 你太慷慨了；内部代码并不特别优雅（也没有必要）。库代码通常接受一大块丑陋的代码，以便调用应用程序代码可以保持简洁。更多信息请参见这里。 - Marc Gravell

@Contango +1，因为这是一个虚荣但令人沮丧的评论。 - nik.shornikov

版本容忍序列化怎么样？https://msdn.microsoft.com/zh-cn/library/ms229752(v=vs.110).aspx - EKanadily

@docesam 它的工作效果不太好 - 它根本不够宽容；此外，在所有框架中BinaryFormatter根本不存在... - Marc Gravell

Answer 3

代码片段。

public static byte[] XmlSerializeToByte<T>(T value) where T : class
{
    if (value == null)
    {
        throw new ArgumentNullException();
    }

    XmlSerializer serializer = new XmlSerializer(typeof(T));

    using (MemoryStream memoryStream = new MemoryStream())
    {
        using (XmlWriter xmlWriter = XmlWriter.Create(memoryStream))
        {
            serializer.Serialize(xmlWriter, value);

            return memoryStream.ToArray();
        }
    }
}

    public static T XmlDeserializeFromBytes<T> (byte[] bytes)
                                     where T : class
    {
        if (bytes == null || bytes.Length == 0)
        {
            throw new InvalidOperationException();
        }

        XmlSerializer serializer = new XmlSerializer(typeof(T));

        using (MemoryStream memoryStream = new MemoryStream(bytes))
        {
            using (XmlReader xmlReader = XmlReader.Create(memoryStream))
            {
                return (T)serializer.Deserialize(xmlReader);
            }
        }
    }


        //Serialize
        Duck duck = new Duck() { Name = "Donald Duck" };
        byte[] bytes = Test.XmlSerializeToByte(duck);
        //Deserialize
        var deDuck = Test.XmlDeserializeFromBytes<Duck>(bytes);
        Console.WriteLine(deDuck.Name);

- Nuri YILMAZ

---

我们如何进行反序列化？ - Haseeb Jadoon

@Jadoon 更新了答案，你可以找到如何反序列化的方法。 - Nuri YILMAZ