基本チュートリアル
PHPでのgRPCの基本的なチュートリアル入門。
基本チュートリアル
このチュートリアルは、PHPプログラマー向けのgRPCの基本的な紹介です。
この例を段階的に実行することで、以下のことを学びます。
- .protoファイルでサービスを定義します。
- プロトコルバッファコンパイラを使用してクライアントコードを生成します。
- PHP gRPC APIを使用して、サービス用のシンプルなクライアントを作成します。
Protocol Buffers にある程度の精通があることを前提としています。このチュートリアルの例では、Protocol Buffers言語のproto2バージョンを使用していることに注意してください。
また、現在PHPでgRPCサービス用のクライアントを作成できるのはサーバーのみであることにも注意してください。gRPCサーバーを作成するには、別の言語を使用してください。
gRPCを使用する理由
私たちの例は、クライアントがルート上の機能に関する情報を取得したり、ルートの要約を作成したり、サーバーや他のクライアントと交通情報などのルート情報を交換したりできる、シンプルなルートマッピングアプリケーションです。
gRPCを使用すると、1つの.protoファイルでサービスを一度定義し、gRPCがサポートする任意の言語でクライアントとサーバーを生成できます。これにより、大規模データセンター内のサーバーから個人のタブレットまで、さまざまな環境で実行できます。異なる言語や環境間の通信の複雑さはすべてgRPCによって処理されます。また、効率的なシリアライゼーション、シンプルなIDL、簡単なインターフェース更新など、プロトコルバッファを使用する利点もすべて得られます。
サンプルコードとセットアップ
このチュートリアルのサンプルコードは grpc/grpc/examples/php/route_guide にあります。例をダウンロードするには、次のコマンドを実行して grpc リポジトリとそのサブモジュールをクローンしてください。
git clone --recurse-submodules -b v1.74.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc
.proto ファイルのコンパイルを支援するために grpc-php-plugin が必要です。ソースから次のようにビルドします。
cd grpc
mkdir -p cmake/build
pushd cmake/build
cmake ../..
make protoc grpc_php_plugin
popd
次に、ルートガイドディレクトリに移動し、例の .proto ファイルをコンパイルします。
cd examples/php/route_guide
./route_guide_proto_gen.sh
私たちの例は、クライアントがルート上の機能に関する情報を取得したり、ルートの要約を作成したり、サーバーや他のクライアントと交通情報などのルート情報を交換したりできる、シンプルなルートマッピングアプリケーションです。
クライアントインターフェイスコード（およびテスト用の別の言語でのサーバー）を生成するための関連ツールもインストールしておく必要があります。後者は、たとえばこれらのセットアップ手順に従って取得できます。
試してみましょう！
サンプルアプリを試すには、ローカルで実行されているgRPCサーバーが必要です。たとえば、このリポジトリのNode.jsサーバーをコンパイルして実行しましょう。
cd ../../node
npm install
cd dynamic_codegen/route_guide
nodejs ./route_guide_server.js --db_path=route_guide_db.json
PHPクライアントを実行します（別のターミナルで）。
./run_route_guide_client.sh
次のセクションでは、このプロトサービスがどのように定義されているか、それからクライアントライブラリをどのように生成するか、そしてそのライブラリを使用するクライアントスタブをどのように作成するかを段階的に説明します。
サービスを定義する
まず、使用しているサービスがどのように定義されているかを見てみましょう。gRPCのサービスとそのメソッドのリクエストとレスポンスの型はProtocol Buffers を使用して定義されます。例の完全な .proto ファイルは、examples/protos/route_guide.proto で確認できます。
.protoファイルで名前付きのserviceを指定することで、サービスを定義します。
service RouteGuide {
...
}
次に、サービス定義内で rpc メソッドを定義し、そのリクエストとレスポンスの型を指定します。Protocol Buffers では、RouteGuide サービスで使用されている4種類のサービスメソッドを定義できます。
クライアントがサーバーにリクエストを送信し、後でレスポンスを受信するシンプルなRPC。通常のリモートプロシージャコールと同様です。
// Obtains the feature at a given position. rpc GetFeature(Point) returns (Feature) {}クライアントがサーバーにリクエストを送信し、レスポンスメッセージのストリームを受信するレスポンスストリーミングRPC。レスポンス型の前に
streamキーワードを配置することで、レスポンスストリーミングメソッドを指定します。// Obtains the Features available within the given Rectangle. Results are // streamed rather than returned at once (e.g. in a response message with a // repeated field), as the rectangle may cover a large area and contain a // huge number of features. rpc ListFeatures(Rectangle) returns (stream Feature) {}クライアントが一連のメッセージをサーバーに送信するリクエストストリーミングRPC。クライアントがメッセージの書き込みを完了すると、サーバーがそれらをすべて読み込んでレスポンスを返すのを待ちます。リクエスト型の前に
streamキーワードを配置することで、リクエストストリーミングメソッドを指定します。// Accepts a stream of Points on a route being traversed, returning a // RouteSummary when traversal is completed. rpc RecordRoute(stream Point) returns (RouteSummary) {}双方が互いにメッセージのシーケンスを送信する双方向ストリーミングRPC。2つのストリームは独立して動作するため、クライアントとサーバーは好きな順序で読み書きできます。たとえば、サーバーはクライアントメッセージをすべて受信してからレスポンスを書き込むことも、メッセージを1つ読み取ってから1つ書き込むことも、その他の読み書きの組み合わせも可能です。各ストリームのメッセージの順序は保持されます。リクエストとレスポンスの両方の前に
streamキーワードを配置することで、このタイプのメソッドを指定します。// Accepts a stream of RouteNotes sent while a route is being traversed, // while receiving other RouteNotes (e.g. from other users). rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
私たちの.protoファイルには、サービスメソッドで使用されるすべてリクエストとレスポンスの型に対応するプロトコルバッファメッセージ型定義も含まれています。たとえば、ここにPointメッセージ型があります。
// Points are represented as latitude-longitude pairs in the E7 representation
// (degrees multiplied by 10**7 and rounded to the nearest integer).
// Latitudes should be in the range +/- 90 degrees and longitude should be in
// the range +/- 180 degrees (inclusive).
message Point {
int32 latitude = 1;
int32 longitude = 2;
}
クライアントコードの生成
プロトファイル用のPHPクライアントスタブ実装は、gRPC PHP Protoc Pluginによって生成できます。プラグインをコンパイルするには。
make grpc_php_plugin
クライアントスタブ実装の .php ファイルを生成するには。
cd grpc
protoc --proto_path=examples/protos \
--php_out=examples/php/route_guide \
--grpc_out=examples/php/route_guide \
--plugin=protoc-gen-grpc=bins/opt/grpc_php_plugin \
./examples/protos/route_guide.proto
または、ソースでgrpc-php-pluginをビルドした場合は、grpc/example/php/route_guide ディレクトリの下にあるヘルパースクリプトを実行します。
./route_guide_proto_gen.sh
examples/php/route_guide ディレクトリに多数のファイルが生成されます。これらのファイルを変更する必要はありません。
これらの生成されたファイルをロードするには、examples/php ディレクトリの下にある composer.json ファイルにこのセクションを追加します。
"autoload": {
"psr-4": {
"": "route_guide/"
}
}
ファイルには以下が含まれます。
- リクエストおよびレスポンスメッセージタイプをポピュレート、シリアライズ、および取得するためのすべてのプロトコルバッファコード。
- クライアントが
RouteGuideサービスで定義されたメソッドを呼び出すことができるRouteguide\RouteGuideClientという名前のクラス。
クライアントを作成する
このセクションでは、RouteGuide サービス用のPHPクライアントの作成について説明します。完全なサンプルクライアントコードは、examples/php/route_guide/route_guide_client.php で確認できます。
クライアントオブジェクトの構築
サービスメソッドを呼び出すには、まずクライアントオブジェクト、つまり生成された RouteGuideClient クラスのインスタンスを作成する必要があります。クラスのコンストラクタは、接続したいサーバーのアドレスとポートを期待します。
$client = new Routeguide\RouteGuideClient('localhost:50051', [
'credentials' => Grpc\ChannelCredentials::createInsecure(),
]);
サービスメソッドを呼び出す
それでは、サービスメソッドの呼び出し方法を見てみましょう。
シンプルなRPC
シンプルなRPC GetFeature の呼び出しは、ローカルの非同期メソッドの呼び出しとほぼ同じくらい簡単です。
$point = new Routeguide\Point();
$point->setLatitude(409146138);
$point->setLongitude(-746188906);
list($feature, $status) = $client->GetFeature($point)->wait();
ご覧のとおり、リクエストオブジェクト、つまり Routeguide\Point オブジェクトを作成してポピュレートします。次に、スタブのメソッドを呼び出し、リクエストオブジェクトを渡します。エラーがない場合、レスポンスオブジェクト、つまり Routeguide\Feature オブジェクトからサーバーからのレスポンス情報を読み取ることができます。
print sprintf("Found %s \n at %f, %f\n", $feature->getName(),
$feature->getLocation()->getLatitude() / COORD_FACTOR,
$feature->getLocation()->getLongitude() / COORD_FACTOR);
ストリーミングRPC
次に、ストリーミングメソッドを見てみましょう。ここでは、地理的な Feature のストリームを返すサーバーサイドストリーミングメソッド ListFeatures を呼び出します。
$lo_point = new Routeguide\Point();
$hi_point = new Routeguide\Point();
$lo_point->setLatitude(400000000);
$lo_point->setLongitude(-750000000);
$hi_point->setLatitude(420000000);
$hi_point->setLongitude(-730000000);
$rectangle = new Routeguide\Rectangle();
$rectangle->setLo($lo_point);
$rectangle->setHi($hi_point);
$call = $client->ListFeatures($rectangle);
// an iterator over the server streaming responses
$features = $call->responses();
foreach ($features as $feature) {
// process each feature
} // the loop will end when the server indicates there is no more responses to be sent.
$call->responses() メソッドの呼び出しはイテレータを返します。サーバーがレスポンスを送信すると、foreach ループで $feature オブジェクトが返され、サーバーがこれ以上レスポンスがないことを示すまで続きます。
クライアントサイドストリーミングメソッド RecordRoute も同様ですが、クライアント側から書き込みたい各ポイントに対して $call->write($point) を呼び出し、Routeguide\RouteSummary を取得するという点が異なります。
$call = $client->RecordRoute();
for ($i = 0; $i < $num_points; $i++) {
$point = new Routeguide\Point();
$point->setLatitude($lat);
$point->setLongitude($long);
$call->write($point);
}
list($route_summary, $status) = $call->wait();
最後に、双方向ストリーミングRPC routeChat() を見てみましょう。この場合、メソッドにコンテキストを渡すだけで、BidiStreamingCall ストリームオブジェクトが返され、これを使用してメッセージの書き込みと読み取りの両方を行うことができます。
$call = $client->RouteChat();
クライアントからメッセージを書き込むには。
foreach ($notes as $n) {
$point = new Routeguide\Point();
$point->setLatitude($lat = $n[0]);
$point->setLongitude($long = $n[1]);
$route_note = new Routeguide\RouteNote();
$route_note->setLocation($point);
$route_note->setMessage($message = $n[2]);
$call->write($route_note);
}
$call->writesDone();
サーバーからメッセージを読み取るには。
while ($route_note_reply = $call->read()) {
// process $route_note_reply
}
各サイドは、相手のメッセージを書き込まれた順序で常に受信します。クライアントとサーバーは任意の順序で読み書きできます。ストリームは完全に独立して動作します。