[系列] Go gRPC Hello World

概述

開始 gRPC 了，這篇文章學習使用 gRPC，輸出一個 Hello World。

• 用 Go 實現 gRPC 的服務端。
• 用 Go 實現 gRPC 的客戶端。

gRPC 支持 4 類服務方法，我們此次實現 單項 RPC 和 服務端流式 RPC。

四類服務方法

單項 RPC

服務端發送一個請求給服務端，從服務端獲取一個應答，就像一次普通的函數調用。

rpc SayHello(HelloRequest) returns (HelloResponse){}
複製代碼

服務端流式 RPC

客戶端發送一個請求給服務端，可獲取一個數據流用來讀取一系列消息。客戶端從返回的數據流裏一直讀取直到沒有更多消息爲止。

rpc LotsOfReplies(HelloRequest) returns (stream HelloResponse){}
複製代碼

客戶端流式 RPC

客戶端用提供的一個數據流寫入併發送一系列消息給服務端。一旦客戶端完成消息寫入，就等待服務端讀取這些消息並返回應答。

rpc LotsOfGreetings(stream HelloRequest) returns (HelloResponse) {}
複製代碼

雙向流式 RPC

兩邊均可以分別經過一個讀寫數據流來發送一系列消息。這兩個數據流操做是相互獨立的，因此客戶端和服務端能按其但願的任意順序讀寫，例如：服務端能夠在寫應答前等待全部的客戶端消息，或者它能夠先讀一個消息再寫一個消息，或者是讀寫相結合的其餘方式。每一個數據流裏消息的順序會被保持。

rpc BidiHello(stream HelloRequest) returns (stream HelloResponse){}
複製代碼

安裝

安裝 protobuf 編譯器

brew install protobuf
複製代碼

驗證：

protoc --version

//輸出：libprotoc 3.7.1
複製代碼

安裝 Go protobuf 插件

go get -u github.com/golang/protobuf/proto

go get -u github.com/golang/protobuf/protoc-gen-go
複製代碼

安裝 grpc-go

go get -u google.golang.org/grpc
複製代碼

寫個 Hello World 服務

• 編寫服務端 .proto 文件
• 生成服務端 .pb.go 文件並同步給客戶端
• 編寫服務端提供接口的代碼
• 編寫客戶端調用接口的代碼

目錄結構

├─ hello  -- 代碼根目錄
│  ├─ go_client
│     ├── main.go
│     ├── proto
│         ├── hello
│            ├── hello.pb.go
│  ├─ go_server
│     ├── main.go
│     ├── controller
│         ├── hello_controller
│            ├── hello_server.go
│     ├── proto
│         ├── hello
│            ├── hello.pb.go
│            ├── hello.proto
複製代碼

這樣建立目錄是爲了 go_client 和 go_server 後期能夠拆成兩個項目。

編寫服務端 hello.proto 文件

syntax = "proto3"; // 指定 proto 版本

package hello;     // 指定包名

// 定義 Hello 服務
service Hello {

	// 定義 SayHello 方法
	rpc SayHello(HelloRequest) returns (HelloResponse) {}

	// 定義 LotsOfReplies 方法
	rpc LotsOfReplies(HelloRequest) returns (stream HelloResponse){}
}

// HelloRequest 請求結構
message HelloRequest {
	string name = 1;
}

// HelloResponse 響應結構
message HelloResponse {
    string message = 1;
}

複製代碼

瞭解更多 Protobuf 語法，請查看：

developers.google.com/protocol-bu…

生成服務端 .pb.go

protoc -I . --go_out=plugins=grpc:. ./hello.proto
複製代碼

同時將生成的 hello.pb.go 複製到客戶端一份。

查看更多命令參數，執行 protoc，查看 OPTION 。

編寫服務端提供接口的代碼

// hello_server.go
package hello_controller

import (
	"fmt"
	"golang.org/x/net/context"
	"hello/go_server/proto/hello"
)

