LoginSignup
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@ko-suke2020

Go 入門者向け gRPC クライアント実装解説

Last updated at Posted at 2025-02-15

概要

本記事では、Go を使って gRPC クライアントを実装する方法を、最初から順を追って解説します。
具体的には、以下の内容を取り扱います。

  • gRPC クライアントの接続処理（エラー処理や接続状態の確認を含む）
  • コマンドライン引数の利用でリクエスト内容を動的に変更する方法
  • 自動生成されたクライアントスタブの利用
  • grpc.WithTransportCredentials、err != nil、context.WithTimeout などの各ポイントの詳細解説

サーバ実装について

サーバ実装については以下で記事をご参考にしてください。
→Go 入門者向け gRPC サーバー実装と自動生成コードの比較解説

こちらではProtocol Buffers の .proto ファイルから自動生成されるコードがどのように活用されるのかについても解説しています。

前提条件

実装コード

以下が、全体のコード例になります。
この例では、コマンドライン引数 -name で渡された名前を、gRPC サーバーの SayHello メソッドにリクエストとして送信します。

package main

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

	pb "github.com/Skosuke/greetly/proto/hello"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials/insecure"
)

func main() {
	// 1. コマンドライン引数から名前を取得（デフォルトは "Gopher"）
	name := flag.String("name", "Gopher", "挨拶する名前")
	flag.Parse()

	// 2. gRPC サーバーへの接続を作成
	// grpc.WithTransportCredentials(insecure.NewCredentials()) は、TLS などの認証を無効にし、暗号化されない通信を行うためのオプションです。
	conn, err := grpc.NewClient("passthrough:///localhost:50051",
		grpc.WithTransportCredentials(insecure.NewCredentials()),
	)
	// 3. エラー処理: 接続作成時にエラーが発生していないかチェック
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}
	// 接続クローズ処理は、エラーがない場合にすぐ登録しておく
	defer conn.Close()

	// 4. 明示的に接続開始（grpc.NewClient は接続を遅延させるため）
	conn.Connect()

	// 5. 接続状態が READY になるまで待機（最大5秒間）
	// context.WithTimeout は、指定した期間内に処理が完了しなければ自動的にキャンセルするコンテキストを作成します。
	// ここでは、接続状態の確認処理に対するタイムアウトとして利用しています。
	// また、context.Background() を第一引数に渡すことで、特定の親コンテキストがないルートのコンテキストから派生させています。
	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()
	for conn.GetState().String() != "READY" {
		if !conn.WaitForStateChange(ctx, conn.GetState()) {
			log.Fatalf("Failed to connect within the timeout")
		}
	}
	log.Println("Client connected successfully")

	// 6. 自動生成されたクライアントスタブを利用して GreeterClient を作成
	client := pb.NewGreeterClient(conn)
	
	// 7. サーバーの SayHello メソッドを呼び出し、HelloRequest に引数から渡された名前をセット
	res, err := client.SayHello(context.Background(), &pb.HelloRequest{Name: *name})
	if err != nil {
		log.Fatalf("Could not greet: %v", err)
	}

	log.Printf("Server response: %s", res.Message)
}

各ステップの詳細解説

1. コマンドライン引数の取得

name := flag.String("name", "Gopher", "挨拶する名前")
flag.Parse()

  • 概要:
    flag パッケージを利用して、実行時に -name フラグで名前を受け取ります。
    デフォルト値は "Gopher" となり、第三引数はヘルプメッセージとして表示されます。

  • 用途:
    取得した値は、後ほどサーバーへ送るリクエストの Name フィールドに利用されます。

2. gRPC 接続の初期化

