Protobuf-net：C#高效序列化工具，助力接口传输与前端解析

风还是风

 
概述：Protobuf-net是C#中高效的二进制序列化工具，以紧凑、跨语言支持和卓越性能著称。通过定义消息类型、序列化和反序列化实现数据传输，并可适用于Web接口。前端可使用protobuf.js库解析Protobuf格式数据。
Protobuf-net 在 C# 中的编码结构及使用方法

优点

Protobuf-net（Protocol Buffers）是一种高效的二进制序列化工具，具有以下优点：

• 高效紧凑： 生成的二进制数据体积小，传输效率高。
  
• 跨语言支持： 适用于多语言环境，实现了多语言间数据的无缝交互。
  
• 性能优越： 相比其他序列化方式，序列化和反序列化速度更快。
  

使用方法

1. 定义消息类型

使用 ProtoContract 和 ProtoMember 属性定义消息类型：

1. [ProtoContract]
2. public class Person {
3.     [ProtoMember(1)]
4.     public int Id { get; set; }
6.     [ProtoMember(2)]
7.     public string Name { get; set; }
9.     [ProtoMember(3)]
10.     public string Email { get; set; }
11. }

复制代码

2. 序列化与反序列化

1. // 序列化
2. Person person = new Person { Id = 1, Name = "John Doe", Email = "john@example.com" };
3. using (MemoryStream stream = new MemoryStream()) {
4.     Serializer.Serialize(stream, person);
5.     byte[] serializedData = stream.ToArray();
6.    
7.     // 将 serializedData 发送给其他系统或保存到文件
8. }
10. // 反序列化
11. byte[] receivedData = /* 从其他系统获取的数据 */;
12. using (MemoryStream stream = new MemoryStream(receivedData)) {
13.     Person deserializedPerson = Serializer.Deserialize<Person>(stream);
14.     // 使用 deserializedPerson 对象
15. }

复制代码

注意事项

• 版本一致性： 序列化和反序列化的结构版本需一致，以免造成兼容性问题。
  
• 默认值： Protobuf 不会序列化默认值，需注意默认值可能导致的数据丢失。
  

是否适合 Web 接口使用

Protobuf-net 适用于 Web 接口，尤其是对于需要高性能和低带宽的场景。通过配置 Web API 或 gRPC 服务器，可以使用 Protobuf 格式进行数据传输。
前端JS调用和解析

前端可以使用protobuf.js库解析Protobuf格式的数据，以下是简单的示例：
[code][/code]在这个例子中，通过protobuf.js加载Protobuf定义，然后使用lookupType获取消息类型，最后通过decode方法解码服务器返回的二进制数据。得到解码后的消息对象后，可以在前端JS中方便地使用。
 

来源:https://www.cnblogs.com/hanbing81868164/p/18058053
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！