type HelloController struct{}

func (h *HelloController) SayHello(ctx context.Context, in *hello.HelloRequest) (*hello.HelloResponse, error) {
	return &hello.HelloResponse{Message : fmt.Sprintf("%s", in.Name)}, nil
}

func (h *HelloController) LotsOfReplies(in *hello.HelloRequest, stream hello.Hello_LotsOfRepliesServer)  error {
	for i := 0; i < 10; i++ {
		stream.Send(&hello.HelloResponse{Message : fmt.Sprintf("%s %s %d", in.Name, "Reply", i)})
	}
	return nil
}
複製代碼

// main.go
package main

import (
	"log"
	"net"
	"hello/go_server/proto/hello"
	"hello/go_server/controller/hello_controller"
	"google.golang.org/grpc"
)

const (
	Address = "0.0.0.0:9090"
)

func main() {
	listen, err := net.Listen("tcp", Address)
	if err != nil {
		log.Fatalf("Failed to listen: %v", err)
	}

	s := grpc.NewServer()

	// 服務註冊
	hello.RegisterHelloServer(s, &hello_controller.HelloController{})

	log.Println("Listen on " + Address)

	if err := s.Serve(listen); err != nil {
		log.Fatalf("Failed to serve: %v", err)
	}
}
複製代碼

運行：

go run main.go

2019/07/28 17:51:20 Listen on 0.0.0.0:9090
複製代碼

編寫客戶端請求接口的代碼

package main

import (
	"hello/go_client/proto/hello"
	"io"
	"log"
	"golang.org/x/net/context"
	"google.golang.org/grpc"
)

const (
	// gRPC 服務地址
	Address = "0.0.0.0:9090"
)

func main() {
	conn, err := grpc.Dial(Address, grpc.WithInsecure())
	if err != nil {
		log.Fatalln(err)
	}
	defer conn.Close()

	// 初始化客戶端
	c := hello.NewHelloClient(conn)

	// 調用 SayHello 方法
	res, err := c.SayHello(context.Background(), &hello.HelloRequest{Name: "Hello World"})

	if err != nil {
		log.Fatalln(err)
	}

	log.Println(res.Message)

	// 調用 LotsOfReplies 方法
	stream, err := c.LotsOfReplies(context.Background(),&hello.HelloRequest{Name: "Hello World"})
	if err != nil {
		log.Fatalln(err)
	}

	for {
		res, err := stream.Recv()
		if err == io.EOF {
			break
		}

		if err != nil {
			log.Printf("stream.Recv: %v", err)
		}

		log.Printf("%s", res.Message)
	}
}
複製代碼

運行：

go run main.go

2019/07/28 17:58:13 Hello World
2019/07/28 17:58:13 Hello World Reply 0
2019/07/28 17:58:13 Hello World Reply 1
2019/07/28 17:58:13 Hello World Reply 2
2019/07/28 17:58:13 Hello World Reply 3
2019/07/28 17:58:13 Hello World Reply 4
2019/07/28 17:58:13 Hello World Reply 5
2019/07/28 17:58:13 Hello World Reply 6
2019/07/28 17:58:13 Hello World Reply 7
2019/07/28 17:58:13 Hello World Reply 8
2019/07/28 17:58:13 Hello World Reply 9
複製代碼

查看源碼：github.com/xinliangnot…

推薦閱讀

Gin 框架

• Gin 框架 - 自定義錯誤處理
• Gin 框架 - 數據綁定和驗證
• Gin 框架 - 使用 Logrus 日誌記錄
• Gin 框架 - 安裝和路由配置

基礎篇

• Go - 函數
• Go - 循環
• Go - Map 集合
• Go - Struct 結構體
• Go - Slice 切片
• Go - 數組
• Go - 變量聲明
• Go - 環境安裝

本文歡迎轉發，轉發請註明做者和出處，謝謝！