protobuf-net入门指南：高效.NET二进制序列化框架解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01029/article/details/148508736

protobuf-net入门指南：高效.NET二进制序列化框架解析

protobuf-net Protocol Buffers library for idiomatic .NET 项目地址: https://gitcode.com/gh_mirrors/pr/protobuf-net

什么是protobuf-net？

protobuf-net是一个高性能的.NET二进制序列化框架，它实现了Google Protocol Buffers（简称PB）规范。与.NET自带的BinaryFormatter类似，但protobuf-net在性能、跨平台兼容性和数据大小方面具有显著优势。

核心特点

单一DLL架构：整个核心功能封装在一个轻量级的程序集中，便于部署和使用
运行时类型处理：与大多数PB实现不同，protobuf-net可以直接处理现有的.NET类型，无需预先生成代码
高性能优化：内部采用多种优化策略确保序列化/反序列化速度极快
兼容性设计：既支持代码优先方式，也提供从.proto文件生成类的选项

为什么选择protobuf-net？

在需要高效数据交换的场景中，protobuf-net相比其他序列化方案具有明显优势：

数据体积小：二进制格式比XML/JSON更紧凑
处理速度快：序列化/反序列化性能优异
版本兼容：支持向前/向后兼容的数据结构变更
跨平台：基于PB规范，可与多种语言实现互操作

快速入门指南

第一步：添加引用

将protobuf-net程序集添加到项目中，这是使用框架的基础前提。该程序集需要随应用程序一起部署。

第二步：定义数据对象

protobuf-net使用普通的.NET类作为数据载体，定义时需注意：

[ProtoContract]
public class Person
{
    [ProtoMember(1)]  // 每个属性需要唯一标签
    public int Id { get; set; }
    
    [ProtoMember(2)]
    public string Name { get; set; }
    
    [ProtoMember(3)]
    public List<string> Emails { get; } = new List<string>();  // 集合不需要setter
}

关键要求：

类必须标记[ProtoContract]特性
必须有公共无参构造函数
每个要序列化的属性必须标记[ProtoMember]并指定唯一整数标签
普通属性需要getter和setter
集合属性可以只有getter

第三步：文件序列化操作

基本文件读写示例：

// 序列化到文件
using (var file = File.Create("person.bin"))
{
    Serializer.Serialize(file, person);
}

// 从文件反序列化
using (var file = File.OpenRead("person.bin"))
{
    var person = Serializer.Deserialize<Person>(file);
}

第四步：网络通信示例

网络传输需要处理消息边界问题，protobuf-net提供了带长度前缀的序列化方法：

// 发送端
Serializer.SerializeWithLengthPrefix(stream, message, PrefixStyle.Base128);

// 接收端
var message = Serializer.DeserializeWithLengthPrefix<MessageType>(
    stream, PrefixStyle.Base128);