Evansを使ったGolang × gRPC開発
2022.11.17
gRPCを用いたAPIサーバー開発
gRPCはgoogle社が開発したRPC通信のひとつで、マイクロサービス間での通信や速度が求められる場合によく使用されます。
gRPCではデータ転送のシリアライズフォーマットとしてProtocol Buffersを採用しており、protoファイルというIDLを記述しコンパイルすると、任意の言語のクライアント・サーバー用のコードを自動で生成してくれる優れものです。
またスキーマファーストの開発となるため、API仕様書が無くてもprotoファイルを見れば分かるといった開発ができることもメリットの1つとなります。
しかしREST APIであれば動作確認する場合にCurlやPostmanなどを使って簡単に動作確認ができますが、gRPCの場合はバイナリベースのため人間が目視して確認するには専用のクライアントツールを使う必要があります。
そこで本記事ではサンプルで作った簡単なgRPC APIサーバーに対して、EvansというgRPCクライアントツールを使って動作確認をする方法を説明していこうと思います。
Evansとは
改めてEvansとはgRPC向けサードパーティクライアントツールになります。
他にもgRPC公式のgrpc_cliや特に有名なgRPCurlなどがあります。
その中でもEvansは他と比べて特徴的なのが、REPLモードとCLIモードの2つを提供していることが挙げられます。
REPLモード
最大の特徴であるREPLモードは他のクライアントツールにはない、インタラクティブなUIでサーバーとやりとりをすることが出来ます。
参考: 公式Github
使い方は後ほど説明しますが、実際に使ってみると非常に使いやすいです。
予測補完機能が優秀で次に何を入力すればいいか、選択肢は何があるかなどを画面上に従って入力するだけで使用することができます。
そのためAPI名なんだっけ...といったことはなく使い慣れていない場合でもサクサクと動作確認をすることができます。
CLIモード
CLIモードは他のgrpc_cliやgRPCurlと同じような、非インタラクティブなUIによる操作モードになります。
参考: 公式Github
使い方としてはコマンドラインからサービスやAPI名を入力してリクエストを送るとJSON形式でレスポンスを取得することができます。
ある程度慣れていればこちらの方が素速く使うことができますし、レスポンスがJSONで手に入るため他のコマンドラインを組み合わせることで様々な加工がしやすくCLIモードを使うことも非常に多いかと思います。
今回使うAPIサーバーのサンプル
ここからは簡単なgRPCのAPIサーバーを作って、実際にEvansを使って動作確認をしてみたいと思います。
従業員取得API
今回は従業員(Employee)のデータを返すAPIを作成しました。gRPCの開発は本記事の主旨ではないためどのようなAPIを作ったのかだけ簡単に説明いたします。
protoファイルは以下の通りです。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | syntax = "proto3"; package proto.employee; option go_package = "gen/api"; service EmployeeService { rpc Employee (EmployeeRequest) returns (EmployeeResponse); rpc Employees (EmployeesRequest) returns (EmployeesResponse); rpc EmployeesByType (EmployeesByTypeRequest) returns (EmployeesByTypeResponse); } enum EmployeeType { FullTime = 0; PartTime = 1; } message Employee { int64 id = 1; string name = 2; int32 age = 3; EmployeeType type = 4; } message EmployeeRequest { int64 id = 1; } message EmployeeResponse { Employee employee = 1; } message EmployeesRequest {} message EmployeesResponse { repeated Employee employees = 1; } message EmployeesByTypeRequest { EmployeeType employeeType = 1; } message EmployeesByTypeResponse { repeated Employee employees = 1; } |
また従業員データはダミーデータとして以下のようにべた書きしています。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | func employeeList() []*api.Employee { return []*api.Employee{ { Id: 1, Name: "Yamada", Age: 20, Type: api.EmployeeType_FullTime, }, { Id: 2, Name: "Suzuki", Age: 25, Type: api.EmployeeType_PartTime, }, { Id: 3, Name: "Sasaki", Age: 45, Type: api.EmployeeType_FullTime, }, } } |
Employee (従業員情報)
従業員情報にはID、名前、年齢、雇用形態の4つの情報を持ちます。
雇用形態はEnum型で正社員とパートの2パターンあります。
1 2 3 4 5 6 7 8 9 10 11 | message Employee { int64 id = 1; string name = 2; int32 age = 3; EmployeeType type = 4; } enum EmployeeType { FullTime = 0; PartTime = 1; } |
ServiceとRPCメソッド
従業員情報に関して1件取得、全件取得、雇用形態別に取得の3種類となります。
1 2 3 4 5 | service EmployeeService { rpc Employee (EmployeeRequest) returns (EmployeeResponse); rpc Employees (EmployeesRequest) returns (EmployeesResponse); rpc EmployeesByType (EmployeesByTypeRequest) returns (EmployeesByTypeResponse); } |
Evansを使ってAPIコールする
では早速Evansを使って実際に動作確認をやってみようと思います。
Evansのインストール
まずはEvansをHomebrewを使ってインストールします。
1 2 | brew tap ktr0731/evans brew install evans |
バージョン確認をして表示されればインストール完了となります。
1 2 | $ evans -v evans 0.10.9 |
また本記事ではEvansバージョン0.10.9を使っていきます。
コマンドとオプション
Evansに準備されている代表的なコマンドとオプションの一覧です。
| コマンド | 説明 |
| repl | REPLモードで実行する |
| cli | CLIモードで実行する |
| オプション | 説明 |
| --proto | protoファイルのパスを指定する |
| --host | gRPCサーバーのホストを指定 |
| --port, -p | gRPCサーバーのポートを指定 (default "50051") |
| --reflection, -r | gRPC reflectionを使用している場合 (default "false") |
gRPC リフレクションについて
基本的には--protoオプションを使って定義元となるProtocol Buffersファイルを指定する必要があるのですが、実際の開発現場では大量のファイルが作られることがほとんどです。
そうなってくると毎回個別に指定するのは非常に面倒になります。
そこでgRPCの公式が用意しているリフレクションの設定をサーバー側で登録していれば、毎回Protocol BuffersのIDLを直接的に読み込まずにメソッドを呼び出すことが出来るようになります。
今回もサーバー起動時にリフレクションの登録をしているためprotoの指定はせずに -r オプションを指定して実行していきます。
REPLモード
まずはREPLモードを使って動作確認してみます。
REPLモードとリフレクションオプションを指定して実行すると、このようにインタラクティブモードで立ち上がります。
1 2 3 4 5 6 7 8 9 10 11 | ＄ evans -r repl ______ | ____| | |__ __ __ __ _ _ __ ___ | __| \ \ / / / _. | | '_ \ / __| | |____ \ V / | (_| | | | | | \__ \ |______| \_/ \__,_| |_| |_| |___/ more expressive universal gRPC client proto.employee.EmployeeService@127.0.0.1:50051> |
RPCの実行をするためにはpackageとserviceを指定し、最後に実行するRPCメソッドを選びます。
1 2 3 4 5 | proto.employee.EmployeeService@127.0.0.1:50051> package proto.employee proto.employee@127.0.0.1:50051> service EmployeeService proto.employee.EmployeeService@127.0.0.1:50051> call Employee |
途中はこのように入力の補完候補が出てくるため覚えたりコピペしてくる必要さえありません。
最後にrequestの引数である従業員IDを入力して実行すると
1 2 3 4 5 6 7 8 9 | proto.employee.EmployeeService@127.0.0.1:50051> call Employee id (TYPE_INT64) => 1 { "employee": { "age": 20, "id": "1", "name": "Yamada" } } |
このように従業員情報を取得することができました。
もし引数がEnum型の場合は選択肢が出てきます。
1 2 3 4 5 | proto.employee.EmployeeService@127.0.0.1:50051> call EmployeesByType Use the arrow keys to navigate: ↓ ↑ → ← ? employeeType (TYPE_ENUM) => ▸ FullTime PartTime |
他にもshowコマンドやdescコマンドで一覧や詳細情報を表示することも可能です。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | proto.employee.EmployeeService@127.0.0.1:50051> show message +-------------------------+ | MESSAGE | +-------------------------+ | EmployeeRequest | | EmployeeResponse | | EmployeesByTypeRequest | | EmployeesByTypeResponse | | EmployeesRequest | | EmployeesResponse | +-------------------------+ proto.employee.EmployeeService@127.0.0.1:50051> desc EmployeeRequest +-------+------------+----------+ | FIELD | TYPE | REPEATED | +-------+------------+----------+ | id | TYPE_INT64 | false | +-------+------------+----------+ |
CLIモード
今度は同じようにCLIモードで実行していきます。
CLIの場合はevans cli [package].[service].[rpc method]のフォーマットで実行するメソッドを指定します。
例えば全従業員情報を取得する場合はこのようになります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | echo '{}' | evans -r cli proto.employee.EmployeeService.Employees { "employees": [ { "age": 20, "id": "1", "name": "Yamada" }, { "age": 25, "id": "2", "name": "Suzuki", "type": "PartTime" }, { "age": 45, "id": "3", "name": "Sasaki" } ] } |
もし引数が必要なAPIの場合はechoとパイプを使って渡すことが出来ます。
1 2 3 4 5 6 7 8 | echo '{"id": 1}' | evans -r cli proto.employee.EmployeeService.Employee { "employee": { "age": 20, "id": "1", "name": "Yamada" } } |
これでモード別の動作確認は以上となります。
さいごに
今回はEvansというgRPCクライアントツールを使ってgRPCのAPIを動かしてみることができました。
REPLモードとCLIモードを使ってみた感想としては、どちらを使うかは一長一短あるためケースバイケースかなと思いました。
例えばPRを出してレビュアーに動作確認をして欲しい場合は、CLIモード用にコマンドを準備してあげた方がより早く確認することができるかと思いますし、自分で開発中に動かすのであればREPLモードの方が柔軟で楽に確認ができるため状況に応じて使い分けたらいいかと思います。
ぜひEvansを使ってgRPC開発を楽しんでください！
書いた人はこんな人
- 「好きを仕事にするエンジニア集団」の（株）ライトコードです！
ライトコードは、福岡、東京、大阪の3拠点で事業展開するIT企業です。
現在は、国内を代表する大手IT企業を取引先にもち、ITシステムの受託事業が中心。
いずれも直取引で、月間PV数1億を超えるWebサービスのシステム開発・運営、インフラの構築・運用に携わっています。
システム開発依頼・お見積もり大歓迎！
また、現在「WEBエンジニア」「モバイルエンジニア」「営業」「WEBデザイナー」「WEBディレクター」を積極採用中です！
インターンや新卒採用も行っております。
以下よりご応募をお待ちしております！
https://rightcode.co.jp/recruit
- ライトコードの日常12月 1, 2023ライトコードクエスト〜東京オフィス歴史編〜
- ITエンタメ10月 13, 2023Netflixの成功はレコメンドエンジン？
- ライトコードの日常8月 30, 2023退職者の最終出社日に密着してみた！
- ITエンタメ8月 3, 2023世界初の量産型ポータブルコンピュータを開発したのに倒産!?アダム・オズボーン
関連記事
採用情報
\ あの有名サービスに参画!? /
バックエンドエンジニア
\ クリエイティブの最前線 /
フロントエンドエンジニア
\ 世界を変える…！ /
Androidエンジニア
\ みんなが使うアプリを創る /
iOSエンジニア
