C#使用protobuf

原创已于 2023-09-26 08:59:07 修改 · 6.6k 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#c# #开发语言 #protobuf

于 2022-05-14 00:50:47 首次发布

C# 专栏收录该内容

74 篇文章

订阅专栏

本文介绍了如何在C#项目中利用NuGet安装protobuf，并通过编辑.proto文件生成序列化对象。示例展示了如何创建.pb_user_info消息类型，然后使用protobuf工具将.proto文件转换为.cs文件。在代码中，演示了如何实例化和填充序列化对象，以及如何进行序列化和反序列化的过程，最后展示了输出结果。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

编译依赖

首先，创建一个C#4.5以上project，因为最新的protobuf依赖于C#5.0的语言特性。
在这里插入图片描述
然后，我们通过nuget，为项目添加对protobuf的引用，搜索protobuf就可以开始安装了。

编辑.proto文件，生成序列化文件

例子：

syntax = "proto3";
 
message pb_user_info {
    string user_id = 1;
    string leader_id = 2;
    repeated string members = 3;
    int32 status = 4;
}

然后我们可以通过编译.proto文件，获得序列化的cs文件。
使用工具 https://lzltool.com/protobuf2cs 生成序列化的cs文件。
在这里插入图片描述

在工程中使用

将生成的序列化对象加入项目
在这里插入图片描述
序列化/反序列化示例

var userInfo = new pb_user_info
{
    LeaderId = "123",
    Status = 5,
    UserId = "newbie"
};
userInfo.Members.Add("张三");
userInfo.Members.Add("李四");

//序列化获取二进制数据
var bytes = userInfo.ToByteArray();


//反序列化获取对象
var ub = new pb_user_info();
ub.MergeFrom(bytes);

Console.WriteLine($"ub.UserId={ub.UserId}");
Console.WriteLine($"userInfo.Status={userInfo.Status}");
Console.WriteLine($"userInfo.LeaderId={userInfo.LeaderId}");
Console.WriteLine($"userInfo.Members={string.Join(",", userInfo.Members)}");

输出结果

ub.UserId=newbie
userInfo.Status=5
userInfo.LeaderId=123
userInfo.Members=张三,李四
请按任意键继续. . .