conn, err := grpc.NewClient("passthrough:///localhost:50051",
	grpc.WithTransportCredentials(insecure.NewCredentials()),
)
if err != nil {
	log.Fatalf("Failed to create client: %v", err)
}
defer conn.Close()

  • grpc.NewClient と grpc.WithTransportCredentials:

    • grpc.NewClient は指定したアドレス（この例では passthrough:///localhost:50051）への接続オブジェクトを生成します。
    • grpc.WithTransportCredentials(insecure.NewCredentials()) は、通常 TLS などの安全な通信を行うための認証情報を設定しますが、ここでは開発環境用に暗号化しない「insecure」モードを利用しています。
      ※ 本番環境では、安全な通信のため適切な認証情報を利用する必要があります。

  • err != nil のチェック:
    接続作成時にエラーが発生した場合、err に値が入ります。
    このチェックにより、接続が正常に作成できなかった場合にエラーメッセージを出力し、プログラムを終了させます

  • defer conn.Close():
    接続が確立した後、プログラム終了時に必ず接続をクローズするように登録しておきます。

3. 接続の開始

conn.Connect()
  • 目的:
    grpc.NewClient は接続を遅延して行うため、ここで明示的に接続を開始します。

4. 接続状態の確認

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
for conn.GetState().String() != "READY" {
	if !conn.WaitForStateChange(ctx, conn.GetState()) {
		log.Fatalf("Failed to connect within the timeout")
	}
}
log.Println("Client connected successfully")

  • context.WithTimeout の役割:
    指定した 5 秒の間に接続状態が変化するのを待つためのタイムアウト付きコンテキストを作成します。
    これにより、接続状態が "READY" にならない場合、無限待ちすることなく処理を中断できます

  • context.Background() の利用理由:
    親コンテキストが不要な場合は context.Background() を用いて、そこからタイムアウト付きのコンテキストを派生させます。
    これは、ルートコンテキストとして広く利用されるため、特定のキャンセルや値を持たないコンテキストとして最適です

  • 接続状態確認のループ:
    conn.GetState() により現在の接続状態を取得し、状態が "READY" になるまで WaitForStateChange を用いて状態変化を監視します。
    タイムアウトが発生すると、エラーメッセージを出力してプログラムが終了します。

5. 自動生成されたクライアントスタブの利用

client := pb.NewGreeterClient(conn)
  • クライアントスタブとは:
    .proto ファイル（例: projects/greetly/proto/hello/hello.proto）から自動生成されたコードで、サーバーのリモートメソッドをローカル関数のように呼び出せるインターフェースを提供します。
    これにより、低レベルの通信処理を意識せずにサーバーとのやり取りが可能になります。

6. サーバーへのリクエスト送信

res, err := client.SayHello(context.Background(), &pb.HelloRequest{Name: *name})
if err != nil {
	log.Fatalf("Could not greet: %v", err)
}
log.Printf("Server response: %s", res.Message)

  • リクエストの作成:
    コマンドライン引数から取得した名前（*name）を HelloRequest の Name フィールドにセットします

  • context.Background() の利用:
    この呼び出しでは、キャンセルやタイムアウトを特に設定する必要がないため、シンプルに context.Background() を使用してリクエストを送信します

  • サーバー呼び出し:
    自動生成されたクライアントスタブの SayHello メソッドを呼び出し、サーバー側で実装されたロジックが実行されます。
    エラーが発生した場合はログに出力し、正常ならサーバーからのレスポンスメッセージを表示します

まとめ

今回の記事では、Go を使った gRPC クライアントの実装方法について、以下のポイントを解説しました。

  • コマンドライン引数の利用:
    flag パッケージを使用して、実行時にリクエスト内容を動的に変更できるようにしました。

  • 接続の初期化とエラーチェック:
    grpc.NewClient と grpc.WithTransportCredentials(insecure.NewCredentials()) を使って接続を確立し、err != nil でエラーをチェックしています。

  • タイムアウト付きコンテキストの利用:
    context.WithTimeout を使用して、接続状態確認などの処理にタイムアウトを設け、無限待機を防止しています。
    ここでは、context.Background() を元にタイムアウト付きコンテキストを作成しています。

  • 自動生成されたクライアントスタブの利用:
    .proto ファイルから生成されたコードにより、サーバーのリモートメソッドを簡単に呼び出せるようになっています。

この実装例が、皆さん自身のプロジェクトで gRPC クライアントを実装する際の参考になれば幸いです。
ご不明点やご意見などがあれば、ぜひコメントしてください！

以上、Go による gRPC クライアント実装の解説でした。

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?