Gestori messaggi HttpClient nell'API Web di ASP.NET

Un gestore di messaggi è una classe che riceve una richiesta HTTP e restituisce una risposta HTTP.

In genere, una serie di gestori di messaggi viene concatenata. Il primo gestore riceve una richiesta HTTP, esegue un'elaborazione e assegna la richiesta al gestore successivo. A un certo punto, la risposta viene generata e risale la catena. Questo modello è denominato gestore di delega .

Sul lato client, la classe HttpClient usa un gestore di messaggi per elaborare le richieste. Il gestore predefinito è HttpClientHandler, che invia la richiesta in rete e ottiene la risposta dal server. È possibile inserire gestori di messaggi personalizzati nella pipeline client:

Gestori di messaggi personalizzati

Per scrivere un gestore di messaggi personalizzato, derivare da System.Net.Http.DelegatingHandler ed eseguire l'override del metodo SendAsync . Ecco la firma del metodo:

Task<HttpResponseMessage> SendAsync(
    HttpRequestMessage request, CancellationToken cancellationToken);

Il metodo accetta HttpRequestMessage come input e restituisce in modo asincrono un HttpResponseMessage. Un'implementazione tipica esegue le operazioni seguenti:

1. Elaborare il messaggio di richiesta.
2. Chiamare base.SendAsync per inviare la richiesta al gestore interno.
3. Il gestore interno restituisce un messaggio di risposta. Questo passaggio è asincrono.
4. Elaborare la risposta e restituirla al chiamante.

L'esempio seguente mostra un gestore di messaggi che aggiunge un'intestazione personalizzata alla richiesta in uscita:

class MessageHandler1 : DelegatingHandler
{
    private int _count = 0;

    protected override Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
    {
        System.Threading.Interlocked.Increment(ref _count);
        request.Headers.Add("X-Custom-Header", _count.ToString());
        return base.SendAsync(request, cancellationToken);
    }
}

La chiamata a base.SendAsync è asincrona. Se il gestore esegue operazioni dopo questa chiamata, usare la parola chiave await per riprendere l'esecuzione al termine del metodo. L'esempio seguente mostra un gestore che registra i codici di errore. La registrazione di log stessa non è molto interessante, ma l'esempio mostra come accedere alla risposta all'interno del gestore.

class LoggingHandler : DelegatingHandler
{
    StreamWriter _writer;

    public LoggingHandler(Stream stream)
    {
        _writer = new StreamWriter(stream);
    }

    protected override async Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
    {
        var response = await base.SendAsync(request, cancellationToken);

        if (!response.IsSuccessStatusCode)
        {
            _writer.WriteLine("{0}\t{1}\t{2}", request.RequestUri, 
                (int)response.StatusCode, response.Headers.Date);
        }
        return response;
    }

    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            _writer.Dispose();
        }
        base.Dispose(disposing);
    }
}

Aggiunta di gestori di messaggi alla pipeline client

Per aggiungere gestori personalizzati a HttpClient, usare il metodo HttpClientFactory.Create :

HttpClient client = HttpClientFactory.Create(new Handler1(), new Handler2(), new Handler3());

I gestori di messaggi vengono chiamati nell'ordine in cui vengono passati nel metodo Create . Poiché i gestori sono annidati, il messaggio di risposta si sposta nell'altra direzione. Ovvero, l'ultimo gestore è il primo a ottenere il messaggio di risposta.