【安装】grpc源码编译安装(Linux)

FintechBoy

已于 2023-10-25 13:14:43 修改

阅读量1.4k

点赞数 2

分类专栏： Linux 文章标签： rpc c++ linux

于 2023-10-24 23:58:14 首次发布

本文链接：https://blog.csdn.net/it_financial/article/details/133998701

版权

Linux 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

一. 编译环境说明

1. grpc版本: V1.58.0

2. gcc版本：gcc7或以上（当前使用 gcc version 7.5.0 (Ubuntu 7.5.0-3ubuntu1~18.04)）

3. cmake版本：3.8或以上（当前使用cmake version 3.19.6）

4. 操作系统版本：Ubuntu16.04

5. apt 源：阿里云

二. 编译环境准备

说明：由于Ubuntu16.04自带编译环境，gcc为4.8，cmake为3.5，不满足编译grpc-v1.58.0最低要求, 因此需要升级gcc和cmake环境。

1. 更新gcc

$ apt-get install build-essential autoconf libtool pkg-config

2. 更新cmake

# 1.下载自动安装脚本
  $ wget -q -O cmake-linux.sh https://github.com/Kitware/CMake/releases/download/v3.19.6/cmake-3.19.6-Linux-x86_64.sh
# 2.执行自动安装脚本（--prefix指定cmake安装目录）
  $ sh cmake-linux.sh -- --skip-license --prefix=/usr/local/cmake
# 3.删除自动安装脚本
  $ rm cmake-linux.sh
# 4.将cmake安装目录永久设置到PATH环境变量
  $ vim /etc/profile
   (最后一行新增：export PATH=/usr/local/cmake/bin:$PATH)
  $ source /etc/profile

三. 源码下载

# 注意：下载子模块时因github对应源码不在国内服务器，下载会很慢，最好使用梯子
git clone --recurse-submodules -b v1.58.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc

四、源码编译安装gRPC和Protocol Buffers（命令行）

# 1.进入grpc源码根路径
$ cd grpc
# 2.创建编译目录
$ mkdir -p cmake/build
# 3.进入编译目录
$ pushd cmake/build
# 4.执行cmake设置cmake参数，并指定安装目录为/usr/local/grpc（该命令会转换成makefile供编译使用）
$ cmake -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -DCMAKE_INSTALL_PREFIX=/usr/local/grpc ../..
# 5.编译
$ make -j 4
# 6.安装（将编译后的目标文件安装到/usr/local/grpc）
$ make install
# 7.退出编译目录
$ popd
###################################################################
# 至此，grpc源码库已编译完成，生成的相关头文件、库文件在/usr/local/grpc目录下
# 8. 查看编译后的目标文件
$ ls /usr/local/grpc
bin  include  lib  share

四、源码编译安装gRPC和Protocol Buffers（Qt Creator）

1. 设置Qt Creator CMake环境为3.19.0，并设置为默认套件

设置CMmake

修改构建套件的CMake Tool为新建的CMake

2. 打开grpc项目

1. 选择grpc源码目录中的CMakeLists.txt（grpc/CMakeLists.txt）
1. 初始打开，会弹出窗，设置cmake编译的构建目录；（构建产生的构建文件都会生成在该目录下）
1. 初始打开，设置构建目录后，会弹出窗设置CMake参数；
1. 点击CMake，执行CMake；（最终会生成MakeFile文件）
- 3)、4)步骤，等同于命令 cmake -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -DCMAKE_INSTALL_PREFIX=/usr/local/grpc …/…；该命令设置参数并执行cmake。
1. 然后项目打开完成。打开后工程结构如下：

3. 修改构建设置，添加构建步骤

1. 默认构建设置中，构建步骤只有make命令，如果希望执行make install，可以修改构建设置，添加make install 构建步骤

4. 构建（编译项目）

五、样例程序编译（使用已有CMakeLists.txt，全部编译）

$ cd examples/cpp/helloworld

$ mkdir -p cmake/build

$ pushd cmake/build

# 执行cmake，生成makefile文件（CMAKE_PREFIX_PATH 指定CMake的搜索路径，提供给find_package(), find_program(), find_library(), find_file(), 和find_path()等函数使用。
# 这里还有一个小知识点就是,CMAKE_INSTALL_PREFIX (执行make install命令时安装的根目录的路径) 会被添加到CMAKE_SYSTEM_PREFIX_PATH，所以find_package(), find_program(), find_library(), find_path(), find_ile()等命令也可以该目录为prefix去查找。）
$ cmake -DCMAKE_PREFIX_PATH=/usr/local/grpc ../..

