.NET 構成のための gRPC

サービス オプションを構成する

gRPC サービスは、Startup.cs の AddGrpc によって構成されます。 構成オプションは、Grpc.AspNetCore.Server パッケージに含まれています。

次の表では、gRPC サービスを構成するためのオプションについて説明します。

Startup.ConfigureServices の AddGrpc 呼び出しに対して options デリゲートを指定することで、すべてのサービスに対してオプションを構成できます。

public void ConfigureServices(IServiceCollection services)
{
    services.AddGrpc(options =>
    {
        options.EnableDetailedErrors = true;
        options.MaxReceiveMessageSize = 2 * 1024 * 1024; // 2 MB
        options.MaxSendMessageSize = 5 * 1024 * 1024; // 5 MB
    });
}

1 つのサービスのオプションは、AddGrpc で提供されるグローバル オプションをオーバーライドします。また、AddServiceOptions<TService> を使用して構成することができます。

public void ConfigureServices(IServiceCollection services)
{
    services.AddGrpc().AddServiceOptions<MyService>(options =>
    {
        options.MaxReceiveMessageSize = 2 * 1024 * 1024; // 2 MB
        options.MaxSendMessageSize = 5 * 1024 * 1024; // 5 MB
    });
}

サービス インターセプターには、既定により要求ごとの有効期間があります。 インターセプター型を DI に登録すると、インターセプターの作成方法とその有効期間がオーバーライドされます。

public void ConfigureServices(IServiceCollection services)
{
    services.AddGrpc(options =>
    {
        options.Interceptors.Add<LoggingInterceptor>();
    });
    services.AddSingleton<LoggingInterceptor>();
}

ASP.NET Core サーバー オプション

Grpc.AspNetCore.Server は、ASP.NET Core Web サーバーによってホストされます。 ASP.NET Core サーバーには、さまざまなオプションがあります (Kestrel、IIS、HTTP.sys など)。 各サーバーには、HTTP 要求の処理方法として追加のオプションが用意されています。

ASP.NET Core アプリで使用されるサーバーは、アプリのスタートアップ コードで構成されます。 既定のサーバーは、Kestrel です。

各種のサーバーおよびそれらの構成オプションについては、以下を参照してください。

• ASP.NET Core の Kestrel Web サーバー
• ASP.NET Core での HTTP.sys Web サーバーの実装
• IIS を使用した Windows での ASP.NET Core のホスト

クライアント オプションを構成する

gRPC のクライアント構成は GrpcChannelOptions で設定されます。 構成オプションは、Grpc.Net.Client パッケージに含まれています。

次の表では、gRPC チャネルを構成するためのオプションについて説明します。

コード例を次に示します。

• チャネルで送受信する最大メッセージ サイズを設定します。
• クライアントを作成します。

static async Task Main(string[] args)
{
    var channel = GrpcChannel.ForAddress("https://localhost:5001", new GrpcChannelOptions
    {
        MaxReceiveMessageSize = 5 * 1024 * 1024, // 5 MB
        MaxSendMessageSize = 2 * 1024 * 1024 // 2 MB
    });
    var client = new Greeter.GreeterClient(channel);

    var reply = await client.SayHelloAsync(
                      new HelloRequest { Name = "GreeterClient" });
    Console.WriteLine("Greeting: " + reply.Message);
}

クライアントのインターセプターは GrpcChannelOptions を使用せずに構成されていることに注意してください。 クライアントのインターセプターは、チャンネルの拡張メソッド Intercept を使用して構成されています。 この拡張メソッドは Grpc.Core.Interceptors 名前空間に存在します。

static async Task Main(string[] args)
{
    var channel = GrpcChannel.ForAddress("https://localhost:5001");
    var callInvoker = channel.Intercept(new LoggingInterceptor());
    var client = new Greeter.GreeterClient(callInvoker);

    var reply = await client.SayHelloAsync(
                      new HelloRequest { Name = "GreeterClient" });
    Console.WriteLine("Greeting: " + reply.Message);
}

System.Net handler オプション

Grpc.Net.Client では、HttpMessageHandler から派生した HTTP トランスポートを使用して、HTTP 要求を行います。 各ハンドラーには、HTTP 要求を行うための追加のオプションが用意されています。

ハンドラーはチャネル上で構成され、GrpcChannelOptions.HttpHandler を設定することによってオーバーライドできます。 既定では、.NET Core 3 と、.NET 5 またはそれ以降で SocketsHttpHandler が使用されます。 .NET Framework 上の gRPC クライアントアプリでは、WinHttpHandler を構成する必要があります。

各種のハンドラーおよびそれらの構成オプションについては、以下を参照してください。

• System.Net.Http.SocketsHttpHandler
• System.Net.Http.WinHttpHandler

その他のリソース

• ASP.NET Core を使用した gRPC サービス
• .NET クライアントを使用して gRPC サービスを呼び出す
• .NET での gRPC のログ記録と診断
• ASP.NET Core で .NET Core gRPC のクライアントとサーバーを作成する