You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

483 lines
20 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 13 | API 风格RPC API介绍
你好我是孔令飞。这一讲我们继续来看下如何设计应用的API风格。
上一讲我介绍了REST API风格这一讲我来介绍下另外一种常用的API风格RPC。在Go项目开发中如果业务对性能要求比较高并且需要提供给多种编程语言调用这时候就可以考虑使用RPC API接口。RPC在Go项目开发中用得也非常多需要我们认真掌握。
## RPC介绍
根据维基百科的定义RPCRemote Procedure Call即远程过程调用是一个计算机通信协议。该协议允许运行于一台计算机的程序调用另一台计算机的子程序而程序员不用额外地为这个交互作用编程。
通俗来讲就是服务端实现了一个函数客户端使用RPC框架提供的接口像调用本地函数一样调用这个函数并获取返回值。RPC屏蔽了底层的网络通信细节使得开发人员无需关注网络编程的细节可以将更多的时间和精力放在业务逻辑本身的实现上从而提高开发效率。
RPC的调用过程如下图所示
![](https://static001.geekbang.org/resource/image/98/1d/984yy094616b9b24193b22a1f2f2271d.png?wh=2521x1671)
RPC调用具体流程如下
1. Client通过本地调用调用Client Stub。
2. Client Stub将参数打包也叫Marshalling成一个消息然后发送这个消息。
3. Client所在的OS将消息发送给Server。
4. Server端接收到消息后将消息传递给Server Stub。
5. Server Stub将消息解包也叫 Unmarshalling得到参数。
6. Server Stub调用服务端的子程序函数处理完后将最终结果按照相反的步骤返回给 Client。
这里需要注意Stub负责调用参数和返回值的流化serialization、参数的打包和解包以及网络层的通信。Client端一般叫StubServer端一般叫Skeleton。
目前业界有很多优秀的RPC协议例如腾讯的Tars、阿里的Dubbo、微博的Motan、Facebook的Thrift、RPCX等等。但使用最多的还是[gRPC](https://github.com/grpc/grpc-go)这也是本专栏所采用的RPC框架所以接下来我会重点介绍gRPC框架。
## gRPC介绍
gRPC是由Google开发的高性能、开源、跨多种编程语言的通用RPC框架基于HTTP 2.0协议开发默认采用Protocol Buffers数据序列化协议。gRPC具有如下特性
* 支持多种语言,例如 Go、Java、C、C++、C#、Node.js、PHP、Python、Ruby等。
* 基于IDLInterface Definition Language文件定义服务通过proto3工具生成指定语言的数据结构、服务端接口以及客户端Stub。通过这种方式也可以将服务端和客户端解耦使客户端和服务端可以并行开发。
* 通信协议基于标准的HTTP/2设计支持双向流、消息头压缩、单TCP的多路复用、服务端推送等特性。
* 支持Protobuf和JSON序列化数据格式。Protobuf是一种语言无关的高性能序列化框架可以减少网络传输流量提高通信效率。
这里要注意的是gRPC的全称不是golang Remote Procedure Call而是google Remote Procedure Call。
gRPC的调用如下图所示
![](https://static001.geekbang.org/resource/image/01/09/01ac424c7c1d64f678e1218827bc0109.png?wh=2079x1025)
在gRPC中客户端可以直接调用部署在不同机器上的gRPC服务所提供的方法调用远端的gRPC方法就像调用本地的方法一样非常简单方便通过gRPC调用**,我们可以非常容易地构建出一个分布式应用。**
像很多其他的RPC服务一样gRPC也是通过IDL语言预先定义好接口接口的名字、传入参数和返回参数等。在服务端gRPC服务实现我们所定义的接口。在客户端gRPC存根提供了跟服务端相同的方法。
gRPC支持多种语言比如我们可以用Go语言实现gRPC服务并通过Java语言客户端调用gRPC服务所提供的方法。通过多语言支持我们编写的gRPC服务能满足客户端多语言的需求。
gRPC API接口通常使用的数据传输格式是Protocol Buffers。接下来我们就一起了解下Protocol Buffers。
## Protocol Buffers介绍
Protocol BuffersProtocolBuffer/ protobuf是Google开发的一套对数据结构进行序列化的方法可用作数据通信协议、数据存储格式等也是一种更加灵活、高效的数据格式与XML、JSON类似。它的传输性能非常好所以常被用在一些对数据传输性能要求比较高的系统中作为数据传输格式。Protocol Buffers的主要特性有下面这几个。
* 更快的数据传输速度protobuf在传输时会将数据序列化为二进制数据和XML、JSON的文本传输格式相比这可以节省大量的IO操作从而提高数据传输速度。
* 跨平台多语言protobuf自带的编译工具 protoc 可以基于protobuf定义文件编译出不同语言的客户端或者服务端供程序直接调用因此可以满足多语言需求的场景。
* 具有非常好的扩展性和兼容性,可以更新已有的数据结构,而不破坏和影响原有的程序。
* 基于IDL文件定义服务通过proto3工具生成指定语言的数据结构、服务端和客户端接口。
在gRPC的框架中Protocol Buffers主要有三个作用。
**第一,可以用来定义数据结构。**举个例子下面的代码定义了一个SecretInfo数据结构
```
// SecretInfo contains secret details.
message SecretInfo {
string name = 1;
string secret_id = 2;
string username = 3;
string secret_key = 4;
int64 expires = 5;
string description = 6;
string created_at = 7;
string updated_at = 8;
}
```
**第二,可以用来定义服务接口。**下面的代码定义了一个Cache服务服务包含了ListSecrets和ListPolicies 两个API接口。
```
// Cache implements a cache rpc service.
service Cache{
rpc ListSecrets(ListSecretsRequest) returns (ListSecretsResponse) {}
rpc ListPolicies(ListPoliciesRequest) returns (ListPoliciesResponse) {}
}
```
**第三可以通过protobuf序列化和反序列化提升传输效率。**
## gRPC示例
我们已经对gRPC这一通用RPC框架有了一定的了解但是你可能还不清楚怎么使用gRPC编写API接口。接下来我就通过gRPC官方的一个示例来快速给大家展示下。运行本示例需要在Linux服务器上安装Go编译器、Protocol buffer编译器protocv3和 protoc 的Go语言插件在 [**02讲**](https://time.geekbang.org/column/article/378076) 中我们已经安装过,这里不再讲具体的安装方法。
这个示例分为下面几个步骤:
1. 定义gRPC服务。
2. 生成客户端和服务器代码。
3. 实现gRPC服务。
4. 实现gRPC客户端。
示例代码存放在[gopractise-demo/apistyle/greeter](https://github.com/marmotedu/gopractise-demo/tree/main/apistyle/greeter)目录下。代码结构如下:
```
$ tree
├── client
│ └── main.go
├── helloworld
│ ├── helloworld.pb.go
│ └── helloworld.proto
└── server
└── main.go
```
client目录存放Client端的代码helloworld目录用来存放服务的IDL定义server目录用来存放Server端的代码。
下面我具体介绍下这个示例的四个步骤。
1. 定义gRPC服务。
首先需要定义我们的服务。进入helloworld目录新建文件helloworld.proto
```
$ cd helloworld
$ vi helloworld.proto
```
内容如下:
```
syntax = "proto3";
option go_package = "github.com/marmotedu/gopractise-demo/apistyle/greeter/helloworld";
package helloworld;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
```
在helloworld.proto定义文件中option关键字用来对.proto文件进行一些设置其中go\_package是必需的设置而且go\_package的值必须是包导入的路径。package关键字指定生成的.pb.go文件所在的包名。我们通过service关键字定义服务然后再指定该服务拥有的RPC方法并定义方法的请求和返回的结构体类型
```
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
```
gRPC支持定义4种类型的服务方法分别是简单模式、服务端数据流模式、客户端数据流模式和双向数据流模式。
* 简单模式Simple RPC是最简单的gRPC模式。客户端发起一次请求服务端响应一个数据。定义格式为rpc SayHello (HelloRequest) returns (HelloReply) {}。
* 服务端数据流模式Server-side streaming RPC客户端发送一个请求服务器返回数据流响应客户端从流中读取数据直到为空。定义格式为rpc SayHello (HelloRequest) returns (stream HelloReply) {}。
* 客户端数据流模式Client-side streaming RPC客户端将消息以流的方式发送给服务器服务器全部处理完成之后返回一次响应。定义格式为rpc SayHello (stream HelloRequest) returns (HelloReply) {}。
* 双向数据流模式Bidirectional streaming RPC客户端和服务端都可以向对方发送数据流这个时候双方的数据可以同时互相发送也就是可以实现实时交互RPC框架原理。定义格式为rpc SayHello (stream HelloRequest) returns (stream HelloReply) {}。
本示例使用了简单模式。.proto文件也包含了Protocol Buffers 消息的定义,包括请求消息和返回消息。例如请求消息:
```
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
```
2. 生成客户端和服务器代码。
接下来,我们需要根据.proto服务定义生成gRPC客户端和服务器接口。我们可以使用protoc编译工具并指定使用其Go语言插件来生成
```
$ protoc -I. --go_out=plugins=grpc:$GOPATH/src helloworld.proto
$ ls
helloworld.pb.go helloworld.proto
```
你可以看到新增了一个helloworld.pb.go文件。
3. 实现gRPC服务。
接着我们就可以实现gRPC服务了。进入server目录新建main.go文件
```
$ cd ../server
$ vi main.go
```
main.go内容如下
```
// Package main implements a server for Greeter service.
package main
import (
"context"
"log"
"net"
pb "github.com/marmotedu/gopractise-demo/apistyle/greeter/helloworld"
"google.golang.org/grpc"
)
const (
port = ":50051"
)
// server is used to implement helloworld.GreeterServer.
type server struct {
pb.UnimplementedGreeterServer
}
// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
log.Printf("Received: %v", in.GetName())
return &pb.HelloReply{Message: "Hello " + in.GetName()}, nil
}
func main() {
lis, err := net.Listen("tcp", port)
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
s := grpc.NewServer()
pb.RegisterGreeterServer(s, &server{})
if err := s.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
}
```
上面的代码实现了我们上一步根据服务定义生成的Go接口。
我们先定义了一个Go结构体server并为server结构体添加`SayHello(context.Context, pb.HelloRequest) (pb.HelloReply, error)`方法也就是说server是GreeterServer接口位于helloworld.pb.go文件中的一个实现。
在我们实现了gRPC服务所定义的方法之后就可以通过 `net.Listen(...)` 指定监听客户端请求的端口;接着,通过 `grpc.NewServer()` 创建一个gRPC Server实例并通过 `pb.RegisterGreeterServer(s, &server{})` 将该服务注册到gRPC框架中最后通过 `s.Serve(lis)` 启动gRPC服务。
创建完main.go文件后在当前目录下执行 `go run main.go` 启动gRPC服务。
4. 实现gRPC客户端。
打开一个新的Linux终端进入client目录新建main.go文件
```
$ cd ../client
$ vi main.go
```
main.go内容如下
```
// Package main implements a client for Greeter service.
package main
import (
"context"
"log"
"os"
"time"
pb "github.com/marmotedu/gopractise-demo/apistyle/greeter/helloworld"
"google.golang.org/grpc"
)
const (
address = "localhost:50051"
defaultName = "world"
)
func main() {
// Set up a connection to the server.
conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock())
if err != nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()
c := pb.NewGreeterClient(conn)
// Contact the server and print out its response.
name := defaultName
if len(os.Args) > 1 {
name = os.Args[1]
}
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
r, err := c.SayHello(ctx, &pb.HelloRequest{Name: name})
if err != nil {
log.Fatalf("could not greet: %v", err)
}
log.Printf("Greeting: %s", r.Message)
}
```
在上面的代码中我们通过如下代码创建了一个gRPC连接用来跟服务端进行通信
```
// Set up a connection to the server.
conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock())
if err != nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()
```
在创建连接时我们可以指定不同的选项用来控制创建连接的方式例如grpc.WithInsecure()、grpc.WithBlock()等。gRPC支持很多选项更多的选项可以参考grpc仓库下[dialoptions.go](https://github.com/grpc/grpc-go/blob/v1.37.0/dialoptions.go)文件中以With开头的函数。
连接建立起来之后我们需要创建一个客户端stub用来执行RPC请求`c := pb.NewGreeterClient(conn)`。创建完成之后,我们就可以像调用本地函数一样,调用远程的方法了。例如,下面一段代码通过 `c.SayHello` 这种本地式调用方式调用了远端的SayHello接口
```
r, err := c.SayHello(ctx, &pb.HelloRequest{Name: name})
if err != nil {
log.Fatalf("could not greet: %v", err)
}
log.Printf("Greeting: %s", r.Message)
```
从上面的调用格式中我们可以看到RPC调用具有下面两个特点。
* 调用方便RPC屏蔽了底层的网络通信细节使得调用RPC就像调用本地方法一样方便调用方式跟大家所熟知的调用类的方法一致`ClassName.ClassFuc(params)`。
* 不需要打包和解包RPC调用的入参和返回的结果都是Go的结构体不需要对传入参数进行打包操作也不需要对返回参数进行解包操作简化了调用步骤。
最后创建完main.go文件后在当前目录下执行go run main.go发起RPC调用
```
$ go run main.go
2020/10/17 07:55:00 Greeting: Hello world
```
至此我们用四个步骤创建并调用了一个gRPC服务。接下来我再给大家讲解一个在具体场景中的注意事项。
在做服务开发时我们经常会遇到一种场景定义一个接口接口会通过判断是否传入某个参数决定接口行为。例如我们想提供一个GetUser接口期望GetUser接口在传入username参数时根据username查询用户的信息如果没有传入username则默认根据userId查询用户信息。
这时候我们需要判断客户端有没有传入username参数。我们不能根据username是否为空值来判断因为我们不能区分客户端传的是空值还是没有传username参数。这是由Go语言的语法特性决定的如果客户端没有传入username参数Go会默认赋值为所在类型的零值而字符串类型的零值就是空字符串。
那我们怎么判断客户端有没有传入username参数呢最好的方法是通过指针来判断如果是nil指针就说明没有传入非nil指针就说明传入具体实现步骤如下
1. 编写protobuf定义文件。
新建user.proto文件内容如下:
```
syntax = "proto3";
package proto;
option go_package = "github.com/marmotedu/gopractise-demo/protobuf/user";
//go:generate protoc -I. --experimental_allow_proto3_optional --go_out=plugins=grpc:.
service User {
rpc GetUser(GetUserRequest) returns (GetUserResponse) {}
}
message GetUserRequest {
string class = 1;
optional string username = 2;
optional string user_id = 3;
}
message GetUserResponse {
string class = 1;
string user_id = 2;
string username = 3;
string address = 4;
string sex = 5;
string phone = 6;
}
```
你需要注意,这里我们在需要设置为可选字段的前面添加了**optional**标识。
2. 使用protoc工具编译protobuf文件。
在执行protoc命令时需要传入`--experimental_allow_proto3_optional`参数以打开**optional**选项,编译命令如下:
```
$ protoc --experimental_allow_proto3_optional --go_out=plugins=grpc:. user.proto
```
上述编译命令会生成user.pb.go文件其中的GetUserRequest结构体定义如下
```
type GetUserRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Class string `protobuf:"bytes,1,opt,name=class,proto3" json:"class,omitempty"`
Username *string `protobuf:"bytes,2,opt,name=username,proto3,oneof" json:"username,omitempty"`
UserId *string `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3,oneof" json:"user_id,omitempty"`
}
```
通过 `optional` + `--experimental_allow_proto3_optional` 组合,我们可以将一个字段编译为指针类型。
3. 编写gRPC接口实现。
新建一个user.go文件内容如下
```
package user
import (
"context"
pb "github.com/marmotedu/api/proto/apiserver/v1"
"github.com/marmotedu/iam/internal/apiserver/store"
)
type User struct {
}
func (c *User) GetUser(ctx context.Context, r *pb.GetUserRequest) (*pb.GetUserResponse, error) {
if r.Username != nil {
return store.Client().Users().GetUserByName(r.Class, r.Username)
}
return store.Client().Users().GetUserByID(r.Class, r.UserId)
}
```
总之在GetUser方法中我们可以通过判断r.Username是否为nil来判断客户端是否传入了Username参数。
## RESTful VS gRPC
到这里今天我们已经介绍完了gRPC API。回想一下我们昨天学习的RESTful API你可能想问这两种API风格分别有什么优缺点适用于什么场景呢我把这个问题的答案放在了下面这张表中你可以对照着它根据自己的需求在实际应用时进行选择。
![](https://static001.geekbang.org/resource/image/e6/ab/e6ae61fc4b0fc821f94d257239f332ab.png?wh=1483x1026)
当然更多的时候RESTful API 和gRPC API是一种合作的关系对内业务使用gRPC API对外业务使用RESTful API如下图所示
![](https://static001.geekbang.org/resource/image/47/18/471ac923d2eaeca8fe13cb74731c1318.png?wh=1606x1144)
## 总结
在Go项目开发中我们可以选择使用 RESTful API 风格和 RPC API 风格这两种服务都用得很多。其中RESTful API风格因为规范、易理解、易用所以**适合用在需要对外提供API接口的场景中**。而RPC API因为性能比较高、调用方便**更适合用在内部业务中**。
RESTful API使用的是HTTP协议而RPC API使用的是RPC协议。目前有很多RPC协议可供你选择而我推荐你使用gRPC因为它很轻量同时性能很高、很稳定是一个优秀的RPC框架。所以目前业界用的最多的还是gRPC协议腾讯、阿里等大厂内部很多核心的线上服务用的就是gRPC。
除了使用gRPC协议在进行Go项目开发前你也可以了解业界一些其他的优秀Go RPC框架比如腾讯的tars-go、阿里的dubbo-go、Facebook的thrift、rpcx等你可以在项目开发之前一并调研根据实际情况进行选择。
## 课后练习
1. 使用gRPC包快速实现一个RPC API服务并实现PrintHello接口该接口会返回“Hello World”字符串。
2. 请你思考这个场景你有一个gRPC服务但是却希望该服务同时也能提供RESTful API接口这该如何实现
期待在留言区看到你的思考和答案也欢迎和我一起探讨关于RPC API相关的问题我们下一讲见