概要

gRPCはあらゆる環境で実行できるモダンで高性能なオープンソースRPC(Remoto Protocol Call)フレームワークです。Protocol Buffersを使ってデータをシリアライズし、高速な通信を実現できるという利点がある。様々な言語やプラットフォームに対応しており、http/2を活かした双方向ストリーミングなどが可能である。Protocol Buffersを使用してシンプルにサービス(通信するデータや関数)を定義でき、APIの仕様を明文化できる。

※この章はgRPCを参考にしています。

git: k-washi/example-golang-gRPC

スタートプロジェクト

VSCodeの設定

vscode-proto3 & Clang-Format extensions をインストール

もし、自動でファイルをフォーマットしたいならば、以下も設定する。

Clang-Formatをインストール

brew install clang-format #MacOSX

#other OS  
#http://www.codepool.biz/vscode-format-c-code-windows-linux.html

Protocol buffersの設定

Protocol buffersのインストール

# MacOSX
brew install protobuf #MacOSX

# Linux
#https://github.com/google/protobuf/releases

#example
# Make sure you grab the latest version
curl -OL https://github.com/google/protobuf/releases/download/v3.5.1/protoc-3.5.1-linux-x86_64.zip
# Unzip
unzip protoc-3.5.1-linux-x86_64.zip -d protoc3
# Move protoc to /usr/local/bin/
sudo mv protoc3/bin/* /usr/local/bin/
# Move protoc3/include to /usr/local/include/
sudo mv protoc3/include/* /usr/local/include/
# Optional: change owner
sudo chown [user] /usr/local/bin/protoc
sudo chown -R [user] /usr/local/include/google

Golangの設定

パッケージののインストール

go get -u google.golang.org/grpc
go get -d -u github.com/golang/protobuf/protoc-gen-go

実行の確認

まず、サービスを定義する。

greet.proto

syntax = "proto3";

package greet;
option go_package="greetpb";

service GreetService{}

この定義したファイルに対して、以下のコマンドでgolang用のprotocol buffers(greet.pb.go)に変換する。この変換されたライブラリファイル(greet.pb.go)内の関数を、golangによるクライアントとサーバーで使用することで、gRPCによる通信を実現できる。

protoc greet/greetpb/greet.proto  --go_out=plugins=grpc:.

クライアントは、以下のように接続の確立を行い、クライアントAPI(NewGreetServiceClient)で通信している。

client.go

package main

import (
    "fmt"
    "log"
  //protocol buffersライブラリー
    "github.com/k-washi/example-golang-gRPC/greet/greetpb"
    "google.golang.org/grpc"
)

func main() {
    fmt.Println("Hello. I'm a client")
    conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure())
    if err != nil {
        log.Fatalf("Could not connect: %v", err)
    }
    defer conn.Close()
    c := greetpb.NewGreetServiceClient(conn)
    fmt.Printf("Created client %f", c)
}

サーバーは、構造体serverを定義し、サービスをサーバーに登録する。そして、サーバーを立ち上げる。

server.go

package main

import (
    "fmt"
    "log"
    "net"
    "github.com/k-washi/example-golang-gRPC/greet/greetpb"
    "google.golang.org/grpc"
)

type server struct{}

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

    s := grpc.NewServer()
    greetpb.RegisterGreetServiceServer(s, &server{})

    if err := s.Serve(lis); err != nil {
        log.Fatalf("failed to serve: %v", err)
    }
}

以下のコマンドで、サーバーを立ち上げ、クライアントを実行することで、実行の確認を行う。


#server setup
go run greet/greet_server/server.go 

#client setup
go run greet/greet_client/client.go

通信手法

gRPCは、以下のような通信手法があり、データの特性に応じて適宜選択する必要がある。

Unary - もっとも一般的なgRPCのAPIで、クライアントからのメッセージ1つに対して、サーバーは1回のメッセージを返す
Server streaming - HTTP/2の恩恵を受けたAPIで、クライアントからのメッセージ1つに対して、サーバーは複数回のメッセージを返す
Client streaming - HTTP/2の恩恵を受けたAPIで、クライアントからの複数のメッセージに対して、サーバーは1回のメッセージを返す

サービスの定義

送信するメッセージの型を定義する
Unary, Server streaming, Client streamingのリクエスト・レスポンスにおけるメッセージの型を定義する
サービスを rpc サービス名(stream クライアントの型) returns (stream レスポンスの型) {}; として定義する。複数回送るサービスのメッセージにはstreamをつける。
以下のコマンドでprotocol buffersに変換.

protoc streaming/greetpb/greet.proto  --go_out=plugins=grpc:.

syntax = "proto3";

package greet;
option go_package="greetpb";

//リクエストメッセージの型を定義
message Greeting {
  string first_name = 1;
  string last_name = 2;
}

// Unary リクエスト
message GreetRequest {
  Greeting greeting = 1;
}

// Unary レスポンス
message GreetResponse {
  string result = 1;
}

// Server streaming リクエスト
message GreetManyTimesRequest {
  Greeting greeting = 1;
}

// Server streaming レスポンス
message GreetManyTimesResponse {
  string result = 1;
}

// Client streaming リクエスト
message LongGreetRequest {
  Greeting greeting = 1;
}

// Client streaming レスポンス
message LongGreetResponse {
  string result = 1;
}

// サービスの定義
service GreetService{
  //Unary
  rpc Greet(GreetRequest) returns (GreetResponse) {};

  //Server Streaming
  rpc GreetManyTimes(GreetManyTimesRequest) returns (stream GreetManyTimesResponse) {};

  //Client Streaming
  rpc LongGreet(stream LongGreetRequest) returns (LongGreetResponse) {};
}

クライアント

Golangにより、Unary, Server streaming, Client streamingのクライアントを実装する。基本的には、サービス定義に合わせた型でデータを作成、リクエストを送信、そして、レスポンスを待つ形式である。これらの処理には、protocol buffersライブラリに記載されたパッケージを使用する。サーバーからの複数回のメッセージを待つ場合、繰り返し構文(for)を用いて受信することで、適用できる。複数回サーバーにメッセージを送信する場合も、繰り返し構文を用いているが、基本的には、メッセージごとに送信しているだけである。gRPCに関するエラーは、"google.golang.org/grpc/status"ライブラリを用いて抽出・定義できる。