C#怎么实现Protobuf序列化 C# Protobuf-net使用方法

来源:这里教程网 时间:2026-02-21 17:34:17 作者:

在C#中使用Protobuf序列化,推荐用 protobuf-net(由Marc Gravell维护),它不依赖官方protoc编译器,支持直接通过特性(Attribute)标记类,轻量、高效、易集成。

1. 安装 protobuf-net 包

在项目中通过NuGet安装:

Visual Studio:工具 → NuGet包管理器 → 管理解决方案的NuGet包 → 搜索并安装 protobuf-net 命令行(.NET CLI):
dotnet add package protobuf-net

2. 定义可序列化的类

[ProtoContract]
标记类,用
[ProtoMember(n)]
标记字段或属性,序号
n
必须唯一且建议从1开始(兼容Protocol Buffers规范):

[ProtoContract]
public class Person
{
    [ProtoMember(1)]
    public int Id { get; set; }
    [ProtoMember(2)]
    public string Name { get; set; }
    [ProtoMember(3)]
    public DateTime BirthDate { get; set; }
}

⚠ 注意:字段/属性必须是public,或配合

[ProtoInclude]
[ProtoIgnore]
等做更细控制;不支持自动属性无getter/setter(如
public string Name { get; }
会报错)。

3. 序列化与反序列化操作

使用

Serializer
静态类完成二进制读写:

序列化(对象 → byte[]):
Serializer.Serialize(stream, obj)
反序列化(byte[] → 对象):
Serializer.Deserialize<t>(stream)</t>

示例:

var person = new Person { Id = 123, Name = "张三", BirthDate = new DateTime(1990, 5, 1) };
// 序列化到内存流
using var ms = new MemoryStream();
Serializer.Serialize(ms, person);
byte[] data = ms.ToArray();
// 反序列化回来
using var ms2 = new MemoryStream(data);
Person restored = Serializer.Deserialize<Person>(ms2);

4. 进阶提示(实用但易忽略)

• 默认不支持Dictionary和多维数组:需手动处理或改用

List<keyvaluepair>></keyvaluepair>
+ 自定义转换。

• 版本兼容靠字段序号,不是字段名:新增字段加新序号、旧字段不要删或改序号,可设

[ProtoMember(4, IsRequired = false, Default = 0)]
提高健壮性。

• 性能优化建议:对高频类型可预生成序列化器(

RuntimeTypeModel.Default.Add(typeof(Person)).CompileInPlace();
),避免运行时反射开销。

基本上就这些。不需要写 .proto 文件,也不用跑 protoc,适合快速上手和中小规模数据交换场景。

相关推荐