#编译（如果多线程编译报错，则直接使用make进行编译即可）
$ make -j 4
############################

# 编译后，会生成如下文件：
root@node2:~/software/grpc/examples/cpp/helloworld/cmake/build# ls
CMakeCache.txt  cmake_install.cmake   greeter_async_client2  greeter_callback_client  greeter_client  helloworld.grpc.pb.cc  helloworld.pb.cc  libhw_grpc_proto.a
CMakeFiles      greeter_async_client  greeter_async_server   greeter_callback_server  greeter_server  helloworld.grpc.pb.h   helloworld.pb.h   Makefile

六、样例程序编译（单独编译）

# 1.进入到样例程序目录
$ cd /root/software/grpc/examples/cpp/helloworld

# 2.使用 protoc 和 gRPC C++ 插件从 helloworld.proto 文件生成 gRPC 服务端和客户端接口，生成的代码将被放置在当前目录中(该命令会生成helloworld.grpc.pb.h和helloworld.grpc.pb.cc两个文件)
$ protoc -I ../../protos --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` ../../protos/helloworld.proto

# 3.使用protoc和C++插件从helloworld.proto文件生成相应的数据接口,即响应和请求消息类(该命令会生成helloworld.pb.h和helloworld.pb.cc两个文件)
$ protoc -I ../../protos --cpp_out=. ../../protos/helloworld.proto

# 4.设置PKG_CONFIG_PATH变量（grpc相关库通过pkg-config管理，修改该变量指定pkg-config到grpc的安装目录里搜索pkgconfig）
$ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/grpc/lib/pkgconfig

##### re2库在grpc目录中没有re2.pc文件，需要单独指定搜索路径；否则使用pkgconfig会有如下错误
<<ErrorMsg
   Package re2 was not found in the pkg-config search path.
   Perhaps you should add the directory containing `re2.pc'
   to the PKG_CONFIG_PATH environment variable
   Package 're2', required by 'grpc', not found
   In file included from helloworld.pb.cc:4:0:
ErrorMsg
$ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/root/software/grpc/third_party/re2/

# 5.定义变量管理protobuf相关公共依赖库（目的使得g++编译命令简短一点）
$ export PROTOBUF_ABSL_DEPS=absl_absl_check absl_absl_log absl_algorithm absl_base absl_bind_front absl_bits absl_btree absl_cleanup absl_cord absl_core_headers absl_debugging absl_die_if_null absl_dynamic_annotations absl_flags absl_flat_hash_map absl_flat_hash_set absl_function_ref absl_hash absl_layout absl_log_initialize absl_log_severity absl_memory absl_node_hash_map absl_node_hash_set absl_optional absl_span absl_status absl_statusor absl_strings absl_synchronization absl_time absl_type_traits absl_utility absl_variant

# 6.使用greeter_server.cc编译服务端程序
$ g++ -o greeter_server helloworld.pb.cc helloworld.grpc.pb.cc greeter_server.cc -I/usr/local/grpc/include -L/usr/local/lib `pkg-config --libs --static protobuf grpc++ absl_flags absl_flags_parse $PROTOBUF_ABSL_DEPS` -lutf8_validity -pthread -Wl,--no-as-needed -lgrpc++_reflection -Wl,--as-needed -ldl

# 7.使用greeter_client.cc编译客户端程序
$ g++ -o greeter_client helloworld.pb.cc helloworld.grpc.pb.cc greeter_client.cc -I/usr/local/grpc/include -L/usr/local/lib `pkg-config --libs --static protobuf grpc++ absl_flags absl_flags_parse $PROTOBUF_ABSL_DEPS` -lutf8_validity -pthread -Wl,--no-as-needed -lgrpc++_reflection -Wl,--as-needed -ldl

七、Protobuf编译器protoc命令常用参数项

-I …/…/protos：告诉 protoc 在何处查找 .proto 文件。在这种情况下，它将在 …/…/protos 目录中查找
–grpc_out=.：指定生成的 gRPC 服务文件的输出目录。在这种情况下，它们将被生成在当前目录中。
–plugin=protoc-gen-grpc=which grpc_cpp_plugin``：告诉 protoc 使用哪个插件来生成 gRPC 代码。在这种情况下，它使用的是 grpc_cpp_plugin，它是 gRPC C++ 插件。
–cpp_out=.：指定生成的C++代码文件的输出目录。在这种情况下，它们将被生成在当前目录中。