// Protocol Buffersバージョン3での記述であることを宣言する
syntax = "proto3";


// message = やり取りするデータのこと
message ＜CamelCase定義するメッセージ型の名前＞ {
  ＜型＞ ＜snake_caseフィールド名1＞ = ＜そのフィールドに紐づける一意なフィールド番号＞;
  ＜型＞ ＜snake_caseフィールド名2＞ = ＜そのフィールドに紐づける一意なフィールド番号＞;
  ＜型＞ ＜snake_caseフィールド名3＞ = ＜そのフィールドに紐づける一意なフィールド番号＞;
  ：
  ：
}

/*
プロシージャ名は実行する処理（リモートプロシージャ）を識別するための文字列で、
いわゆる関数名に相当
*/
service ＜サービス名＞ {
  rpc ＜プロシージャ名1＞ (＜引数として受け取るメッセージ型＞) returns (＜戻り値として返すメッセージ型＞) {}
  rpc ＜プロシージャ名2＞ (＜引数として受け取るメッセージ型＞) returns (＜戻り値として返すメッセージ型＞) {}
  ：
  ：
}

syntax = "proto3";

// ユーザー情報を表すメッセージ型
message User {
  uint32 id = 1;
  string nickname = 2;
  string mail_address = 3;
  enum UserType {
    NORMAL = 0;
    ADMINISTRATOR = 1;
    GUEST = 2;
    DISABLED = 3;
  }
  UserType user_type = 4;
}

// ユーザー情報のリクエストに使用するメッセージ型
message UserRequest {
  uint32 id = 1;
}

// ユーザー情報を返す際に使用するメッセージ型
message UserResponse {
  bool error = 1;
  string message = 2;
  User user = 3;
}

// ユーザー管理を行うサービス
service UserManager {
  // ユーザー情報を取得する
  rpc GetUser (UserRequest) returns (UserResponse) {}
}

$ python -m grpc_tools.protoc -I./protos --python_out=. --grpc_python_out=. ./protos/user.proto
$ ls
user_pb2.py  user_pb2_grpc.py protos

# gRPCのサーバー実装ではThreadPoolを利用するので、そのためのモジュールをimportしておく
from concurrent.futures import ThreadPoolExecutor
import json

# 「grpc」パッケージと、grpc_tools.protocによって生成したパッケージをimportする
import grpc
import user_pb2
import user_pb2_grpc

# ユーザー情報の読み込み
with open("./users.json") as fp:
    users = json.load(fp)

# サービス定義から生成されたクラスを継承して、定義したリモートプロシージャに対応するメソッドを実装する
class UserManager(user_pb2_grpc.UserManagerServicer):
    def GetUser(self, request, context):
        """
        ユーザー情報を取得する
        """
        # クライアントが送信した引数はrequest引数に格納され、
        # このオブジェクトに対しては一般的なPythonオブジェクトと
        # 同様の形でプロパティにアクセスできる
        user_id = request.id

        # ユーザー情報はユーザーIDを文字列に変換したものをキーとする辞書型データ
        # なので、適宜文字列型に変換して使用している
        if str(user_id) not in users:
            # 該当するユーザーが存在しない場合エラーを返す
            return user_pb2.UserResponse(error=True,
                                         message="not found")
        user = users[str(user_id)]

        # 戻り値として返すUserオブジェクトを作成する
        result = user_pb2.User()
        result.id = user["id"]
        result.nickname = user["nickname"]
        result.mail_address = user["mail_address"]
        result.user_type = user_pb2.User.UserType.Value(user["user_type"])

        # UserResponseオブジェクトを返す
        return user_pb2.UserResponse(error=False,
                                     user=result)

def main():
    # Serverオブジェクトを作成する
    server = grpc.server(ThreadPoolExecutor(max_workers=2))

    # Serverオブジェクトに定義したServicerクラスを登録する
    user_pb2_grpc.add_UserManagerServicer_to_server(UserManager(), server)

    # 1234番ポートで待ち受けするよう指定する
    server.add_insecure_port('[::]:1234')

    # 待ち受けを開始する
    server.start()

    # 待ち受け終了後の後処理を実行する
    server.wait_for_termination()

if __name__ == '__main__':
    main()

$ evans --host localhost -p 1234 ./protos/user.proto

  ______
 |  ____|
 | |__    __   __   __ _   _ __    ___
 |  __|   \ \ / /  / _. | | '_ \  / __|
 | |____   \ V /  | (_| | | | | | \__ \
 |______|   \_/    \__,_| |_| |_| |___/

 more expressive universal gRPC client


UserManager@localhost:1234> 

UserManager@localhost:1234> show service
+-------------+---------+--------------+---------------+
|   SERVICE   |   RPC   | REQUEST TYPE | RESPONSE TYPE |
+-------------+---------+--------------+---------------+
| UserManager | GetUser | UserRequest  | UserResponse  |
+-------------+---------+--------------+---------------+

UserManager@localhost:1234> call GetUser
id (TYPE_UINT32) => 1
{
  "user": {
    "id": 1,
    "mailAddress": "admin@example.com",
    "nickname": "admin",
    "userType": "ADMINISTRATOR"
  }
}

-- サービス一覧
$ evans --proto ./protos/user.proto cli list
UserManager

-- ダウンロードしたディレクトリに移動
$ cd {BloomRPCのAppImageダウンロード先パス}
-- 実行権限を付与
$ chmod +x ./BloomRPC-{バージョン}.AppImage
-- 実行
$ ./BloomRPC-{バージョン}.AppImage

brew tap ktr0731/evans
brew install evans

$ evans --proto api.proto cli list # サービスの列挙
api.Example

$ evans --proto api.proto cli list api.Example # メソッドの列挙
api.Example.Unary

$ evans --proto api.proto cli desc api.Example.Unary # Unary というメソッドの定義を表示
api.Example.Unary:
rpc Unary ( .api.Request ) returns ( .api.Response );

$ evans --proto api.proto cli desc api.Request # Request というメッセージの定義の表示
api.Request:
message Request {
  string name = 1;
}

$ echo '{ "name": "ktr" }' | evans --proto api.proto cli call api.Example.Unary # Unary の呼び出し
{
  "message": "hello, ktr"
}

$ brew install --cask bloomrpc

-- ダウンロードしたディレクトリに移動
$ cd {BloomRPCのAppImageダウンロード先パス}
-- 実行権限を付与
$ chmod +x ./BloomRPC-{バージョン}.AppImage
-- 実行
$ ./BloomRPC-{バージョン}.AppImage

$ brew tap ktr0731/evans
$ brew install evans

-- ダウンロード後
$ tar -zxvf evans_linux_amd64.tar.gz
$ mv evans ~/.local/bin/

-- サービスの列挙
$ evans -r cli list --port 1234
ClubManager
UserManager
grpc.reflection.v1alpha.ServerReflection
-- メソッドの列挙
$ evans -r cli list --port 1234 UserManager
UserManager.AddUser
UserManager.CountAlreadyUsers
UserManager.GetUser
UserManager.GetUsersByIds
UserManager.GetUsersByType
-- 特定のメソッドの定義確認
$ evans -r cli desc --port 1234 UserManager.AddUser
UserManager.AddUser:
rpc AddUser ( .User ) returns ( .UserResponse );