前语

protobuf其实是一种序列化方式,和jsonxml千篇一律,之所以要学习protobuf是因为这种序列化方式得到的数据体积是很小的,这就导致了它在网络传输功能以及存储方面的优势;因为体积小,让protobuf序列化的数据传输功能高,磁盘占用率也低;所以protobuf序列化的场景一般出现在高功能事务中,基本上是经过tcp+protobuf的通信方式替代http+json

装置protoc东西

咱们在写protobuf之前需求先装置protoc这个东西,这个东西的效果便是将咱们编写的.proto文件转换成目标言语对应的代码;比方咱们现在是java言语,那么咱们就要运用protoc这个东西把咱们编写的.proto文件转成咱们需求的java类文件;相同的,假如需求转成go言语、python言语相同也需求借助protoc这个编译东西;

初识Protobuf及其编译工具的安装

在上图中,最右边对应言语的代码都是经过protoc编译东西生成的,所以这个protoc东西是咱们必需求搞定的;虽然有很多博客是运用的maven插件来处理.proto文件的编译问题,可是究竟这不是一个普适的办法,关于非maven项目不是很友好,下面咱们就介绍一个适用于所有操作系统的方式;

咱们能够点击protoc东西下载链接,目前的最新版别是v21.12

初识Protobuf及其编译工具的安装

找到protoc东西,依据自己的操作系统挑选适宜的装置包,我的操作系统是macos,那么我就挑选protoc-21.12-osx-x86_64.zip

初识Protobuf及其编译工具的安装

下载下来后直接解压缩,直接把bin文件夹下面的protoc可执行文件拷贝到/usr/local/bin/中,再把include下的文件拷贝到/usr/local/include文件夹中;

初识Protobuf及其编译工具的安装

接下来咱们就能够在终端检查protoc的版别了:

$ protoc --version
libprotoc 3.21.12

这也就表明咱们在macos中现已成功装置好了protoc编译东西了。

linux操作系统环境下和macos下的装置方式一样;

windows环境下装置protoc东西

  • 依据操作系统挑选下载protoc-21.12-win32.zipprotoc-21.12-win64.zip
  • 解压缩下载好的装置包;
  • protoc所在的bin文件夹全路径装备到环境变量中即可;windows如何装备环境变量请查资料;
  • 装备好环境变量后就能够在终端执行protoc --version指令检查版别信息;

编写.proto文件

咱们先来编写一个User.proto文件作为示例,咱们的目标言语是java

syntax "proto3";
// 是否生成多个java文件
option java_multiple_files = false;
// 指定生成的java文件的包名
option java_package = "com.example.awesomespring.proto";
// 指定生成java文件类名
option java_outer_classname = "UserProtos";
// 是否生成equals和hash办法
option java_generate_equals_and_hash = true;
// 生成的java文件编码格局
option java_string_check_utf8 = true;
// protocol buffer编译器是否应该 根据服务界说 发生 抽象服务代码
option java_generic_services = false;
message User {
  int32 id = 1;
  string name = 2;
  string email = 3;
  enum PhoneType{
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }
  message PhoneNumber{
    PhoneType type = 1;
    string number = 2;
  }
  repeated PhoneNumber phoneNumber = 4;
}

来简略解释一下User.proto的内容,该文件将会生成一个UserProtos.java文件,不过在该UserProtos.java文件中才会生成User内部类等;

message User中,有4个特点,分别是idnameemailphoneNumber,每个特点都需求一个仅有编号,规模从【1~536,870,911】,可是【19000~19999】号段是保存编号,保存编号是不能被运用的;

每个特点都有一个对应的数据类型,int32对应java中的int类型,string对应的String类型;repeated修饰符代表该数据类型能够重复,repeated PhoneNumber phoneNumber翻译成java言语如下:

List<PhoneNumber> phoneNumber;

另外一个需求注意的便是enum,它里边的元素索引一定是从0开端的,枚举的默认值是第一个界说的枚举值;

编译proto文件

咱们接下来需求经过protoc东西来编译.proto文件,把.proto文件编译成咱们需求的目标言语对应的文件,当时pwd方位处于User.proto文件同一层:

protoc --java_out=. User.proto

上面的指令中,--java_out表明生成的成果放在哪个文件夹中,.代表当时文件夹;

咱们看一下编译后的成果:

初识Protobuf及其编译工具的安装

说明咱们的编译成果存放的方位有问题,咱们需求简略调整一下,先把当时pwd方位调整到java包下面,再执行下面指令:

protoc --java_out=. ./com/example/awesomespring/proto/User.proto

最终咱们得到了咱们想要的成果:

初识Protobuf及其编译工具的安装

小结

这篇文章就当是protobuf的一个入门,经过protoc东西将.proto文件编译成java代码的示例,咱们现已能够简略地编写需求的.proto文件,并经过protoc东西编译成想要的java代码了,在后续的文章中咱们还将继续深化了解protobuf

本文正在参加「金石计划」