Connectを使用したgRPCサーバーでReflection APIを有効にする方法

はじめに

最近、connectrpc.com/connectを使用してgRPCサービスを開発する際、gRPC UIツールで「Failed to compute set of methods to expose: server does not support the reflection API」というエラーに直面しました。この問題は、Connectを使ったgRPCサーバーでReflection APIが有効になっていないために発生します。この記事では、Connectを使用してgRPCサーバーを構築する際にReflectionを有効にする方法を紹介します。

Connectとは？

Connectは、gRPCとHTTP/2をサポートする軽量なGoライブラリで、net/httpサーバーでの使用に最適化されています。しかし、Connectを使用するときには、通常のgRPCサーバーとは異なる方法でReflectionを設定する必要があります。

Reflectionの必要性

gRPC Reflectionは、サーバー上のサービスやメソッドを動的に発見するために使用されます。これにより、grpcuiのようなツールがスキーマのコピーなしにリクエストを送信し、レスポンスを表示できるようになります。

了解しました。その部分を記事に追加してみましょう：

解決策: grpcreflectの使用

connectrpc.com/grpcreflectは、任意のnet/httpサーバー（Connectを含む）にgRPCサーバーのリフレクションAPIを追加するために使用します。以下は、grpcreflectを使用してReflection APIを有効にする方法の例です：

package main

import (
  "net/http"

  "golang.org/x/net/http2"
  "golang.org/x/net/http2/h2c"
  "connectrpc.com/grpcreflect"
)

func main() {
  mux := http.NewServeMux()
  reflector := grpcreflect.NewStaticReflector(
    // buf.build/connectrpc/goで生成されたサービス名を使用します
    // 例えば、group.connect.go内で定義されているGroupServiceName定数:
    // const GroupServiceName = "acme.group.v1.GroupService"
    "acme.user.v1.UserService",
    "acme.group.v1.GroupService",
  )
  mux.Handle(grpcreflect.NewHandlerV1(reflector))
  mux.Handle(grpcreflect.NewHandlerV1Alpha(reflector))
  http.ListenAndServe(
    ":8080",
    h2c.NewHandler(mux, &http2.Server{}),
  )
}

このコードでは、grpcreflect.NewStaticReflectorを使用して静的リフレクターを作成し、サーバーに登録しています。リフレクターに渡すサービス名は、buf.build/connectrpc/goで生成されたファイル（例：group.connect.go）内の定数（例：GroupServiceName）を参照しています。その後、Reflection APIのハンドラーをHTTPマルチプレクサに追加しています。

まとめ

Connectを使用してgRPCサーバーを構築する場合、grpcreflectを使用してReflection APIを有効にすることで、grpcuiなどのデバッグツールが動的にサービスを発見できるようになります。これにより、開発プロセスがよりスムーズになり、効率的なデバッグが可能になります。

Connectを使ったgRPCサーバーの構築は、従来のgRPCサーバーのセットアップとは少し異なるアプローチを必要としますが、grpcreflectを使うことで、リフレクションAPIの設定は非常に簡単です。この機能を活用することで、多くの開発者がより効率的にgRPCベースのアプリケーションを開発できるようになることを願っています。