[tldr] go使用gRPC

gRPC是谷歌推出的一个rpc服务框架, 数据编码采用protobuf实现.
安装环境

1. go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
2. go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

复制代码

缺少可能导致出现可执行程序没有找到的报错, 可以参考stackoverflow的帖子

文件

1. syntax = "proto3";
3. option go_package = "./myproto";
5. package myproto;
7. message Hello {
8.   string name = 1;
9. }
11. service HelloService {
12.   rpc SayHello (Hello) returns (Hello);
13. }

复制代码

分别需要message和service2个部分的内容
编译

1. ./bin/bin/protoc --go_out=. ./myproto/hello.proto
2. ./bin/bin/protoc --go-grpc_out=. ./myproto/hello.proto

复制代码

使用上述指令编译为符合grpc使用的服务, 一个是message的定义的GO实现, 一个是service的定义的GO实现

根据grpc官方文档应该采用类似以下的指令实现, 效果是一样的

1. protoc --go_out=. --go_opt=paths=source_relative \
2.     --go-grpc_out=. --go-grpc_opt=paths=source_relative \
3.     ./myproto/hello.proto

复制代码

• 本质是编译message和编译rpc的service
  

使用

以下代码为生成出来的go的grpc的服务的代码

1. // HelloServiceClient is the client API for HelloService service.
2. //
3. // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
4. type HelloServiceClient interface {
5.         SayHello(ctx context.Context, in *Hello, opts ...grpc.CallOption) (*Hello, error)
6. }
8. type helloServiceClient struct {
9.         cc grpc.ClientConnInterface
10. }
12. func NewHelloServiceClient(cc grpc.ClientConnInterface) HelloServiceClient {
13.         return &helloServiceClient{cc}
14. }
16. func (c *helloServiceClient) SayHello(ctx context.Context, in *Hello, opts ...grpc.CallOption) (*Hello, error) {
17.         cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
18.         out := new(Hello)
19.         err := c.cc.Invoke(ctx, HelloService_SayHello_FullMethodName, in, out, cOpts...)
20.         if err != nil {
21.                 return nil, err
22.         }
23.         return out, nil
24. }

复制代码

这些是自动生成的文件内容

Server

1. // HelloServiceServer is the server API for HelloService service.
2. // All implementations must embed UnimplementedHelloServiceServer
3. // for forward compatibility.
4. type HelloServiceServer interface {
5.         SayHello(context.Context, *Hello) (*Hello, error)
6.         mustEmbedUnimplementedHelloServiceServer()
7. }

复制代码

以上代码是编译器自动生成的GO代码

Client

1. // HelloServiceClient is the client API for HelloService service.
2. //
3. // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
4. type HelloServiceClient interface {
5.         SayHello(ctx context.Context, in *Hello, opts ...grpc.CallOption) (*Hello, error)
6. }

复制代码

以上为自动编译生成的代码

启动服务

在自己编写的代码中使用上述生成的代码

可以参考go-grpc官方仓库样例代码

server

1. package main
3. import (
4.         "context"
5.         "fmt"
6.         "log"
7.         "myrpc/myproto"
8.         "net"
10.         "google.golang.org/grpc"
11. )
13. const (
14.         PORT = 1234
15. )
17. type Server struct {
18.         myproto.UnimplementedHelloServiceServer
19. }
21. func (s *Server) SayHello(ctx context.Context, in *myproto.Req) (*myproto.Res, error) {
22.         log.Printf("Received: %v", in.Name)
23.         return &myproto.Res{Message: "Hello " + in.Name}, nil
24. }
26. func main() {
27.         list, err := net.Listen("tcp", fmt.Sprintf(":%d", PORT))
28.         if err != nil {
29.                 log.Printf("failed to listen: %v", err)
30.         }
32.         log.Printf("server listening at :%d", PORT)
34.         grpcServer := grpc.NewServer()
35.         myproto.RegisterHelloServiceServer(grpcServer, &Server{})
36.         grpcServer.Serve(list)
37. }

复制代码

整体实现和常见的rpc类似

client

1. package main
3. import (
4.         "context"
5.         "fmt"
6.         "myrpc/myproto"
7.         "time"
9.         "google.golang.org/grpc"
10.         "google.golang.org/grpc/credentials/insecure"
11. )
13. const (
14.         PORT = 1234
15. )
17. func main() {
18.         conn, err := grpc.NewClient(fmt.Sprintf(":%d", PORT), grpc.WithTransportCredentials(insecure.NewCredentials()))
19.         if err != nil {
20.                 panic(err)
21.         }
22.         defer conn.Close()
24.         c := myproto.NewHelloServiceClient(conn)
26.         ctx, cancel := context.WithTimeout(context.Background(), time.Second)
27.         defer cancel()
29.         res, err := c.SayHello(ctx, &myproto.Req{Name: "xuhe"})
30.         if err != nil {
31.                 panic(err)
32.         }
33.         fmt.Println(res.GetMessage())
34. }

复制代码

FQ

常见报错

1. panic: grpc: no transport security set (use grpc.WithTransportCredentials(insecure.NewCredentials()) explicitly or set credentials)
3. goroutine 1 [running]:
4. main.main()
5.         /home/xuhe/tmp/go/rpc/cmd/client/main.go:18 +0x1d4
6. exit status 2

复制代码

需要手动设置为conn, err := grpc.NewClient(fmt.Sprintf(":%d", PORT), grpc.WithTransportCredentials(insecure.NewCredentials()))不安全的实现方式
参考

grpc使用GO官方文档

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！