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

BlaXuan · 发表于 2023-3-9 13:37

前言
protobuf其实是一种序列化方式，和json、xml如出一辙，之所以要学习protobuf是因为这种序列化方式得到的数据体积是很小的，这就导致了它在网络传输性能以及存储方面的优势；因为体积小，让protobuf序列化的数据传输性能高，磁盘占用率也低；所以protobuf序列化的场景一般出现在高性能业务中，基本上是通过tcp+protobuf的通信方式取代http+json；

安装protoc工具
我们在写protobuf之前需要先安装protoc这个工具，这个工具的作用就是将我们编写的.proto文件转换成目标语言对应的代码；比如我们现在是java语言，那么我们就要使用protoc这个工具把我们编写的.proto文件转成我们需要的java类文件；同样的，如果需要转成go语言、python语言同样也需要借助protoc这个编译工具；

image-20230109210127695.png

在上图中，最右边对应语言的代码都是通过protoc编译工具生成的，所以这个protoc工具是我们必须要搞定的；虽然有很多博客是使用的maven插件来解决.proto文件的编译问题，但是毕竟这不是一个普适的方法，对于非maven项目不是很友好，下面我们就介绍一个适用于所有操作系统的方式；

我们可以点击protoc工具下载链接，目前的最新版本是v21.12：

image-20230109215547248.png

找到protoc工具，根据自己的操作系统选择合适的安装包，我的操作系统是macos，那么我就选择protoc-21.12-osx-x86_64.zip：

image-20230109215652910.png

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

image-20230109222234046.png

接下来我们就可以在终端查看protoc的版本了：

$ protoc --version
libprotoc 3.21.12
复制代码
这也就表示我们在macos中已经成功安装好了protoc编译工具了。

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

windows环境下安装protoc工具

根据操作系统选择下载protoc-21.12-win32.zip或protoc-21.12-win64.zip；
解压缩下载好的安装包；
把protoc所在的bin文件夹全路径配置到环境变量中即可；windows如何配置环境变量请查资料；
配置好环境变量后就可以在终端执行protoc --version命令查看版本信息；
编写.proto文件
我们先来编写一个User.proto文件作为示例，我们的目标语言是java：

syntax &#34;proto3&#34;;

// 是否生成多个java文件
option java_multiple_files = false;
// 指定生成的java文件的包名
option java_package = &#34;com.example.awesomespring.proto&#34;;
// 指定生成java文件类名
option java_outer_classname = &#34;UserProtos&#34;;
// 是否生成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个属性，分别是id、name、email、phoneNumber，每个属性都需要一个唯一编号，范围从【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表示生成的结果放在哪个文件夹中，.代表当前文件夹；

我们看一下编译后的结果：

image-20230114235238217.png

说明我们的编译结果存放的位置有问题，我们需要简单调整一下，先把当前pwd位置调整到java包下面，再执行下面命令：

protoc --java_out=. ./com/example/awesomespring/proto/User.proto
复制代码
最终我们得到了我们想要的结果：

image-20230115000916485.png

小结
这篇文章就当是protobuf的一个入门，通过protoc工具将.proto文件编译成java代码的示例，我们已经可以简单地编写需要的.proto文件，并通过protoc工具编译成想要的java代码了，在后续的文章中我们还将继续深入了解protobuf；

		自动登录	找回密码
密码			立即注册