gRPC快速入门

RPC算是近些年比较火热的概念了，随着微服务架构的兴起，RPC的应用越来越广泛。本文介绍了RPC和gRPC的相关概念，并且通过详细的代码示例介绍了gRPC的基本使用。

RPC是什么

在分布式计算，远程过程调用（英语：Remote Procedure Call，缩写为 RPC）是一个计算机通信协议。该协议允许运行于一台计算机的程序调用另一个地址空间（通常为一个开放网络的一台计算机）的子程序，而程序员就像调用本地程序一样，无需额外地为这个交互作用编程（无需关注细节）。RPC是一种服务器-客户端（Client/Server）模式，经典实现是一个通过发送请求-接受回应进行信息交互的系统。

gRPC是什么

gRPC是一种现代化开源的高性能RPC框架，能够运行于任意环境之中。最初由谷歌进行开发。它使用HTTP/2作为传输协议。

快速了解HTTP/2就戳HTTP/2相比HTTP/1.x有哪些重大改进？

在gRPC里，客户端可以像调用本地方法一样直接调用其他机器上的服务端应用程序的方法，帮助你更容易创建分布式应用程序和服务。与许多RPC系统一样，gRPC是基于定义一个服务，指定一个可以远程调用的带有参数和返回类型的的方法。在服务端程序中实现这个接口并且运行gRPC服务处理客户端调用。在客户端，有一个stub提供和服务端相同的方法。 grpc

为什么要用gRPC

使用gRPC，我们可以一次性的在一个.proto文件中定义服务并使用任何支持它的语言去实现客户端和服务端，反过来，它们可以应用在各种场景中，从Google的服务器到你自己的平板电脑—— gRPC帮你解决了不同语言及环境间通信的复杂性。使用protocol buffers还能获得其他好处，包括高效的序列号，简单的IDL以及容易进行接口更新。总之一句话，使用gRPC能让我们更容易编写跨语言的分布式代码。

安装gRPC

go get -u google.golang.org/grpc

安装Protocol Buffers v3

安装用于生成gRPC服务代码的协议编译器，最简单的方法是从下面的链接：https://github.com/google/protobuf/releases下载适合你平台的预编译好的二进制文件（protoc-<version>-<platform>.zip）。

适用Windows 64位protoc-3.20.1-win64.zip
适用于Mac Intel 64位protoc-3.20.1-osx-x86_64.zip
适用于Mac ARM 64位protoc-3.20.1-osx-aarch_64.zip
适用于Linux 64位protoc-3.20.1-linux-x86_64.zip

例如，我使用 Intel 芯片的 Mac 系统则下载 protoc-3.20.1-osx-x86_64.zip 文件，解压之后得到如下内容。

protoc

其中：

bin 目录下的 protoc 是可执行文件。
include 目录下的是 google 定义的.proto文件，我们import "google/protobuf/timestamp.proto"就是从此处导入。

我们需要将下载得到的可执行文件protoc所在的 bin 目录加到我们电脑的环境变量中。

安装插件

因为本文我们是使用Go语言做开发，接下来执行下面的命令安装protoc的Go插件：

安装go语言插件：

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28

安装grpc插件：

go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

上述命令会默认将插件安装到$GOPATH/bin，为了protoc编译器能找到这些插件，请确保你的$GOPATH/bin在环境变量中。

protocol-buffers 官方Go教程

检查

依次执行以下命令检查一下是否开发环境都准备完毕。

确认 protoc 安装完成。
```
❯ protoc --version
libprotoc 3.20.1
```

确认 protoc-gen-go 安装完成。

❯ protoc-gen-go --version
protoc-gen-go v1.28.0

确认 protoc-gen-go-grpc 安装完成。

❯ protoc-gen-go-grpc --version
protoc-gen-go-grpc 1.2.0

gRPC开发分三步

把大象放进冰箱分几步？

把冰箱门打开。
把大象放进去。
把冰箱门带上。

gRPC开发同样分三步：

编写.proto文件，生成指定语言源代码。
编写服务端代码
编写客户端代码

gRPC入门示例

编写proto代码

Protocol Buffers是一种与语言无关，平台无关的可扩展机制，用于序列化结构化数据。使用Protocol Buffers可以一次定义结构化的数据，然后可以使用特殊生成的源代码轻松地在各种数据流中使用各种语言编写和读取结构化数据。

关于Protocol Buffers的教程可以自行在网上搜索，本文默认读者熟悉Protocol Buffers。

syntax = "proto3"; // 版本声明，使用Protocol Buffers v3版本

option go_package = "xx";  // 指定go package名称；xx根据需要替换

package pb; // 包名


