Protobuf-net：C#高效序列化工具，助力接口傳輸與前端解析
作者：架構師老盧
通過定義消息類型、序列化和反序列化實現數據傳輸，并可適用于Web接口。前端可使用protobuf.js庫解析Protobuf格式數據。
概述：Protobuf-net是C#中高效的二進制序列化工具，以緊湊、跨語言支持和卓越性能著稱。通過定義消息類型、序列化和反序列化實現數據傳輸，并可適用于Web接口。前端可使用protobuf.js庫解析Protobuf格式數據。
Protobuf-net 在 C# 中的編碼結構及使用方法
優點
Protobuf-net（Protocol Buffers）是一種高效的二進制序列化工具，具有以下優點：
- 高效緊湊： 生成的二進制數據體積小，傳輸效率高。
- 跨語言支持： 適用于多語言環境，實現了多語言間數據的無縫交互。
- 性能優越： 相比其他序列化方式，序列化和反序列化速度更快。
使用方法
1. 定義消息類型
使用 ProtoContract 和 ProtoMember 屬性定義消息類型：
[ProtoContract]
public class Person {
[ProtoMember(1)]
public int Id { get; set; }
[ProtoMember(2)]
public string Name { get; set; }
[ProtoMember(3)]
public string Email { get; set; }
}2. 序列化與反序列化
// 序列化
Person person = new Person { Id = 1, Name = "John Doe", Email = "john@example.com" };
using (MemoryStream stream = new MemoryStream()) {
Serializer.Serialize(stream, person);
byte[] serializedData = stream.ToArray();
// 將 serializedData 發送給其他系統或保存到文件
}
// 反序列化
byte[] receivedData = /* 從其他系統獲取的數據 */;
using (MemoryStream stream = new MemoryStream(receivedData)) {
Person deserializedPerson = Serializer.Deserialize<Person>(stream);
// 使用 deserializedPerson 對象
}注意事項
- 版本一致性： 序列化和反序列化的結構版本需一致，以免造成兼容性問題。
- 默認值： Protobuf 不會序列化默認值，需注意默認值可能導致的數據丟失。
是否適合 Web 接口使用
Protobuf-net 適用于 Web 接口，尤其是對于需要高性能和低帶寬的場景。通過配置 Web API 或 gRPC 服務器，可以使用 Protobuf 格式進行數據傳輸。
前端JS調用和解析
前端可以使用protobuf.js庫解析Protobuf格式的數據，以下是簡單的示例：
<script src="https://cdn.jsdelivr.net/npm/protobufjs/dist/protobuf.min.js"></script>
<script>
// 加載Protobuf定義
protobuf.load("path/to/your/protofile.proto", function(err, root) {
if (err) throw err;
// 獲取消息類型
var Person = root.lookupType("YourNamespace.Person");
// 解碼二進制數據
var binaryData = /* 從服務器獲取的二進制數據 */;
var message = Person.decode(binaryData);
// 使用解碼后的消息對象
console.log(message);
});
</script>在這個例子中，通過protobuf.js加載Protobuf定義，然后使用lookupType獲取消息類型，最后通過decode方法解碼服務器返回的二進制數據。得到解碼后的消息對象后，可以在前端JS中方便地使用。
責任編輯：姜華
來源：
今日頭條
