メインコンテンツへスキップ

gRPC の採用と API Gateway による HTTP / JSON 変換の話

    はじめに

    こんにちは。UltraImpression の技術担当です。

    UltraImpression のプラットフォーム開発チームでは、複数のサービスが連携する際の通信方式として gRPC を採用しています。gRPC は Google が開発した RPC(Remote Procedure Call)フレームワークで、Protocol Buffers(protobuf)を用いたインターフェースへの厳密な型付けと、さまざまな言語に対応したコード生成、バイナリシリアライズによる軽量な処理など、さまざまなメリットがあります。

    Protocol Buffers と gRPC 通信
    Protocol Buffers と gRPC 通信

    しかし、gRPC はバックエンド同士の通信には適していますが、フロントエンドとの通信には向いていません。なぜなら、多くのブラウザや API クライアントは gRPC を直接サポートしていないためです。そのため、UltraImpression では Google Cloud の API Gateway を利用して HTTP / JSON への変換を行っています。本記事では、その具体的な実装方法と、メリット・デメリットについて解説します。

    HTTP / JSON から gRPC への変換
    HTTP / JSON から gRPC への変換

    Google Cloud API Gateway とは

    Google Cloud の API Gateway は、Google Cloud 上で提供されるフルマネージドな API 管理サービスです。REST や gRPC を含むバックエンドへのルーティング、認証、アクセス制御、レート制限、ロギングなどの機能を備えており、大規模なサービスの一元的な API 管理を可能にします。

    API Gateway の主な機能の一つに、gRPC サービスを HTTP / JSON 経由で呼び出せるようにする変換機能があります。これにより、gRPC サーバーをそのまま保持しながらも、外部向けには REST API として提供することができます。


    この変換機能の詳細は、API Gateway ではなく Cloud Endpoints のドキュメントに記述されています。Cloud Endpoints は API Gateway 以前から提供されているサービスであり、API Gateway は内部的には Cloud Endpoints の技術をベースとしています。
    HTTP/JSON の gRPC へのコード変換  |  Cloud Endpoints


    実装方法

    gRPC API の定義を記述する

    proto ファイルを定義し、HTTP / JSON 変換用のアノテーションとして google.api.http オプションを追加します。

    // example.proto
    syntax = "proto3";
    
    package example;
    
    import "google/api/annotations.proto";
    
    service ExampleService {
        rpc GetExample(ExampleRequest) returns (ExampleResponse) {
            option (google.api.http) = {
                get: "/example/{id}"
            };
        }
    }
    
    message ExampleRequest {
        string id = 1;
    }
    
    message ExampleResponse {
        string data = 1;
    }

    gRPC API の定義からコードを生成する

    protoc コマンドを使って、使用する言語のコードを生成します。以下は Go 言語を使う場合のコマンド例です。

    $ protoc \
      --proto_path=. \
      --descriptor_set_out=api_descriptor.pb \
      --go_out=${dest} \
      --go-grpc_out=${dest} \
      --grpc-gateway_out=${dest} \
      --include_imports \
      --include_source_info \
      example.proto

    Go 言語では以下のように interface のみが生成されます。バックエンドとして使用する gRPC サーバーで interface を実装します。

    // example.pb.go
    type ExampleServiceServer interface {
    	GetExample(context.Context, *ExampleRequest) (*ExampleResponse, error)
    }
    
    type ExampleRequest struct {
    	state         protoimpl.MessageState
    	sizeCache     protoimpl.SizeCache
    	unknownFields protoimpl.UnknownFields
    
    	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    }
    
    type ExampleResponse struct {
    	state         protoimpl.MessageState
    	sizeCache     protoimpl.SizeCache
    	unknownFields protoimpl.UnknownFields
    
    	data string `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
    }

    API Gateway の Config を生成する

    API Gateway の Config を上記の protoc で生成したプロトコルバッファ記述子(descriptor)と gRPC サービスの構成ファイルを使って生成します。

    gRPC サービスの構成ファイルは YAML で記述します。バックエンドのアドレスと API のサービス名を定義しておきましょう。

    # api_config.yaml
    type: google.api.Service
    config_version: 3
    
    name: "*.apigateway.PROJECT_ID.cloud.goog"
    
    title: Example API
    apis:
      - name: example.ExampleService
    
    backend:
      rules:
        - selector: "*"
          address: grpcs://MY_GRPC_SERVER-an.a.run.app
    

    gcloud コマンドでは以下のように生成します。

    $ gcloud api-gateway api-configs create CONFIG_NAME \
      --api=API_NAME \
      --project=PROJECT_ID \
      --grpc-files=api_descriptor.pb,api_config.yaml

    フロントエンドは、この API Gateway のエンドポイントを経由することで gRPC サーバーと通信を行うことが可能になりました。

    また、protoc は OpenAPI の spec も出力することができるので、それを利用してフロントエンド向けのコードも生成しています。

    これで最初に図示した構成の完成です。

    HTTP / JSON から gRPC への変換
    (再掲)Protocol Buffers を元にすべてを連携

    メリットとデメリット

    API Gateway を活用することで、gRPC の恩恵を享受しつつ、HTTP / JSON を用いる従来のクライアントともシームレスに連携することが可能になりました。以下に、具体的なメリットとデメリット・注意点を整理します。

    メリット

    • gRPC の高性能を活かしつつ、REST API として提供可能

    • Google Cloud の API Gateway によりインフラの管理が容易

    • 認証やレート制限などのポリシーも API Gateway で統一管理できる

    デメリット・注意点

    • エラーハンドリングの違い: gRPC のステータスコードと REST API のステータスコードのマッピングに注意

    • 追加コスト: API Gateway の使用にはコストがかかる

    • レイテンシ増加: gRPC から REST への変換で若干の遅延が発生

    • 定義修正時のリリース: サービスと Config のデプロイタイミングがずれると通信エラーになる

    まとめ

    UltraImpression では、バックエンドの API 通信を gRPC で統一しつつ、フロントエンドとの通信のために Google Cloud の API Gateway を活用しています。これにより、gRPC のメリットを最大限活かしながら、広く利用される REST API として提供することが可能となります。

    gRPC を採用したいがフロントエンドとの互換性に悩んでいる場合、API Gateway を用いたアプローチは有力な選択肢となるでしょう。

     
     
    プレミアムなコンテンツへのインターネット動画広告を配信しているUltraImpression(通称:ウルプレ)の技術周りを担当しています。

    あなたへのおすすめ