// 定义一个打招呼服务
service Greeter {
    // SayHello 方法
    rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// 包含人名的一个请求消息
message HelloRequest {
    string name = 1;
}

// 包含问候语的响应消息
message HelloReply {
    string message = 1;
}

编写Server端Go代码

我们新建一个hello_server项目，在项目根目录下执行go mod init hello_server。

再新建一个pb文件夹，将上面的 proto 文件保存为hello.proto，将go_package按如下方式修改。

// ...

option go_package = "hello_server/pb";

// ...

此时，项目的目录结构为：

hello_server
├── go.mod
├── go.sum
├── main.go
└── pb
    └── hello.proto

在项目根目录下执行以下命令，根据hello.proto生成 go 源码文件。

protoc --go_out=. --go_opt=paths=source_relative \
    --go-grpc_out=. --go-grpc_opt=paths=source_relative \
    pb/hello.proto

生成后的go源码文件会保存在pb文件夹下。

hello_server
├── go.mod
├── go.sum
├── main.go
└── pb
    ├── hello.pb.go
    ├── hello.proto
    └── hello_grpc.pb.go

将下面的内容添加到hello_server/main.go中。

package main

import (
	"context"
	"fmt"
	"hello_server/pb"
	"net"

	"google.golang.org/grpc"
	"google.golang.org/grpc/reflection"
)

// server

type server struct {
	pb.UnimplementedGreeterServer
}

func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
	return &pb.HelloReply{Message: "Hello " + in.Name}, nil
}

func main() {
	// 监听本地的8972端口
	lis, err := net.Listen("tcp", ":8972")
	if err != nil {
		fmt.Printf("failed to listen: %v", err)
		return
	}
	s := grpc.NewServer()                  // 创建gRPC服务器
	pb.RegisterGreeterServer(s, &server{}) // 在gRPC服务端注册服务

	reflection.Register(s) //在给定的gRPC服务器上注册服务器反射服务
	// Serve方法在lis上接受传入连接，为每个连接创建一个ServerTransport和server的goroutine。
	// 该goroutine读取gRPC请求，然后调用已注册的处理程序来响应它们。
	err = s.Serve(lis)
	if err != nil {
		fmt.Printf("failed to serve: %v", err)
		return
	}
}

编译并执行 http_server：

go build
./server

编写Client端Go代码

我们新建一个hello_client项目，在项目根目录下执行go mod init hello_client。

再新建一个pb文件夹，将上面的 proto 文件保存为hello.proto，将go_package按如下方式修改。

// ...

option go_package = "hello_client/pb";

// ...

在项目根目录下执行以下命令，根据hello.proto在http_client项目下生成 go 源码文件。

protoc --go_out=. --go_opt=paths=source_relative \
    --go-grpc_out=. --go-grpc_opt=paths=source_relative \
    pb/hello.proto

此时，项目的目录结构为：

http_client
├── go.mod
├── go.sum
├── main.go
└── pb
    ├── hello.pb.go
    ├── hello.proto
    └── hello_grpc.pb.go

在http_client/main.go文件中按下面的代码调用http_server提供的 SayHello RPC服务。

package main

import (
	"context"
	"flag"
	"log"
	"time"

	"hello_client/pb"

	"google.golang.org/grpc"
)

// hello_client

const (
	defaultName = "world"
)

var (
	addr = flag.String("addr", "127.0.0.1:8972", "the address to connect to")
	name = flag.String("name", defaultName, "Name to greet")
)

func main() {
	flag.Parse()
	// 连接到server端
	conn, err := grpc.Dial(*addr, grpc.WithInsecure())
	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.
	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.GetMessage())
}

保存后将http_client编译并执行：

go build
./hello_client -name=七米

得到以下输出结果，说明RPC调用成功。

2022/05/15 00:31:52 Greeting: Hello 七米

gRPC跨语言调用

接下来，我们演示一下如何使用gRPC实现跨语言的RPC调用。

我们使用Python语言编写Client，然后向上面使用go语言编写的server发送RPC请求。

生成Python代码

新建一个py_client目录，将hello.proto文件保存到py_client/pb/目录下。在py_client目录下执行以下命令，生成python源码文件。

cd py_cleint
python3 -m grpc_tools.protoc -Ipb --python_out=. --grpc_python_out=. pb/hello.proto

编写Python版RPC客户端

将下面的代码保存到py_client/client.py文件中。

from __future__ import print_function

import logging

import grpc
import hello_pb2
import hello_pb2_grpc


def run():
    # NOTE(gRPC Python Team): .close() is possible on a channel and should be
    # used in circumstances in which the with statement does not fit the needs
    # of the code.
    with grpc.insecure_channel('127.0.0.1:8972') as channel:
        stub = hello_pb2_grpc.GreeterStub(channel)
        response = stub.SayHello(hello_pb2.HelloRequest(name='q1mi'))
    print("Greeter client received: " + response.message)


if __name__ == '__main__':
    logging.basicConfig()
    run()

此时项目的目录结构图如下：

py_client
├── client.py
├── hello_pb2.py
├── hello_pb2_grpc.py
└── pb
    └── hello.proto

Python RPC 调用

执行client.py调用go语言的SayHelloRPC服务。

❯ python3 client.py
Greeter client received: Hello q1mi

这里我们就实现了，使用python代码编写的client去调用Go语言版本的server了。

点击右边的链接查看完整代码：gRPC_demo完整代码

gRPC还有更多进阶用法，未完待续…

扫码关注微信公众号

RPC是什么

gRPC是什么

为什么要用gRPC

安装gRPC

安装gRPC

安装Protocol Buffers v3

安装插件

检查

gRPC开发分三步

gRPC入门示例

编写proto代码

编写Server端Go代码

编写Client端Go代码

gRPC跨语言调用

生成Python代码

编写Python版RPC客户端

Python RPC 调用

See Also

👇🏻👇🏻👇🏻我亲自录制的视频课程

最近文章

分类

标签

友情链接

微信公众号

其它