开发笔记:gRPCgo入门：HelloWorld

gRPC-go 入门&＃xff08;1&＃xff09;&＃xff1a;Hello World

摘要

在这篇文章中&＃xff0c;主要是跟你介绍一下gRPC这个东西。

然后&＃xff0c;我会创建一个简单的练习项目&＃xff0c;作为gRPC的Hello World项目。

在这个项目中&＃xff0c;只有很简单的一个RPC函数&＃xff0c;用于说明gRPC的工作方式。

此外&＃xff0c;我也会跟你分享一下我初次接触gRPC所遇到的一些坑&＃xff0c;主要是在protocol buffer的proto-gen-go插件上面。

1. 简单介绍

在这一节的内容中&＃xff0c;我将简单的跟你介绍一下gRPC这个东西。 RPC的全称是Remote Procedure Call&＃xff0c;远程过程调用。这是一种协议&＃xff0c;是用来屏蔽分布式计算中的各种调用细节&＃xff0c;使得你可以像是本地调用一样直接调用一个远程的函数。 而gRPC又是什么呢&＃xff1f;用官方的话来说&＃xff1a;

A high-performance, open-source universal RPC framework

gRPC是一个高性能的、开源的通用的RPC框架。

在gRPC中&＃xff0c;我们称调用方为client&＃xff0c;被调用方为server。 跟其他的RPC框架一样&＃xff0c;gRPC也是基于”服务定义“的思想。简单的来讲&＃xff0c;就是我们通过某种方式来描述一个服务&＃xff0c;这种描述方式是语言无关的。在这个”服务定义“的过程中&＃xff0c;我们描述了我们提供的服务服务名是什么&＃xff0c;有哪些方法可以被调用&＃xff0c;这些方法有什么样的入参&＃xff0c;有什么样的回参。

也就是说&＃xff0c;在定义好了这些服务、这些方法之后&＃xff0c;gRPC会屏蔽底层的细节&＃xff0c;client只需要直接调用定义好的方法&＃xff0c;就能拿到预期的返回结果。对于server端来说&＃xff0c;还需要实现我们定义的方法。同样的&＃xff0c;gRPC也会帮我们屏蔽底层的细节&＃xff0c;我们只需要实现所定义的方法的具体逻辑即可。

你可以发现&＃xff0c;在上面的描述过程中&＃xff0c;所谓的”服务定义“&＃xff0c;就跟定义接口的语义是很接近的。我更愿意理解为这是一种”约定“&＃xff0c;双方约定好接口&＃xff0c;然后server实现这个接口&＃xff0c;client调用这个接口的代理对象。至于其他的细节&＃xff0c;交给gRPC。

此外&＃xff0c;gRPC还是语言无关的。你可以用C&＃43;&＃43;作为服务端&＃xff0c;使用Golang、Java等作为客户端。为了实现这一点&＃xff0c;我们在”定义服务“和在编码和解码的过程中&＃xff0c;应该是做到语言无关的。

下面放一张官网上面的图&＃xff1a;

因此&＃xff0c;gRPC使用了Protocol Buffers。

在这里我不会展开来讲Protocol Buffers这个东西&＃xff0c;你可以把他当成一个代码生成工具以及序列化工具。这个工具可以把我们定义的方法&＃xff0c;转换成特定语言的代码。比如你定义了一种类型的参数&＃xff0c;他会帮你转换成Golang中的struct 结构体&＃xff0c;你定义的方法&＃xff0c;他会帮你转换成func 函数。此外&＃xff0c;在发送请求和接受响应的时候&＃xff0c;这个工具还会完成对应的编码和解码工作&＃xff0c;将你即将发送的数据编码成gRPC能够传输的形式&＃xff0c;又或者将即将接收到的数据解码为编程语言能够理解的数据格式。

对gRPC的简单介绍就到这里&＃xff0c;下面的内容我们直接开始实践。

2. 环境配置

在这一节中&＃xff0c;可能很多内容会不那么的适用。

但是限于篇幅&＃xff0c;我没有列举所有的安装方式。如果在安装的过程中你遇到了问题&＃xff0c;可以在网上搜索解决&＃xff0c;也可以在文章末尾找到我的联系方式&＃xff0c;我们一起研究。

2.1 gRPC

go get google.golang.org/grpc


这一步安装的是gRPC的核心库&＃xff0c;但是这一步是需要&＃xff08;特别的上网方式&＃xff09;的。所以如果在安装过程中出错了&＃xff0c;你可以科学一波&＃xff0c;也可以找一找其他的安装方法。

2.2 protocol buffers

在Mac OS中&＃xff0c;直接用brew安装。

brew info protobuf


2.3 protoc-gen-go

上一步安装的是protocol编译器。而上文中我们提到了可以生成各种不同语言的代码。因此&＃xff0c;除了这个编译器&＃xff0c;我们还需要配合各个语言的代码生成工具。

对于Golang来说&＃xff0c;称为protoc-gen-go。

