博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
《Dotnet9》系列-Google ProtoBuf在C#中的简单应用
阅读量:3963 次
发布时间:2019-05-24

本文共 2417 字,大约阅读时间需要 8 分钟。

简介

什么是 Google Protocol Buffer? 假如您在网上搜索,应该会得到类似这样的文字介绍:

Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准,目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。

Protocol Buffers 是一种轻便高效的结构化数据存储格式,可以用于结构化数据串行化,或者说序列化。它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。目前提供了 C++、Java、Python 三种语言的 API。

说一千道一万,Google Protocol Buffer是一个序列化数据结构好帮手,  相对于XML、二进制序列化方式,Protobuf效率较高,支持数据量较大,protobuf序列化后的大小是json的1/10,xml格式的1/20,是二进制序列化的1/10 (具体本人未测试过,数据由此篇文章得到:)

C#中怎么使用?

一、准备工作

  1. Visual Studio 2019(其他版本亦可)
  2. Nuget安装:Google.Protobuf和Google.Protobuf.Tools
  3. 准备.proto文件

二、关于proto文件

使用ProtoBuf,主要有两个操作:序列化和反序列化。这两个操作都需要协议描述文件,也就是.proto文件。如果要使用protobuf存储自定义的数据,就要自己编写proto文件,如果要读取其他的ProtoBuf序列化文件,就要先知道要读取的ProtoBuf序列化文件的协议,也就是要获得对应的.proto文件,这是一个必须条件,没有对应的proto文件,就无法正确打开ProtoBuf序列化文件。

三、步骤

1、安装Google.Protobuf和Google.Protobuf.Tools的Nuget包

2、在Google.Protobuf.Tools下找到编译工具protoc.exe,我的电脑中路径是:C:\Users\admin.nuget\packages\google.protobuf.tools\3.10.1\tools\windows_x64,在此目录之上,还有很多版本,看您程序具体版本及tools版本而定。

3、准备好协议描述文件xx.proto,需要注意的是,proto文件之间可以互相引用,要正常使用,必须把所有相关的proto文件都准备好。下面是我自己写的一个测试文件test.proto:

syntax = "proto3";option cc_enable_arenas = true;package Test;message TestContact {	int32 ID = 1;	string Address = 2;	string Name = 3;}

4、生成解码器

  1. 建立两个文件夹,一个名为src,另一个为gen
  2. 把准备好的proto文件全部放到src中,如我的test.proto
  3. 运行命令:.\protoc.exe –proto_path=src –csharp_out=gen test.proto
  4. 把所有的proto文件都生成一遍
  5. 在gen文件夹中,会发现有等量的.cs文件,这就是对应的解码器,我们要把他们放进自己的工程中。

5、打开安装了Google.Protobuf和Google.Protobuf.Tools的Nuget包的C#工程,把刚刚生成的解码器导入工程中。

我把tools工具和proto文件及proto cs文件一起放入工程的代码结构

6、具体使用代码

using Google.Protobuf;using System;using System.IO;using Test;namespace protoctest{    class Program    {        static void Main(string[] args)        {            TestContact t = new TestContact();            t.ID = 1;            t.Name = "xiao ming";            t.Address = "Cheng Du";            Console.WriteLine($"序列化之前:{t}");            //序列化操作            byte[] data = new byte[t.CalculateSize()];            using (CodedOutputStream cos = new CodedOutputStream(data))            {                t.WriteTo(cos);                //data = cos.to.ToArray();            }            //反序列化操作            TestContact t1 = TestContact.Parser.ParseFrom(data);            Console.WriteLine($"反序列化得到:{t1}");            Console.ReadKey();        }    }}

7、运行效果如下

四、代码

代码已上传CSDN:

参考文章如下:

 

版权声明:本文为博主「沙漠尽头的狼」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。

原文链接:

你可能感兴趣的文章
inotify
查看>>
inode
查看>>
Shell: sh,bash,csh,tcsh等shell的区别
查看>>
golang ubuntu 配置 笔记
查看>>
vim 常用命令
查看>>
golang 开源项目
查看>>
ubntu 开发服务进程
查看>>
linux 常用命令以及技巧
查看>>
记录1年免费亚马逊AWS云服务器申请方法过程及使用技巧
查看>>
golang文章
查看>>
Source Insight 经典教程
查看>>
快速打开菜单附件中的工具
查看>>
Windows系统进程间通信
查看>>
linux exec的用法
查看>>
C语言中如何使用宏
查看>>
Http与RPC通信协议的比较
查看>>
Source Insight的对齐问题
查看>>
ubuntu设置开机默认进入字符界面方法
查看>>
chrome 快捷键
查看>>
Linux下buffer和cache的区别
查看>>