背景
gRPC作为google全家桶之一,拥有极高的传输效率,最近想把它加入到我们云端协议中去,提供高效的传输,解决进程间通信的问题。
看着很诱人,但是用起来却不是那么简单,花了一些功夫才把完整的Demo给跑起来,也遇到不少问题,大部分与环境有关,少部分需要改一些代码,在此记录并分享一下,怕忘了。
环境
OS : macOS Catalina 10.15.7 (19H2)
clang : Apple clang version 12.0.0 (clang-1200.0.32.27)
protoBuf: 3.13.0
cmake : 3.18.4
bazel : 2.2.0
安装步骤
1.准备工作
$ [sudo] xcode-select --install
brew install autoconf automake libtool shtool
2.下载
$ git clone -b RELEASE_TAG_HERE https://github.com/grpc/grpc
$ cd grpc
$ git submodule update --init
3.bazel编译
//Build gRPC C++
$ bazel build :all
到这里,基本上就是无脑参考官方文档,如果不出意外的话,会在git submodule update --init
时遇到部分库无法拉下来的问题,手动解决一下,顺利的话,编译成功会得到库文件,在GRPC/bazel-bin中,头文件的话,GRPC已经全部整理好了,在GRPC/include/中。
可以使用bazel编译,然后手动安装,但是还是推荐使用cmake来完成所有操作。这里我们也可以看出,对单个程序以及依赖库的编译和构建,bazel要更好一些,但是说到和系统环境打交道,当下还是cmake更加简单。
我们先假设使用bazel编译,没有安装相应的库和头文件,还是需要用cmake来install。
4.cmake编译及安装
cmake ../.. -DgRPC_INSTALL=ON \
-DCMAKE_BUILD_TYPE=Release \
-DgRPC_ABSL_PROVIDER=package \
-DgRPC_CARES_PROVIDER=package \
-DgRPC_PROTOBUF_PROVIDER=package \
-DgRPC_RE2_PROVIDER=package \
-DgRPC_SSL_PROVIDER=package \
-DgRPC_ZLIB_PROVIDER=package
执行完上述命令,不出意外会有一些找不到的XXX.cmake,别急,在GRPC/thirdParty中应该有这些依赖库的源码,直接使用cmake编译并安装即可。
在解决了依赖库的问题后,还有可能会遇到一个棘手的问题:
grpc/src/compiler/python_generator.h:47:41: error: only virtual member functions can be marked 'override'
uint64_t GetSupportedFeatures() const override;
grpc/src/compiler/python_generator.cc:882:10: error: use of undeclared identifier 'FEATURE_PROTO3_OPTIONAL'
return FEATURE_PROTO3_OPTIONAL;
这个可以参考issue,大意是本机已经装了一个protoBuf,所以在编译的时候不会去使用thirdParty/protoBuf,造成版本不匹配报错。
这个有点坑,因为我尝试了3.8.0和3.14.0都遇到这个错误,后来发现它要的是3.13.0,也就是说版本高或者低都不行。
所有第三方库一定要使用GRPC所依赖的版本,不要自己发挥!!!
在解决了所有的依赖问题之后,就可以编译了:
make
make install
使用(Demo)
Demo相关,也有一个官方文档,介绍也比较详细。
1. 编译demo
在examples/cpp/route_guide中,Makefile已经写好了,只需要make就行:
make
在mac上面可能会遇到下面这个问题:
Undefined symbols for architecture x86_64:
“_CFRelease”, referenced from:
absl::lts_2020_02_25::time_internal::cctz::local_time_zone() in absl_time_internal_cctz_src_time_zone_lookup.cc.o
“_CFStringGetCString”, referenced from:
absl::lts_2020_02_25::time_internal::cctz::local_time_zone() in absl_time_internal_cctz_src_time_zone_lookup.cc.o
“_CFStringGetLength”, referenced from:
absl::lts_2020_02_25::time_internal::cctz::local_time_zone() in absl_time_internal_cctz_src_time_zone_lookup.cc.o
“_CFStringGetMaximumSizeForEncoding”, referenced from:
absl::lts_2020_02_25::time_internal::cctz::local_time_zone() in absl_time_internal_cctz_src_time_zone_lookup.cc.o
“_CFTimeZoneCopyDefault”, referenced from:
absl::lts_2020_02_25::time_internal::cctz::local_time_zone() in absl_time_internal_cctz_src_time_zone_lookup.cc.o
“_CFTimeZoneGetName”, referenced from:
absl::lts_2020_02_25::time_internal::cctz::local_time_zone() in absl_time_internal_cctz_src_time_zone_lookup.cc.o
ld: symbol(s) not found for architecture x86_64
参考这篇issue,需要链接CoreFoundation
, 具体为:
IOS_LINK_FLAG=-framework CoreFoundation
$(CXX) $^ $(LDFLAGS) ${IOS_LINK_FLAG} -o $@
如果顺利的话,应该就可以编译成功了:
2.运行Demo
分别运行server和client:
./route_guide_server
./route_guide_client
最重要的一点
本文最重要的一句话:不要使用自己的库作为依赖库,一定要按照它的依赖库列表,一步一步编译安装,否则就会遇到各种各样怀疑到要放弃的坑!
依赖库列表在这个文件中。