gRPC入门使用

gRPC是什么

官网如此写到

A high-performance, open source universal RPC framework

其实,gRPC是一个高性能的,通用的,面向服务端和移动端,基于 HTTP/2 设计的RPC框架。

RPC框架是什么?

RPC 框架说白了就是让你可以像调用本地方法一样调用远程服务提供的方法,而不需要关心底层的通信细节。简单地说就让远程服务调用更加简单、透明。
RPC框架包含了客户端(Client)和服务端(Server)
常见的RPC框架有

  • gRPC。谷歌出品
  • Thrift。Apache出品
  • Dubbo。阿里出品,也是一个微服务框架

gRPC的特性

官方文档的介绍,有以下4点特性:

  1. 使用Protocal Buffers这个强大的结构数据序列化工具
  2. gRPC可以跨语言使用
  3. 安装简单,扩展方便(用该框架每秒可达到百万个RPC)
  4. 基于HTTP2协议

gRPC使用流程

  • 定义标准的proto文件
  • 生成标准代码(用protoc工具)
  • 服务端使用生成的代码提供服务
  • 客户端使用生成的代码调用服务

Golang实践

安装protoc

首先,我们需要安装protoc,这个工具是Protocol Buffer的编译器,把proto文件翻译成不同语言(Java,Go等)。
地址:protobuf/releases
解压把bin目录下protoc文件放到/usr/local/bin目录下即可。

安装 protoc-gen-go

protoc-gen-go是Go的protoc编译插件,protobuf内置了许多高级语言的编译器,但没有Go的。

1
2
3
4
5
6
7
8
9
10
11
$ protoc -h
...
--cpp_out=OUT_DIR Generate C++ header and source.
--csharp_out=OUT_DIR Generate C# source file.
--java_out=OUT_DIR Generate Java source file.
--js_out=OUT_DIR Generate JavaScript source.
--objc_out=OUT_DIR Generate Objective C header and source.
--php_out=OUT_DIR Generate PHP source file.
--python_out=OUT_DIR Generate Python source file.
--ruby_out=OUT_DIR Generate Ruby source file.
...

我们借助Go Modules来安装,新建一个目录grpc-test,在目录下执行go mod init grpc-test创建一个Module
因为墙的原因,我们在go get之前要设置proxy(或者把GOPROXY设置到.bashrc文件中)

1
$ export GOPROXY=https://goproxy.cn

然后执行

1
go get -u github.com/golang/protobuf/protoc-gen-go

执行完就可以在$GOPATH的bin目录下看到protoc-gen-go文件。

定义服务

在grpc-test目录下新建一个protos的目录,写入hello.proto文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
syntax = "proto3";

package hello;
option go_package = "hellopb";

message helloRequest {
string name = 1;
int64 age = 2;
}

message helloResponse {
string greeting = 1;
}

service helloService {
rpc Hello(helloRequest) returns (helloResponse) {};
}

helloService就是给外部调用的服务
然后我们利用protoc工具把 .proto 文件翻译成需要语言的代码(这里是go)
gen.sh文件:

1
2
3
4
5
#!/bin/bash

protoDir="./protos"
outDir="./grpc"
protoc -I ${protoDir}/ ${protoDir}/*proto --go_out=plugins=grpc:${outDir}
  • -I: 指定import路径,可以指定多个-I参数,编译时按顺序查找,不指定默认当前目录
  • –go_out:指定go语言的访问类
  • plugins:指定依赖的插件
    这个bash会把生成的go代码写到hellopb目录下。

定义服务端

我们需要去实现hello.proto中的helloService

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
"context"
"fmt"
"google.golang.org/grpc"
"grpc-test/hellopb"
"log"
"net"
)

type server struct {
}

func (*server) Hello(ctx context.Context, request *hellopb.HelloRequest) (*hellopb.HelloResponse, error) {
name := request.Name
response := &hellopb.HelloResponse{
Greeting: "Hello " + name,
}
return response, nil
}

func main() {
address := "0.0.0.0:50051"
lis, err := net.Listen("tcp", address)
if err != nil {
log.Fatalf("Error %v", err)
}
fmt.Printf("Server is listening on %v ...", address)

s := grpc.NewServer()
hellopb.RegisterHelloServiceServer(s, &server{})

s.Serve(lis)
}

定义客户端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package main

import (
"context"
"fmt"
"grpc-test/hellopb"
"google.golang.org/grpc"
"log"
)

func main() {
fmt.Println("Hello client ...")

opts := grpc.WithInsecure()
cc, err := grpc.Dial("localhost:50051", opts)
if err != nil {
log.Fatal(err)
}
defer cc.Close()

client := hellopb.NewHelloServiceClient(cc)
request := &hellopb.HelloRequest{Name: "Jeremy", Age: 18}

resp, _ := client.Hello(context.Background(), request)
fmt.Printf("Receive response => [%v]", resp.Greeting)
}

参考:

您的支持将鼓励我继续创作!