Golang开发gRPC服务入门介绍
作者:波斯马 发布时间:2024-02-14 09:56:20
gRPC是Google发起的一个开源RPC框架,使用HTTP/2传输协议,使用Protocol Buffers编码协议,相比RESTful框架的程序性能提高不少,而且当前流行的编程语言基本都已经支持。
Golang开发gRPC应用程序的套路也已经很清晰,这篇文章就来做一个简单的介绍,算是入门。
1、安装protoc
这个工具也称为proto编译器,可以用来生成各种开发语言使用proto协议的代码。
下载地址:https://github.com/protocolbuffers/protobuf/releases
一般下载最新版本就行,注意要符合自己当前的操作系统。
解压后里边有个 protoc.exe ,拷贝到 GOPATH 的 bin 目录下,我这里就是 C:/Users/PC-001/go/bin ,PC-001 是登录当前操作系统的用户名,需要换成你自己的。GOPATH 可以通过执行 go env 查看到。
一般都是把 GOPATH 的 bin 目录添加到环境变量的 PATH 变量中,如果没有,请自行添加上。
2、安装protoc的Golang gRPC插件
执行如下命令,会在 GOPATH 的 bin 目录下生成两个可执行文件:protoc-gen-go.exe 和 protoc-gen-go-grpc.exe。这两个插件可以用来生成Golang版本的proto协议代码和gRPC代理代码。
go install google.golang.org/protobuf/cmd/protoc-gen-go
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
3、编写proto文件
proto文件是符合Protocol Buffers语言规范的数据交换协议文件,就像以前WebService定义服务时使用的XML文件。现在一般都是用proto3了,这里创建一个名为 hello.proto 的文件,放到项目的proto目录下:
syntax = "proto3";
option go_package="/proto";
package Business;
service Hello {
rpc Say (SayRequest) returns (SayResponse);
}
message SayResponse {
string Message = 1;
message SayRequest {
string Name = 1;
这个协议很简单,有个名字为Hello的服务,提供一个名字为Say的rpc方法,这个方法有输入输出,输入信息中有一个名为Name的参数,输出信息中有一个名为Message的返回值。
4、生成gRPC代理代码
在项目根目录中执行如下命令,会在proto目录下生成两个文件:hello.pb.go 和 hello_grpc.pb.go。
protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative proto/hello.proto
hello.pb.go 中是输入输出数据类型的Golang定义,hello_grpc.pb.go 中是客户端和服务端的gRPC代理类型和方法的Golang定义。
也可以将文件生成到别的目录中,比如修改 proto 文件中 go_package 的配置为:
option go_package="/business";
然后执行下面的命令,会生成到项目下的business目录中:
protoc --go_out=. --go-grpc_out=. proto/hello.proto
具体这个命令还有哪些参数,可以执行 protoc -help 去探索下,这里就不罗嗦了。
5、编写gRPC服务端程序
这里先上代码:
package main
import (
"context"
"fmt"
"grpcdemo/proto"
"net"
"google.golang.org/grpc"
)
type server struct {
proto.UnimplementedHelloServer
}
func (s *server) Say(ctx context.Context, req *proto.SayRequest) (*proto.SayResponse, error) {
fmt.Println("request:", req.Name)
return &proto.SayResponse{Message: "Hello " + req.Name}, nil
func main() {
listen, err := net.Listen("tcp", ":8001")
if err != nil {
fmt.Printf("failed to listen: %v", err)
return
}
s := grpc.NewServer()
proto.RegisterHelloServer(s, &server{})
//reflection.Register(s)
defer func() {
s.Stop()
listen.Close()
}()
fmt.Println("Serving 8001...")
err = s.Serve(listen)
fmt.Printf("failed to serve: %v", err)
整个过程如下:先定义一个名为 server 的类型,它去实现hello_grpc.pb.go中生成的HelloServer接口;然后通过grpc.NewServer创建一个gRPC服务器;然后将server类型的实例注册到这个gRPC服务器;最后让这个gRPC服务器在某个本地网络端口监听上开始接受客户端请求。
代码中注释了一行:reflection.Register(s) 它是注册了一个特殊的service,能让外部获得server中已注册的服务和方法。这对于开发时可能比较有用,具体细节可以看这里:https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md
如果直接粘贴这段代码的话,会有很多包没有引用进来,可以通过 go get 获取这些包,也可以执行命令:go mod tidy 来引入需要的包。
这里边还import了一个 grpcdemo/proto ,这个是我这边项目的mod是grpcdemo,gRPC代理程序的package是proto,如果你的不一样,需要修改下。
6、编写gRPC客户端程序
访问gRPC服务也是通过hello_grpc.pb.go中生成的方法,直接上代码:
package main
import (
"bufio"
"context"
"fmt"
"grpchello/proto"
"os"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
)
func main() {
var serviceHost = "127.0.0.1:8001"
conn, err := grpc.Dial(serviceHost, grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
fmt.Println(err)
}
defer conn.Close()
client := proto.NewHelloClient(conn)
rsp, err := client.Say(context.TODO(), &proto.SayRequest{
Name: "BOSIMA",
})
fmt.Println(rsp)
fmt.Println("按回车键退出程序...")
in := bufio.NewReader(os.Stdin)
_, _, _ = in.ReadLine()
}
上边服务端程序的监听端口指定的 8001,所以这里先创建了一个到 127.0.0.1:8001 的连接;然后使用这个连接创建指定服务的客户端 proto.NewHelloClient(conn) ;然后使用这个客户端调用相应的方法。
hello_grpc.pb.go 已经生成了创建客户端的函数以及调用方法的函数,开发人员直接调用就好了。
7、运行程序
可以使用 go run xxx.go 来编译并运行程序。这里为了方便测试,先使用 go build 将它们编译为exe,然后再双击运行。实际运行效果如下:
来源:https://www.cnblogs.com/bossma/p/16168249.html
猜你喜欢
- 写出能用的代码很简单,写出好用的代码很难。好用的代码,也都会遵循一此原则,这就是设计原则,它们分别是:单一职责原则 (SRP)开闭原则 (O
- 本文实例讲述了Python实现读取txt文件并转换为excel的方法。分享给大家供大家参考,具体如下:这里的txt文件内容格式为:892天平
- Asterisk 是一个开放源代码的软件VoIP PBX系统,我们用Asterisk 搭建企业内部电话系统。Asterisk AMI的Ast
- 工欲善其事,必先利其器.python是解释型的语言,但是在windows下如果要执行程序的话还得加个python shell的话,
- 前言PDO扩展为PHP访问数据库定义了一个轻量级的、一致性的接口,它提供了一个数据访问抽象层,这样,无论使用什么数据库,都可以通过一致的函数
- Sql Server 中一个非常强大的日期格式化函数: 获得当前系统时间,GETDATE(): 2008年01月08日 星期二 14:59
- 本文实例讲述了Python使用中文正则表达式匹配指定中文字符串的方法。分享给大家供大家参考,具体如下:业务场景:从中文字句中匹配出指定的中文
- 下标所谓下标就是编号,就好比超市中存储柜的编号,通过这个编号就能找到相应的存储空间。Python中字符串,列表,元祖均支持下标索引。例如:#
- 关于PEP 8PEP 8,Style Guide forPythonCode,是Python官方推出编码约定,主要是为了保证 Python
- 场景:主库DB:utf8字符集备库DB:gbk字符集需求:校验主备数据是否一致,并且修复校验过程:设置主库连接为utf8,设置备库连接为gb
- 本文实例讲述了Python3写入文件常用方法。分享给大家供大家参考。具体如下:''''' Creat
- 简介Python发送邮件的教程本人在网站搜索的时候搜索出来了一大堆,但是都是说了一大堆原理然后就推出了实现代码,我测试用给出的代码进行发送邮
- 当“ 页面重构工程师 ”这个职位的面试官也蛮长一段时间了,跟前两年比起来,总的来说来应聘的同学能力在很大程度上有了提高,记得两年前的一场招聘
- 需求在某应用中,需要根据一定的规则生成随机的IP地址,规则类似于192.168.11.0/24这样的CIDR形式给出。实现经过艰苦卓绝的调试
- 使用VScode的用户代码片段功能,来生成自己习惯的代码模板,提升开发效率1.选择菜单里的 文件 > 首选项 > 用户代码片段2
- 1. 用grep函数 函数名 grep 调用语法 @foundlist = grep (pattern, @searchlist); 解说
- 业务场景因为项目刚上线,目前暂不打算引入其他中间件,所以打算通过 mysql 来实现分布式读写锁;而该业务场景也满足分布式读写锁的场景,抽象
- 我们可以用动态产生变量的方法,从表格里捕捉数据,动态地创造“剥离”变量引号并且“清理”它,见下列代码,我们只需键入变量名称,选择 query
- 简述小编经常会遇到一些数据库编码不对得问题,好TM头疼,这里做一个记录,供大家参考。修改数据库字符集:ALTER DATABASE db_n
- 在类unix中,是\n (0x0A)。以为没有什么大的问题,没想到,这次开发一个小程序,却让我对这个问题大为头痛。 首先发现这个问题是这样的