RPC 系列(二):Go gRPC 环境安装

在开始编写 gRPC 应用之前,需要先安装 protoc 编译器以及 Go 语言相关的依赖包。本篇介绍环境搭建的完整过程。

安装 protoc

根据自身电脑的操作系统,选择 protoc 最新的 releases 版本下载。

protoc 的 releases 下载列表,包含各平台的安装包,图中选中 protoc-3.11.4-win64.zip

解压后在 bin 目录找到 protoc.exe,然后把它复制到 GOBIN 目录下。

提示:一般操作是把 protoc.exe 所在的目录配到环境变量里,这里直接把 protoc.exe 复制到 GOBIN 目录下,前提是环境变量已经配置了 GOBIN 环境变量。

打开 cmd,运行 protoc --version,成功打印当前版本信息证明安装成功了。

安装相关包

安装 golang 的 proto 工具包:

go get -u github.com/golang/protobuf/proto

安装 golang 的 proto 编译支持:

go get -u github.com/golang/protobuf/protoc-gen-go

安装 gRPC 包:

go get -u google.golang.org/grpc

创建并编译 proto 文件

  1. 新建 proto 文件夹,在里面新建 simple.proto 文件:
syntax = "proto3"; // 协议为proto3

package proto;

// 定义发送请求信息
message SimpleRequest{
    // 定义发送的参数
    // 参数类型 参数名 标识号(不可重复)
    string data = 1;
}

// 定义响应信息
message SimpleResponse{
    // 定义接收的参数
    // 参数类型 参数名 标识号(不可重复)
    int32 code = 1;
    string value = 2;
}

// 定义我们的服务(可定义多个服务,每个服务可定义多个接口)
service Simple{
    rpc Route (SimpleRequest) returns (SimpleResponse){};
}
  1. 编译 proto 文件

cmd 进入 simple.proto 所在目录,运行以下指令进行编译:

protoc --go_out=plugins=grpc:./ ./simple.proto

VSCode-proto3 插件介绍

如果使用 VSCode,可以安装 vscode-proto3 插件,方便编辑和编译 proto 文件。插件的配置如下:

// vscode-proto3插件配置
"protoc": {
    // protoc.exe所在目录
    "path": "C:\\Go\\bin\\protoc.exe",
    // 保存时自动编译
    "compile_on_save": true,
    "options": [
        // go编译输出指令
        "--go_out=plugins=grpc:."
    ]
}

每次编辑完 proto 文件后,只需要保存,它就会自动帮助完成编译。而且代码有高亮显示,代码自动补全,代码格式化等功能。

VSCode 中编辑 simple.proto 文件的效果:proto3 插件提供代码高亮与自动补全,保存后自动编译

环境搭建完成后,下一篇就可以编写第一个简单 RPC 的示例了。

系列导航


   转载规则


《RPC 系列(二):Go gRPC 环境安装》 由 吴杭沉 采用 知识共享署名 4.0 国际许可协议 进行许可。
 上一篇
RPC 系列(三):Go gRPC 简单 RPC RPC 系列(三):Go gRPC 简单 RPC
gRPC 主要有 4 种请求/响应模式,分别是简单模式(Simple RPC)、服务端流式(Server-side streaming RPC)、客户端流式(Client-side streaming RPC)和双向流式(Bidirecti
2023-09-19
下一篇 
RPC 系列(一):RPC 与 gRPC 全景 RPC 系列(一):RPC 与 gRPC 全景
在分布式系统开发中,进程之间经常需要通过网络进行远程通信,RPC 就是让这一过程像调用本地函数一样简单的技术。本文先梳理 RPC 的基本原理,再对 gRPC 框架做整体介绍,最后演示如何编译 gRPC 源码,并用 C++ 跑通一个简单的登录
2023-09-05
  目录