为了使用源码编译protobuf,需要下面的工具:
autoconf, automake, libtool, make, g++, unzip
如果你使用ubuntu/debian,你可以使用如下方式安装这些工具:
$ sudo apt-get install autoconf automake libtool curl make g++ unzip
在其他系统中,请使用对应的包管理工具安装这些必要的工具。
为了获得源码,可以从如下的地址下载一个.tag.gz包或者.zip包,这个取决于自己的喜好。
https://github.com/protocolbuffers/protobuf/releases/latest
如果你只需要C++,下载protobuf-cpp-[version].tar.gz,如果你还需要使用其他语言,例如java,你可以只下载protobuf-java-[version].tar.gz(每一个包中都已经包含了C++源码),如果你除了C++,还需要多种语言,下载protobuf-all-[version].tar.gz。
为了编译和安装C++ Protocal Buffer运行环境和Protocol Buffer编译器(protoc),执行下面的指令:
$ ./configure --prefix=... (下面会讲解)
$ make # 这个步骤时间可能会很长
$ make check # 这个步骤时间可能会很长
$ sudo make install
$ sudo ldconfig # refresh shared library cache.
如果”make check”失败了,你仍然可以安装,但是protobuf的有些特征在你的电脑上不能正确工作。如果你坚持安装,你就需要考虑这个风险。
编译proto文件的方法参考下面这条语句:
protoc --cpp_out=. addressbook.proto
注解:
1. 关于安装位置
如果使用./configure后面不带-prefix参数,那么这个包将会安装到/usr/local。然而,在很多平台中,/usr/local/lib不是LD_LIBRARY_PATH(用来搜索共享库)的一部分。你可以把这个目录添加成为LD_LIBRARY_PATH的一部分,你也可以将protobuf安装到/usr。为了实现这个效果,调用./configure的时候,使用如下语句:
./configure --prefix=/usr
如果在一个系统中需要同时使用多个protobuf版本,可以考虑将protobuf安装到各自的文件夹中,然后显示指定LD_LIBRARY_PATH,从而避免冲突。
如果你已经将protobuf构建到一个不同的前缀(prefix),先调用”make clean”, 然后再重新构建一次。
2. 编译依赖包
为了编译一个使用protobuf的包,你需要传入各种参数给编译器和链接器。2.2.0版本开始,protobuf可以使用pkg-config得到这些参数。如果你已经安装了pkg-config,你可以调用如下指令来获取这些参数:
pkg-config --cflags protobuf # print compiler flags
pkg-config --libs protobuf # print linker flags
pkg-config --cflags --libs protobuf # print both
在我的电脑中,
pkg-config --cflags protobuf 输出 -pthread -I/usr/local/include
pkg-config --libs protobuf 输出 -L/usr/local/lib -lprotobuf -pthread
例如可以使用如下方式编译使用protobuf的C++代码:
c++ my_program.cc my_proto.pb.cc `pkg-config --cflags --libs protobuf`
3. 二进制兼容性警告
由于C++的特性,两个protobuf版本的基本不会有兼容的ABIs。如果你使用一个旧版本的libprotobuf链接程序,这个程序一般不能够使用新版本的动态库运行。这个问题会在你的程序刚启动的时候,就被发现。为了避免这种情况,你也可以考虑使用静态链接,方法就是,在编译时,只安装静态库:
$ ./configure --disable-shared
以上只是安装完成了C++版本的proto的编译环境,对于其他语言,需要安装额外的插件,这里只讲述go语言,因为我使用go语言比较多。
首先记得安装go的开发环境,这点,我不打算说明。
最简单安装go插件的方式是:
go get -u github.com/golang/protobuf/protoc-gen-go
go的插件是protoc-gen-go,调用过上面的指令后,如果$GOBIN没有被设置,这个插件会被安装在$GOPATH/bin目录,如果$GOBIN和$GOPATH都没有设置,默认应该在~/go/bin目录。我们需要将protoc-gen-go所在的目录添加到$PATH目录中,否则在调用如下语句时:
protoc -I=. --go_out=. addressbook.proto
会报错:
protoc-gen-go: program not found or is not executable
--go_out: protoc-gen-go: Plugin failed with status code 1.
如果想要安装一个特定版本的protoc-gen-go(从而对应proto包的版本),可以采取的方式如下:
GIT_TAG="v1.2.0" # change as needed
go get -d -u github.com/golang/protobuf/protoc-gen-go
git -C "$(go env GOPATH)"/src/githubcom/golang/protobuf checkout $GIT_TAG
go install github.com/golang/protobuf/protoc-gen-go