Protobuf | 如何在 ubuntu 上安装 Protobuf 编译 proto 文件

相关系列：

• Protobuf | 安装 Gradle 插件编译 proto 文件
• Protobuf | 如何在 ubuntu 上安装 Protobuf 编译 proto 文件
• Protobuf | 如何在 MAC 上安装 Protobuf 编译 proto 文件

为什么需要配置 Protobuf 环境

因为 Protobuf 是 Google 开源的跨语言编码协议，所以它使用特殊的语法，需要使用 protoc 命令编译成我们需要的语言，目前 Protobuf 可以编译成 6 中语言，分别是：C++ 、C# 、Dart 、Go 、Java 、Python。

Protobuf 环境搭建

在 ubuntu 上配置 Protobuf 环境非常简单，首先执行以下命令，下载 Protobuf 编译需要的依赖。

sudo apt-get install autoconf automake libtool curl make g++ unzip -y

下载 protobuf 源码并编译

git clone https://github.com/google/protobuf.git
cd protobuf
git submodule update --init --recursive
./autogen.sh
./configure
make
make check
sudo make install
sudo ldconfig

按照上面所示的命令依次执行完，等待 10 ~ 20 分钟左右，即可安装成功，等待安装完成之后，执行以下命令验证是否安装成功。

protoc --version

如果出现以下信息代表安装成功。

libprotoc 3.12.3

接下来就可以开始编译 proto 文件。如果出现问题，请参考文末 常见问题 的解决方案

编写 proto 文件测试

1. 创建 Person.proto 文件，添加以下内容

syntax = "proto3";

option java_package = "com.hi.dhl.datastore.protobuf";
option java_outer_classname = "PersonProtos";

message Person {
  string name = 1;
}

• syntax ：指定 protobuf 的版本，如果没有指定默认使用 proto2，必须是.proto文件的除空行和注释内容之外的第一行
• option ：表示一个可选字段
  • java_package ： 指定生成 java 类所在的包名
  • java_outer_classname ： 指定生成 java 类的名字
• message 中包含了一个 string 类型的字段(name)。注意 ：= 号后面都跟着一个字段编号
• 每个字段由三部分组成：字段类型 + 字段名称 + 字段编号，在 Java 中每个字段会被编译成 Java 对象，其他语言会被编译其他语言类型

2. 执行 protoc 命令

以输出 Java 文件为例，执行以下命令即可输出对应的 Java 文件

protoc --java_out=./src/main/java -I=./  *.proto

• --java_out ： 指定输出 Java 文件所在的目录
• -I ：指定 proto 文件所在的目录
• *.proto ： 表示在 -I 指定的目录下查找以 .proto 结尾的文件

常见问题

错误一 ： not found

在安装过程中可能会出现以下错误。

./autogen.sh: 4: ./autogen.sh: autoreconf: not found

原因在于没有按照上面所示的命令执行，重新执行以下命令，即可解决。

sudo apt-get install autoconf automake libtool curl make g++ unzip -y

错误二：cannot open shared object file

安装完成之后，执行 protoc --version 命令后出现以下异常。

protoc: error while loading shared libraries: libprotoc.so.24: cannot open shared object file: No such file or directory

如果出现这个错误，执行以下命令即可解决。

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib

总结

在 ubuntu 和 Mac 上安装 Protocol Buffer 相比在 Win 上安装要简单很多，只要按照命令依次执行，基本上不会太大问题。

如果在安装过程中遇到了任何问题，欢迎在评论区留言，一起来完善这份教程，如果没有及时回复，可以来公众号：ByteCode 咨询。

参考文献：

• https://gist.github.com/diegopacheco/cd795d36e6ebcd2537cd18174865887b