《Dotnet9》系列-Google ProtoBuf在C#中的简单应用

时间如流水,只能流去不流回!

点赞再看,养成习惯,这是您给我创作的动力!

本文 Dotnet9 https://dotnet9.com 已收录,站长乐于分享dotnet相关技术,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相关的Qt Quick和Qt Widgets等,只分享自己熟悉的、自己会的。

简介

什么是 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 (具体本人未测试过,数据由此篇文章得到:protobuf效率)

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:C#使用Google ProtoBuf例子

gitee: https://gitee.com/lsq6/GoogleProtoCSharpTest

参考文章如下:

  1. Protocol Buffer Basics: C#
  2. C# 中使用 Protocol Buffers 協定來序列化與反序列化物件
  3. 在C#中使用Google ProtoBuf

除非注明,文章均由 Dotnet9 整理发布,欢迎转载。

转载请注明本文地址:https://dotnet9.com/2019/12/it-technology/csharp/dotnet9-series-google-protobuf-in-csharp.html

如有所收获,请大力转发(能点赞及推荐那是极好的);如觉小编写文不易,欢迎给Dotnet9站点打赏,小编谢谢了;谢谢大家对dotnet技术的关注和支持 。

原文地址:https://www.cnblogs.com/Dotnet9-com/p/12052131.html

时间: 2024-10-10 08:25:13

《Dotnet9》系列-Google ProtoBuf在C#中的简单应用的相关文章

Google Protobuf在Netty中的使用

[toc] Google Protobuf在Netty中的使用 程序代码来自于<Netty权威指南>第8章,已经加了注释,不过需要注意的是,使用的proto源代码是在Google Protobuf入门与使用中生成的,关于protobuf代码自动生成工具的使用可以参考这篇文章. 例子中,通过解码器ProtobufVarint32FrameDecoder和编码器ProtobufVarint32LengthFieldPrepender的使用已经解决了半包问题,测试时可以把其注释掉,这样就可以演示Ne

vs2012 编译 并使用 google protobuf

参考网址: http://my.oschina.net/chenleijava/blog/261263 http://www.ibm.com/developerworks/cn/linux/l-cn-gpb/ http://blog.csdn.net/yi_ya/article/details/40404231 http://blog.csdn.net/yi_ya/article/details/40404059 http://blog.csdn.net/chenkjiang/article/d

GOOGLE PROTOBUF开发者指南

ProtoBuf开发者指南 译者: gashero 目录 1   概览 1.1   什么是protocol buffer 1.2   他们如何工作 1.3   为什么不用XML? 1.4   听起来像是为我的解决方案,如何开始? 1.5   一点历史 2   语言指导 2.1   定义一个消息类型 2.2   值类型 2.3   可选字段与缺省值 2.4   枚举 2.5   使用其他消息类型 2.6   嵌套类型 2.7   更新一个数据类型 2.8   扩展 2.9   包 2.10   定

VS下使用Google Protobuf完成SOCKET通信

如何在Windows环境下的VS中安装使用Google Protobuf完成SOCKET通信 出处:如何在Windows环境下的VS中安装使用Google Protobuf完成SOCKET通信 最近一段时间,由于项目的需要,接触到了Protobuf这个东东,在Linux环境下,体验了一把,感觉挺不错,很方便,且高效.是一个非常值得学习掌握和应用的数据抽象.平台无关.功能强大.…(此处省略1000字)的开源工具. Google虽然把Protobuf做成了跨平台.跨语言,但作为微软的死对头,它在re

在Android Studio配置google protobuf

1.在project的build.gradle中配置 buildscript { repositories { jcenter() mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:2.2.3' classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.0' } } 注意 Gradle版本至少是 2.12 并且Java 7,本例子使用的是2.

Google protobuf proto文件编写规则

转载自: http://blog.csdn.net/yi_ya/article/details/40404231 1. 简单介绍 protobuf文件:就是定义你要的消息(类似java中的类)和消息中的各个字段及其数据类型(类似java类中的成员变量和他的数据类型) 2. Protobuf消息定义 消息由至少一个字段组合而成,类似于C语言中的结构.每个字段都有一定的格式. 字段格式:限定修饰符① | 数据类型② | 字段名称③ | = | 字段编码值④ | [字段默认值⑤] 1)限定修饰符包含

Google Protobuf 使用 Java 版

一 . Protobuf 的入门 Protobuf 是一个灵活,高效,结构化的数据序列化框架, 相比于 XML 等传统的序列化工具,它更小,更快,更灵活,更简单. Protobuf 支持数据结构化一次可以到处使用.甚至跨语言使用.同通过代码生成工具可以自动生成不同语言版本的源代码,甚至可以在使用不同版本的数据结构中进行数据传递,实现数据结构的向前兼容. Google 的 protobuf 在业界非常流行,很多商业项目选择 protobuf 作为编码解码框架,这里我们一起回顾一下 Protobuf

google protobuf学习笔记一:使用和原理

一.什么是protobuf protobuf全称Google Protocol Buffers,是google开发的的一套用于数据存储,网络通信时用于协议编解码的工具库.它和XML或者JSON差不多,也就是把某种数据结构的信息,以某种格式(XML,JSON)保存起来,protobuf与XML和JSON不同在于,protobuf是基于二进制的.主要用于数据存储.传输协议格式等场合.那既然有了XML等工具,为什么还要开发protobuf呢?主要是因为性能,包括时间开销和空间开销: 1.时间开销:XM

google protobuf初体验

最近在读别人代码的时候发现一个的东西,名字叫protobuf, 感觉挺好用的,写在这里,留个记录.那么什么是protobuf 呢?假如您在网上搜索,应该会得到类似这样的文字介绍: Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准,目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件.他们用于 RPC 系统和持续数据存储系统. Protocol Buffers 是一种轻便高效的结构化