【gRPC】快速开始 | Go

Prerequisites(先决条件)

获取示例代码

  1. 下载实例代码
    $ git clone -b v1.46.0 --depth 1 https://github.com/grpc/grpc-go
    
  2. 切换代码目录
    $ cd grpc-go/examples/helloworld
    

运行示例

在 examples/helloworld 目录下:

  1. 编译和执行服务端代码
    $ go run greeter_server/main.go
    
  2. 在另外一个终端中,编译和执行客户端代码,会看到客户端输出:
    $ go run greeter_client/main.go
    Greeting: Hello world
    

更新 gRPC 服务

在本节中,将使用额外的 server 方法更新应用程序。gRPC服务是使用 protocol buffers 定义的。
现在,只需要知道服务器和客户端存根都有一个 SayHello()RPC方法,该方法从客户端获取一个 HelloRequest 参数,并从服务器返回一个 HelloReply,该方法的定义如下:

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

打开 helloworld/helloworld.proto,添加一个新的方法 SayHelloAgain()

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

重新生成 gRPC 代码

在可以使用新的服务方法之前,需要重新编译更新后的 .proto 文件。
在 examples/helloworld 目录下,运行下面的命令:

$ protoc --go_out=. --go_opt=paths=source_relative \
--go-grpc_out=. --go-grpc_opt=paths=source_relative \
helloworld/helloworld.proto

paths:用于指定生成文件的路径的结构,有两个值:
1. paths=import 相对于导入路径, 默认值
2. paths=source_relative 相对于输入文件,即proto文件的路径

重新生成的 helloworld/helloworld.pb.go 和 helloworld/helloworld_grpc.pb.go 文件中包含:

  • xxx.pb.go
    它包含用于填充、序列化和检索 请求和响应消息类型 的所有protocol buffer 代码。
  • xxx_grpc.pb.go
    客户端使用的 服务中定义的方法调用的接口类型(或存根)。
    服务器要实现的接口类型。

更新并运行应用程序

虽然已经生成了客户端、服务端代码,但是任然需要示例程序中 实现和调用 新的方法。

  1. 更新 服务端
    打开 greeter_server/main.go 添加下面的函数:
    func (s *server) SayHelloAgain (ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
      retrn &pb.HelloReply{Message: "Hello again " + in.GetName()}, nil
    }
    
  2. 更新客户端
    打开 greeter_client/main.go 在 main() 函数体的最下方添加下面代码:
    r, err = c.SayHelloAgain(ctx, &pb.HelloRequest{Name: name})
    if err != nil {
      log.Fatalf("could not greet : %v", err)
    }
    log.Printf("Greetine : %s", r.GetMessage())
    
  3. 运行
    # 运行 server
    go run greeter_server/main.go
    
    # 运行 client
    go run greeter_client/main.go Alice
    
    # client 输出
    2021/05/15 23:55:08 Greeting: Hello Alice
    2021/05/15 23:55:08 Greeting: Hello again Alice
    

总结

  • gRPC基本使用流程
  1. .proto 文件中定义 service、message

  2. 通过 protocol buffer 编译器生成代码

  3. 创建服务端
    3.1 实现 servic 中定义的接口
    gRPC 允许你定义四种类型的服务方法

    3.2 启动一个gRPC 服务,监听客户端请求
    一旦你实现了所有的方法,我们需要启动一个 gRPC 服务,目的是客户端能够使用我们的服务。
    如何构建并启动一个服务:
    3.2.1 指定用于 监听客户端请求的端口
    lis, err := net.Listen(...)

    3.2.2 创建一个 gRPC 服务实例
    grpcServer := grpc.NewServer(...)

    3.2.3 在 gRPC服务器上注册我们的服务实现
    pb.RegisterRouterGuideServer(...)

    3.2.4 在服务器上使用 端口详细信息 调用Serve() 方法,以执行阻塞等待,直到进程被终止 或 调用 Stop()
    grpcServer.Serve(...)

    lis, err := net.Listen("tcp", fmt.Sprintf("localhost:%d", *port))
    if err != nil {
      log.Fatalf("failed to listen: %v", err)
    }
    
    var opts []grpc.ServerOption
    ...
    grpcServer := grpc.NewServer(opts...)
    pb.RegisterRouteGuideServer(grpcServer, newServer())
    grpcServer.Serve(lis)
    
  4. 创建客户端

  5. 创建一个stub
    要调用服务方法,我们首先需要创建一个gRPC通道来与服务器通信。我们通过将服务器地址和端口号传递给 grpc.Dial() 来创建它,如下所示:

    var opts []grpc.DialOption
    ...
    conn, err := grpc.Dial(*serverAddr, opts...)
    if err != nil {
    ...
    }
    defer conn.Close()
    

    可以使用 DialOptions 在 grpc.Dial 中设置身份验证凭据(例如,TLS、GCE凭据或JWT凭据),当服务需要这些凭据时可以使用它们。

    一旦 gRPC通道 设置好,我们就需要一个客户端存根来执行RPC。我们使用从 .proto文件 生成的 pb包 提供的 NewRouteGuideClient方法 获得它。

    client := pb.NewRouteGuideClient(conn)
    
  6. 调用服务方法
    gRPC允许定义四种类型的服务方法

  7. 执行客户端、服务端应用程序

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • grpc是后台服务通信最常用的rpc框架。使用grpc需要预先定义协议文件(proto),然后生成相应的接口代码才...
    霹雳楊阅读 675评论 0 0
  • 1.简介 在gRPC中,客户端应用程序可以直接调用不同计算机上的服务器应用程序上的方法,就像它是本地对象一样,使您...
    第八共同体阅读 1,870评论 0 6
  • 1,关于grpc-go golang 可以可以做grpc的服务端和客户端。 官网的文档: http://www.g...
    ebayboy阅读 1,078评论 0 1
  • gRPC(Remote Procedure Calls) 概述 GRPC是一个高性能、通用的开源RPC框架,基于底...
    鬼鸮阅读 17,901评论 0 1
  • 彩排完,天已黑
    刘凯书法阅读 4,199评论 1 3