HttpClient-Nachrichtenhandler in ASP.NET Web-API

Ein Nachrichtenhandler ist eine Klasse, die eine HTTP-Anforderung empfängt und eine HTTP-Antwort zurückgibt.

In der Regel werden eine Reihe von Nachrichtenhandlern miteinander verkettet. Der erste Handler empfängt eine HTTP-Anforderung, führt eine Verarbeitung durch und gibt die Anforderung an den nächsten Handler weiter. Irgendwann wird die Antwort erstellt und geht zurück in die Kette. Dieses Muster wird als delegierender Handler bezeichnet.

Auf clientseitiger Seite verwendet die HttpClient-Klasse einen Nachrichtenhandler zum Verarbeiten von Anforderungen. Der Standardhandler ist HttpClientHandler, der die Anforderung über das Netzwerk sendet und die Antwort vom Server abruft. Sie können benutzerdefinierte Nachrichtenhandler in die Clientpipeline einfügen:

Benutzerdefinierte Nachrichtenhandler

Um einen benutzerdefinierten Nachrichtenhandler zu schreiben, leiten Sie von System.Net.Http.DelegatingHandler ab und überschreiben Sie die SendAsync-Methode. Dies ist die Methodensignatur:

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

Die Methode verwendet eine HttpRequestMessage als Eingabe und gibt asynchron eine HttpResponseMessage zurück. Eine typische Implementierung führt folgende Aktionen aus:

1. Verarbeiten sie die Anforderungsnachricht.
2. Rufen Sie base.SendAsync auf, um die Anforderung an den inneren Handler zu senden.
3. Der innere Handler gibt eine Antwortnachricht zurück. (Dieser Schritt ist asynchron.)
4. Verarbeiten Sie die Antwort, und geben Sie sie an den Aufrufer zurück.

Das folgende Beispiel zeigt einen Nachrichtenhandler, der der ausgehenden Anforderung einen benutzerdefinierten Header hinzufügt:

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

Der Aufruf an base.SendAsync ist asynchron. Wenn der Handler nach diesem Aufruf arbeitet, verwenden Sie das Await-Schlüsselwort, um die Ausführung nach Abschluss der Methode fortzusetzen. Das folgende Beispiel zeigt einen Handler, der Fehlercodes protokolliert. Die Protokollierung selbst ist nicht sehr interessant, aber das Beispiel zeigt, wie Sie die Antwort innerhalb des Handlers abrufen.

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

Hinzufügen von Nachrichtenhandlern zur Clientpipeline

Um benutzerdefinierte Handler zu HttpClient hinzuzufügen, verwenden Sie die HttpClientFactory.Create-Methode :

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

Nachrichtenhandler werden in der Reihenfolge aufgerufen, in der Sie sie an die Create-Methode übergeben. Da Handler geschachtelt sind, wird die Antwortnachricht in die andere Richtung verschoben. Das heißt, der letzte Handler erhält als erster die Antwortnachricht.