Featured image of post Go gRPC 配置环境与运行Demo

Go gRPC 配置环境与运行Demo

快速上手Go语言gRPC框架 包括配置环境与运行Demo程序

系统环境:ARM+MacOS+zsh+GoLand+Go1.18

本篇笔记仅介绍如何安装gRPC环境,并运行官方提供的hello world demo程序。
不会对protobuf语法进行介绍

安装 Protocol buffers 相关程序

gRPC 是一个基于 Protocol Buffers 的 RPC 应用程序框架
因此,我们需要先安装 Protocol Buffers 相关程序。

配置环境变量

确保环境变量PATH中配置了$GOPATH/bin目录
否则再后续生成的步骤中会出现找不到命令的问题
~/.zshrc中增加一行(具体位置根据你的GOPATH进行调整):
export PATH=$PATH:$GOPATH/bin

安装 protobuf compiler

MacOS使用brew安装protoc
brew install protobuf
验证protoc是否安装成功
protoc --version

1
libprotoc 3.19.4

安装 protocal compiler for Go plugin

该插件用于生成Go代码
会被安装在$GOPATH/bin目录下

1
2
go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]

gRPC DEMO

获取DEMO程序

官方的DEMO程序可以在这个链接获得
git clone https://github.com/grpc/grpc-go.git
在Goland中打开grpc-go/examples/helloworld目录
注意:该目录下有一个与根目录同名helloworld目录
本文所有指令均不在该子目录执行

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
➜  helloworld git:(master) tree
.
├── greeter_client
│   └── main.go
├── greeter_server
│   └── main.go
└── helloworld #本文所有命令均不在该目录下运行
    ├── helloworld.pb.go #为了演示生成功能 将该文件删除
    ├── helloworld.proto
    └── helloworld_grpc.pb.go #为了演示生成功能 将该文件删除

3 directories, 5 files

go moule配置

运行go mod init helloworld生成go模块文件

1
2
3
4
5
6
7
8
9
➜  helloworld git:(master) ✗ tree
.
├── go.mod #go模块文件
├── greeter_client
│   └── main.go
├── greeter_server
│   └── main.go
└── helloworld
    └── helloworld.proto

运行go get google.golang.org/grpc获取gRPC相关依赖

1
2
3
4
5
6
7
8
➜  helloworld git:(master) ✗ go get google.golang.org/grpc                                                                 
go: added github.com/golang/protobuf v1.5.2
go: added golang.org/x/net v0.0.0-20201021035429-f5854403a974
go: added golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4
go: added golang.org/x/text v0.3.3
go: added google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013
go: added google.golang.org/grpc v1.46.2
go: added google.golang.org/protobuf v1.27.1

根据proto文件生成代码

在当前目录运行下述命令

1
2
3
protoc --go_out=. --go_opt=paths=source_relative \
    --go-grpc_out=. --go-grpc_opt=paths=source_relative \
    helloworld/helloworld.proto

将会自动生成
helloworld/helloworld.pb.go
helloworld/helloworld_grpc.pb.go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
➜  helloworld git:(master) tree
.
├── greeter_client
│   └── main.go
├── greeter_server
│   └── main.go
└── helloworld #本文所有命令均不在该目录下运行
    ├── helloworld.pb.go #重新生成的.go文件
    ├── helloworld.proto
    └── helloworld_grpc.pb.go #重新生成的.go文件

3 directories, 5 files

修改client与server的代码

由于目前是以helloworld作为模块名
接下来我们需要对两个main.go文件进行一些修改

greeter_client/main.go

1
2
3
4
5
6
7
8
9
import (
    ...
    pb "google.golang.org/grpc/examples/helloworld/helloworld"
)
修改为
import (
    ...
    pb "helloworld/helloworld"
)

greeter_server/main.go

1
2
3
4
5
6
7
8
9
import (
    ...
    pb "google.golang.org/grpc/examples/helloworld/helloworld"
)
修改为
import (
    ...
    pb "helloworld/helloworld"
)

运行DEMO程序

启动Server
go run greeter_server/main.go --port 8888

1
2
➜  helloworld git:(master) ✗ go run greeter_server/main.go --port 8888
2022/05/31 13:39:31 server listening at [::]:8888

启动Client
go run greeter_client/main.go --addr=localhost:8888 --name=akkia

1
2
➜  helloworld git:(master) ✗ go run greeter_client/main.go --addr=localhost:8888 --name=akkia
2022/05/31 13:40:04 Greeting: Hello akkia

此时Server端Log输出

1
2022/05/31 13:40:04 Received: akkia

goland

Licensed under CC BY-NC-SA 4.0
comments powered by Disqus
Built with Hugo
主题 StackJimmy 设计