本文为go mod 简单搭建grpc服务demo实践。也记录了其中的一些官方未交待的坑。
总结步骤:
1、下载依赖包gRPC。主要关注底下的protobuf和protol-gen-go包,用于处理协议文件的。
2、下载protoc.exe执行文件,将bin目录配置到环境变量。该文件主要用于执行对.proto协议文件转为.pb.go对应语言文件。
3、安装插件protol-gen-go生成.exe可执行文件(可在依赖包对应目录下直接执行命令生成exe后拷贝出去),放入环境变量中,如刚刚设置的bin目录。
4、项目目录中编写如Hi.proto文件,并cmd进入该目录执行protoc --go_out=plugins=grpc:. Hi.proto命令,将在文件指定的包下生成Hi.pb.go文件(grpc接口协议文件代码)。
5、编写服务端实现协议文件中的结构体接口,客户端调用。
下来就来详细介绍。
一、下载依赖包gRPC
IDE创建项目目录grpcDemo,并配置代理。
然后我们下载依赖包就简单了,直接在项目目录下创建go.mod文件,如下:
然后基本的main.go里面写mian函数,执行命令go mod init。等待下载完,如下:
依赖包我们下完了。
我们打开看一下,能看到这个,
我们要的就是这两个插件,但是这还不算装完,因为protoc-gen-go并没有安装生成exe 文件,这个我们后面再讲。
github.com/golang/protobuf
github.com/golang/protobuf/protoc-gen-go
二、下载protoc.exe执行文件,将bin目录配置到环境变量
这个要自己额外地去下,地址看这里。下载解压将看到如下目录。protoc.exe文件就在bin文件夹下,把bin目录配置到环境变量。可以cmd下执行protoc --version看看是不是装好了。
该文件主要用于执行对.proto协议文件转为.pb.go对应语言文件。当然我们前面还讲到,这样还是不够的,还需要一个插件。
三、安装插件protol-gen-go生成.exe可执行文件
可在依赖包对应目录下直接执行go build命令生成exe后拷贝出去,放入环境变量中,如刚刚设置的bin目录和protoc.exe文件放一起(这里为图方便),当然也可以自行存在路径,然后把路径配置到环境变量即可。
四、编写如Hi.proto协议文件,并用命令转成对应语言(协议)文件
上面,我们把插件的工具都准备好了,意味着我们可以执行命令来处理协议文件了。
在项目目录中编写如Hi.proto文件,并cmd进入该目录执行protoc --go_out=plugins=grpc:. Hi.proto命令(注意这里IDE直接执行这个命令是不行的),将在文件指定的包下生成Hi.pb.go文件(grpc接口协议文件代码)。 这里的--go_out 必须protol-gen-go.exe的支持。
这里指定的包名就是将生成协议文件的文件夹。执行完命令后看到的文件:
五、编写服务端代码
实现协议中的接口,提供逻辑服务。
main文件自然必不可少。
我们启动服务端,监听8081端口。这里需要注意,如果直接run go build main.go有可能不成功。go build 整个项目倒是每次都成功的。
六、编写客户端
客户端和服务端也一样的先创建项目,go mod grpc依赖包。只是客户端可以直接使用.pd.go文件,所以不用处理协议生成这个动作(装插件和写.proto文件后命名转换)。直接拷贝Hi.pb.go文件,然后实现客户端的调用代码即可。其他注意点同上(必须go build 整个项目)。然后我们启动客户端就可以看到服务端的应答了。
好了,一个GRPC服务就写好了。