Configuration de gRPC pour .NET

Configurer les options des services

Les services gRPC sont configurés avec AddGrpc dans Startup.cs. Les options de configuration se trouvent dans le package Grpc.AspNetCore.Server.

Le tableau suivant décrit les options de configuration des services gRPC :

Les options peuvent être configurées pour tous les services en fournissant un délégué d’options à l’appel AddGrpc dans Startup.ConfigureServices :

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
    });
}

Les options d’un service unique remplacent les options globales fournies dans AddGrpc et peuvent être configurées à l’aide de 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
    });
}

Les intercepteurs de service ont une durée de vie par requête par défaut. L’inscription du type d’intercepteur auprès de la DI remplace la façon dont un intercepteur est créé et sa durée de vie.

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

Options de serveur ASP.NET Core

Grpc.AspNetCore.Server est hébergé par un serveur web ASP.NET Core. Il existe un certain nombre d’options pour les serveurs ASP.NET Core, notamment Kestrel, IIS et HTTP.sys. Chaque serveur offre des options supplémentaires pour la façon dont les requêtes HTTP sont traitées.

Le serveur utilisé par une application ASP.NET Core est configuré dans le code de démarrage de l’application. Le serveur par défaut est Kestrel.

Pour plus d’informations sur les différents serveurs et leurs options de configuration, consultez :

• Serveur web Kestrel dans ASP.NET Core
• Implémentation de serveur web HTTP.sys dans ASP.NET Core
• Héberger ASP.NET Core sur Windows avec IIS

Configurer les options du client

La configuration du client gRPC est définie sur GrpcChannelOptions. Les options de configuration se trouvent dans le package Grpc.Net.Client.

Le tableau suivant décrit les options de configuration des canaux gRPC :

Le code suivant :

• Définit la taille maximale des messages d’envoi et de réception sur le canal.
• Crée un client.

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);
}

Notez que les intercepteurs clients ne sont pas configurés avec GrpcChannelOptions. Au lieu de cela, ils sont configurés à l’aide de la méthode d’extension Intercept avec un canal. Cette méthode d’extension se trouve dans l’espace de noms 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);
}

Options du gestionnaire System.Net

Grpc.Net.Client utilise un transport HTTP dérivé de HttpMessageHandler pour effectuer des requêtes HTTP. Chaque gestionnaire offre des options supplémentaires pour la façon dont les requêtes HTTP sont effectuées.

Le gestionnaire est configuré sur un canal et peut être remplacé en définissant GrpcChannelOptions.HttpHandler. .NET Core 3 et .NET 5 et versions ultérieures utilisent SocketsHttpHandler par défaut. Les applications clientes gRPC sur .NET Framework doivent configurer WinHttpHandler.

Pour plus d’informations sur les différents gestionnaires et leurs options de configuration, consultez :

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

Ressources supplémentaires

• Services gRPC avec ASP.NET Core
• Appeler les services gRPC avec le client .NET
• Journalisation et diagnostics dans gRPC sur .NET
• Créer un serveur et un client gRPC .NET Core dans ASP.NET Core