🔖

Go で gRPC 通信 Hello World (Win)

2022/08/01に公開約5,200字

gRPC の基本的な通信を確認していきます。

公式サイトの Hello World をベースにして基本の simple RPC(Unary RPC) 通信を行います。

開発環境は Windows10(64bit) + Visual Studio Code です。

開発環境の準備

Go

最新版をインストール

Protocol Buffer コンパイラ, protoc version 3 系

protocol buffer 公式の github release から入手します

zip を展開

  • 例: C:\Users\your_name\programs\protoc-21.4-win64
  • 展開先のパスは各自の環境で適時読み替えてください

Protocol Buffer コンパイラ Go プラグイン

PowerShell 開いて実行 go install でプラグインをインストール

PS > go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go: downloading google.golang.org/protobuf v1.28.1

PS > go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
go: downloading google.golang.org/grpc v1.2.1

GOPATH の位置を確認しておく

go env GOPATH

Path 環境変数を設定

Windows タスクバーの検索 > システムの詳細設定 > システムのプロパティ > 環境変数 > ユーザの環境変数 > Path に Protocol Buffer コンパイラと Go プラグインへのパスを通しておく

protoc のパス例

C:\Users\your_name\programs\protoc-21.4-win64\bin

Go プラグインの例 (GOPATH が C:\Users\your_name\goの場合)

C:\Users\your_name\go\bin

Hello World

開発環境の準備ができたら helloworld サンプルを参考にしながら基本の通信を確認していきます。

https://github.com/grpc/grpc-go/tree/master/examples/helloworld

helloworld-server

作業用フォルダ準備

helloworld-server フォルダを作って Visual Studio Code で開きます。

protocol buffer ファイルの作成

grpc フォルダを作成し、その下に helloworld.proto を用意します。
ほぼサンプルのまま。

// grpc/helloworld.proto
syntax = "proto3";

option go_package = ".;grpc";

package grpc;

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

コードの自動生成

protoc コマンドで protocol buffer ファイルからコードを自動生成します。

PowerShell を開いて以下を実行 (bash は`を\に読み替え)

protoc --go_out=. --go_opt=paths=source_relative `
    --go-grpc_out=. --go-grpc_opt=paths=source_relative `
    grpc/helloworld.proto

go ファイルが 2 つ生成されます。

作業フォルダの状態

grpc\
    + helloworld_grpc.pb.go
    + helloworld.pb.go
    + helloworld.proto

サーバ開発

go mod init でモジュール初期化しておきます。

github.com/hidingfox は適切な値に変更してください。

go mod init github.com/hidingfox

main.go を記載します。ほぼサンプルのまま。

// main.go
package main

import (
	"context"
	"flag"
	"fmt"
	"log"
	"net"

	pb "github.com/hidingfox/grpc"
	"google.golang.org/grpc"
)

var (
	port = flag.Int("port", 50051, "The server port")
)

// server is used to implement helloworld.GreeterServer.
type server struct {
	pb.UnimplementedGreeterServer
}

// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
	log.Printf("Received: %v", in.GetName())
	return &pb.HelloReply{Message: "Hello " + in.GetName()}, nil
}

func main() {
	flag.Parse()
	lis, err := net.Listen("tcp", fmt.Sprintf(":%d", *port))
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}
	s := grpc.NewServer()
	pb.RegisterGreeterServer(s, &server{})
	log.Printf("server listening at %v", lis.Addr())
	if err := s.Serve(lis); err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

go mod tidy を実行して依存モジュールをインストールします。

go mod tidy

作業フォルダの状態

grpc\
    + helloworld_grpc.pb.go
    + helloworld.pb.go
    + helloworld.proto
go.mod
go.sum
main.go

サーバ起動

go run すればこれで起動するはず。

go run .\main.go

# 2022/08/02 00:32:44 server listening at [::]:50051

helloworld-client

作業用フォルダ準備

helloworld-client フォルダを作って Visual Studio Code で開きます。

protocol buffer ファイルの作成

helloworld-server の grpc フォルダをそのままコピーすれば OK

クライアント開発

go mod init を実行

github.com/hidingfox は適切な値に変更してください。

go mod init github.com/hidingfox

main.go を記載します。ほぼサンプルのまま。

// main.go
package main

import (
	"context"
	"flag"
	"log"
	"time"

	pb "github.com/hidingfox/grpc"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials/insecure"
)

const (
	defaultName = "world"
)

var (
	addr = flag.String("addr", "localhost:50051", "the address to connect to")
	name = flag.String("name", defaultName, "Name to greet")
)

func main() {
	flag.Parse()
	// Set up a connection to the server.
	conn, err := grpc.Dial(*addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
	if err != nil {
		log.Fatalf("did not connect: %v", err)
	}
	defer conn.Close()
	c := pb.NewGreeterClient(conn)

	// Contact the server and print out its response.
	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
	defer cancel()
	r, err := c.SayHello(ctx, &pb.HelloRequest{Name: *name})
	if err != nil {
		log.Fatalf("could not greet: %v", err)
	}
	log.Printf("Greeting: %s", r.GetMessage())
}

go mod tidy を実行

go mod tidy

作業フォルダの状態

grpc\
    + helloworld_grpc.pb.go
    + helloworld.pb.go
    + helloworld.proto
go.mod
go.sum
main.go

クライアント実行

サーバが起動している状態で go run を実行。
無事接続できた。

go run .\main.go

# 2022/08/02 00:52:13 Greeting: Hello world

Discussion

ログインするとコメントできます