不过在这儿有个小小的坑&＃xff0c;github.com/golang/protobuf/protoc-gen-go和google.golang.org/protobuf/cmd/protoc-gen-go是不同的。

区别在于前者是旧版本&＃xff0c;后者是google接管后的新版本&＃xff0c;他们之间的API是不同的&＃xff0c;也就是说用于生成的命令&＃xff0c;以及生成的文件都是不一样的。

因为目前的gRPC-go源码中的example用的是后者的生成方式&＃xff0c;为了与时俱进&＃xff0c;本文也采取最新的方式。

你需要安装两个库&＃xff1a;

go install google.golang.org/protobuf/cmd/protoc-gen-go
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc


因为这些文件在安装grpc的时候&＃xff0c;已经下载下来了&＃xff0c;因此使用install命令就可以了&＃xff0c;而不需要使用get命令。

然后你看你的$GOPATH路径&＃xff0c;应该有标1和2的两个文件&＃xff1a;

至此&＃xff0c;所有的准备工作已经完成。

3. proto文件创建

在开始开发之前&＃xff0c;先说说我们的目标。

在这个grpc-practice项目中&＃xff0c;我希望实现一个功能&＃xff0c;客户端可以发送消息给服务端&＃xff0c;服务端收到消息后&＃xff0c;返回响应给客户端。

正如前面所说的&＃xff0c;在开发server与client之前&＃xff0c;我们需要先定义服务。

因此&＃xff0c;在这一节的内容中&＃xff0c;我将向你介绍proto文件的编写。

3.1 项目结构

在这之前&＃xff0c;先让我们看看整个项目的初始结构。

server和client我们先不管&＃xff0c;在这一节内容中我们先编写&＃96;*.proto’文件。

在proto文件夹中创建message.proto文件。

在文件的第一行&＃xff0c;我们写上&＃xff1a;

syntax &＃61; "proto3";


这是在说明我们使用的是proto3语法。

然后我们应该写上&＃xff1a;

option go_package &＃61; ".;message";


这部分的内容是关于最后生成的go文件是处在哪个目录哪个包中&＃xff0c;.代表在当前目录生成&＃xff0c;message代表了生成的go文件的包名是message。

然后我们需要定义一个服务&＃xff0c;在这个服务中需要有一个方法&＃xff0c;这个方法可以接受客户端的参数&＃xff0c;再返回服务端的响应。

那么我们可以这么写&＃xff1a;

service MessageSender {
rpc Send(MessageRequest) returns (MessageResponse) {}
}


其实很容易可以看出&＃xff0c;我们定义了一个service&＃xff0c;称为MessageSender&＃xff0c;这个服务中有一个rpc方法&＃xff0c;名为Send。这个方法会发送一个MessageRequest&＃xff0c;然后返回一个MessageResponse。

让我们在看看具体的MessageRequest和MessageResponse&＃xff1a;

message MessageResponse {
string responseSomething &＃61; 1;
}
message MessageRequest {
string saySomething &＃61; 1;
}


message关键字&＃xff0c;其实你可以理解为Golang中的结构体。这里比较特别的是变量后面的“赋值”。注意&＃xff0c;这里并不是赋值&＃xff0c;而是在定义这个变量在这个message中的位置。更具体的内容我应该会在源码分析部分讲到。

在编写完上面的内容后&＃xff0c;在/grpc-practice/src/helloworld/proto目录下执行如下命令&＃xff1a;

protoc --go_out&＃61;. message.proto
protoc --go-grpc_out&＃61;. message.proto


这两条命令会生成如下的两个文件&＃xff1a;

在这两个文件中&＃xff0c;包含了我们定义方法的go语言实现&＃xff0c;也包含了我们定义的请求与相应的go语言实现。

简单来讲&＃xff0c;就是protoc-gen-go已经把你定义的语言无关的message.proto转换为了go语言的代码&＃xff0c;以便server和client直接使用。

注意&＃xff0c;到了这一部分你可能会有一些疑惑。

在网上的一些教程中&＃xff0c;有这样的生成方式&＃xff1a;

protoc --go_out&＃61;plugins&＃61;grpc:. helloworld.proto


这种生成方式&＃xff0c;使用的就是github版本的protoc-gen-go&＃xff0c;而目前这个项目已经由Google接管了。

并且&＃xff0c;如果使用这种生成方式的话&＃xff0c;并不会生成上图中的xxx_grpc.pb.go与xxx.pb.go两个文件&＃xff0c;只会生成xxx.pb.go这种文件。

此外&＃xff0c;你也可能遇到这种错误&＃xff1a;

protoc-gen-go-grpc: program not found or is not executable
Please specify a program using absolute path or make sure the program is available in your PATH system variable
--go-grpc_out: protoc-gen-go-grpc: Plugin failed with status code 1.


这是因为你没有安装protoc-gen-go-grpc这个插件&＃xff0c;这个问题在本文中应该不会出现。

你还可能会遇到这种问题&＃xff1a;

--go_out: protoc-gen-go: plugins are not supported; use &＃39;protoc --go-grpc_out&＃61;...&＃39; to generate gRPC


这是因为你安装的是更新版本的protoc-gen-go&＃xff0c;但是你却用了旧版本的生成命令。

但是这两种方法都是可以完成目标的&＃xff0c;只不过api不太一样。本文是基于Google版本的protoc-gen-go进行示范。

至于其他更详细的资料&＃xff0c;你可以在这里看到&＃xff1a;github.com/protocolbuf…

4. 服务端

4.1 注册

我们在server目录下面创建一个server.go文件。

在main函数中加入如下的代码&＃xff1a;

srv :&＃61; grpc.NewServer()
message.RegisterMessageSenderService(srv, &message.MessageSenderService{})


很容易可以看出&＃xff0c;我们在这一部分创建了一个Server&＃xff0c;然后注册了我们的Service。

在注册函数的第二个参数中&＃xff0c;我们传进去了一个MessageSenderService实例。

来看看这个实例有什么样的结构&＃xff1a;

type MessageSenderService struct {
Send func(context.Context, *MessageRequest) (*MessageResponse, error)
}


可以看出&＃xff0c;这个实例里面有一个方法&＃xff0c;这个方法就是我们定义的send方法。也就是说&＃xff0c;这一部分是需要我们在Server端实现这个send方法的。

因此我们创建这么一个方法&＃xff1a;

func handleSendMessage(ctx context.Context, req *message.MessageRequest) (*message.MessageResponse, error) {
log.Println("receive message:", req.GetSaySomething())
resp :&＃61; &message.MessageResponse{}
resp.ResponseSomething &＃61; "roger that!"
return resp, nil
}


注意&＃xff0c;“实现定义的方法”&＃xff0c;并不是说我们需要创建一个同名的方法&＃xff0c;而是说我们需要创建一个有相同函数签名的方法。也就是说&＃xff0c;需要有相同的入参&＃xff0c;出参。

然后我们将这个方法写进注册函数中&＃xff0c;变成了这样&＃xff1a;

message.RegisterMessageSenderService(srv, &message.MessageSenderService{
Send: handleSendMessage,
})


至此&＃xff0c;我们已经成功的在server端实现了我们声明的方法了。

4.2 监听

其实这个过程跟golang的web服务器是很像的&＃xff0c;也是创建Handler&＃xff0c;然后对端口进行监听。

那么到了这一步也一样。

listener, err :&＃61; net.Listen("tcp", ":12345")
if err !&＃61; nil {
log.Fatalf("failed to listen: %v", err)
}
err &＃61; srv.Serve(listener)
if err !&＃61; nil {
log.Fatalf("failed to serve: %v", err)
}


监听12345端口的TCP连接&＃xff0c;然后启动服务器。

至此&＃xff0c;服务端开发完毕。

5. 客户端

在客户端中&＃xff0c;我们应该先与server端建立连接&＃xff0c;然后才能够调用各种方法。

conn, err :&＃61; grpc.Dial("127.0.0.1:12345", grpc.WithInsecure(), grpc.WithBlock())
if err !&＃61; nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()


以上代码&＃xff0c;就是跟本地的12345端口建立连接。

然后&＃xff0c;按照定义&＃xff0c;我们调用server端的方法&＃xff0c;应该要像调用本地方法一样方便。

那么&＃xff0c;我们这么做&＃xff1a;

client :&＃61; message.NewMessageSenderClient(conn)
resp, err :&＃61; client.Send(context.Background(), &message.MessageRequest{SaySomething: "hello world!"})
if err !&＃61; nil {
log.Fatalf("could not greet: %v", err)
}


很容易可以理解&＃xff0c;我们在本地创建了一个client&＃xff0c;然后直接调用我们之前定义好的Send方法&＃xff0c;就可以实现我们需要的逻辑了。

简单的来讲&＃xff0c;我们在*.proto文件中定义了方法&＃xff0c;然后在server端实现定义的rpc方法的具体逻辑&＃xff0c;在client端调用这个方法。

对于其他的部分&＃xff0c;由proto buffer负责对Golang中存储的数据结构与rpc传输中的数据进行转换&＃xff0c;grpc负责封装所有的逻辑。

server端和client端都跑起来&＃xff0c;你会看到这样的画面&＃xff1a;

至此&＃xff0c;成功Hello了个World。

写在最后

首先&＃xff0c;谢谢你能看到这里&＃xff01;

在这篇文章中&＃xff0c;主要是跟你介绍一下hello world的写法&＃xff0c;以及在say hello的过程中可能遇到的一些坑。

我认为最大的坑是在于protoc-gen-go这个插件这里&＃xff0c;因为两种语法让我迷惑了很久。

如果在这期间&＃xff0c;你还有一些问题没有解决&＃xff0c;欢迎留言&＃xff0c;或者直接公众号找到我&＃xff0c;我们一起研究。