Warum sollte ich IHttpActionResult anstelle von HttpResponseMessage verwenden?

Ich habe mit WebApi entwickelt und bin zu WebApi2 übergegangen, wo Microsoft eine neue Benutzeroberfläche eingeführt hat IHttpActionResult, die anscheinend empfohlen wird, über die Rückgabe von a HttpResponseMessage. Ich bin verwirrt über die Vorteile dieser neuen Schnittstelle. Es scheint hauptsächlich nur eine etwas einfachere Möglichkeit zu bieten, eine zu erstellen HttpResponseMessage.

Ich würde argumentieren, dass dies "Abstraktion um der Abstraktion willen" ist. Vermisse ich etwas Was sind die realen Vorteile, die ich durch die Verwendung dieser neuen Schnittstelle bekomme, außer vielleicht das Speichern einer Codezeile?

Alter Weg (WebApi):

public HttpResponseMessage Delete(int id)
{
    var status = _Repository.DeleteCustomer(id);
    if (status)
    {
        return new HttpResponseMessage(HttpStatusCode.OK);
    }
    else
    {
        throw new HttpResponseException(HttpStatusCode.NotFound);
    }
}

Neuer Weg (WebApi2):

public IHttpActionResult Delete(int id)
{
    var status = _Repository.DeleteCustomer(id);
    if (status)
    {
        //return new HttpResponseMessage(HttpStatusCode.OK);
        return Ok();
    }
    else
    {
        //throw new HttpResponseException(HttpStatusCode.NotFound);
        return NotFound();
    }
}

Sie können sich entscheiden, diese nicht zu verwenden, IHttpActionResultda Ihr vorhandener Code eine erstellt HttpResponseMessage, die nicht zu einer der vordefinierten Antworten passt. Sie können sich jedoch HttpResponseMessagean IHttpActionResultdie vordefinierte Antwort von anpassen ResponseMessage. Es hat eine Weile gedauert, bis ich das herausgefunden habe, also wollte ich es veröffentlichen und zeigen, dass Sie sich nicht unbedingt für das eine oder andere entscheiden müssen:

public IHttpActionResult SomeAction()
{
   IHttpActionResult response;
   //we want a 303 with the ability to set location
   HttpResponseMessage responseMsg = new HttpResponseMessage(HttpStatusCode.RedirectMethod);
   responseMsg.Headers.Location = new Uri("http://customLocation.blah");
   response = ResponseMessage(responseMsg);
   return response;
}

Hinweis: Dies ResponseMessageist eine Methode der Basisklasse ApiController, von der Ihr Controller erben soll.

Sie können immer noch verwenden HttpResponseMessage. Diese Fähigkeit wird nicht verschwinden. Ich fühlte mich genauso wie Sie und argumentierte ausführlich mit dem Team, dass keine zusätzliche Abstraktion erforderlich sei. Es gab ein paar Argumente, um seine Existenz zu rechtfertigen, aber nichts, was mich davon überzeugt hätte, dass es sich gelohnt hat.

Das heißt, bis ich dieses Beispiel von Brad Wilson gesehen habe . Wenn Sie IHttpActionResultKlassen auf eine Weise erstellen, die verkettet werden kann, können Sie eine Antwortpipeline auf Aktionsebene zum Generieren der erstellen HttpResponseMessage. Unter dem Deckmantel wird dies so ActionFiltersimplementiert, aber die Reihenfolge dieser ActionFiltersist beim Lesen der Aktionsmethode nicht offensichtlich, was ein Grund ist, warum ich kein Fan von Aktionsfiltern bin.

Indem Sie jedoch eine erstellen IHttpActionResult, die in Ihrer Aktionsmethode explizit verkettet werden kann, können Sie alle Arten von unterschiedlichen Verhaltensweisen erstellen , um Ihre Antwort zu generieren.

Hier sind einige Vorteile von IHttpActionResultüber HttpResponseMessagein den genannten Microsoft ASP.Net Dokumentation :

• Vereinfacht das Testen Ihrer Controller.
• Verschiebt die allgemeine Logik zum Erstellen von HTTP-Antworten in separate Klassen.
• Verdeutlicht die Absicht der Controller-Aktion, indem die Details der Erstellung der Antwort auf niedriger Ebene ausgeblendet werden.

Aber hier sind einige andere Vorteile der Verwendung, die es IHttpActionResultwert sind, erwähnt zu werden:

• Respektieren des Prinzips der Einzelverantwortung : Bewirken Sie, dass Aktionsmethoden für die Zustellung der HTTP-Anforderungen verantwortlich sind, und beziehen Sie sie nicht in die Erstellung der HTTP-Antwortnachrichten ein.
• Nützliche Implementierungen, die bereits in System.Web.Http.Results definiert sind, nämlich: Ok NotFound Exception Unauthorized BadRequest Conflict Redirect InvalidModelState( Link zur vollständigen Liste )
• Verwendet standardmäßig Async und Await .
• Einfaches Erstellen eines eigenen ActionResult durch einfache Implementierung der ExecuteAsyncMethode.
• Sie verwenden können , ResponseMessageResult ResponseMessage(HttpResponseMessage response)um HttpResponseMessage zu IHttpActionResult zu konvertieren .

// this will return HttpResponseMessage as IHttpActionResult
return ResponseMessage(httpResponseMessage); 

Dies ist nur meine persönliche Meinung und Leute vom Web-API-Team können es wahrscheinlich besser artikulieren, aber hier ist meine 2c.

Zunächst denke ich, dass es nicht um einander geht. Sie können sie beide je verwenden, was Sie in Ihrer Aktionsmethode tun wollen , sondern um die wirkliche Macht zu verstehen IHttpActionResult, dass Sie wahrscheinlich müssen Schritt außerhalb dieser bequemen Helfermethoden ApiControllerwie Ok, NotFoundusw.

Grundsätzlich denke ich, dass eine Klasse IHttpActionResultals Fabrik von implementiert HttpResponseMessage. Mit dieser Einstellung wird es nun zu einem Objekt, das zurückgegeben werden muss, und zu einer Fabrik, die es produziert. Im allgemeinen Programmiersinn können Sie das Objekt in bestimmten Fällen selbst erstellen, und in bestimmten Fällen benötigen Sie eine Factory, um dies zu tun. Hier gilt das gleiche.

Wenn Sie eine Antwort zurückgeben möchten, die durch eine komplexe Logik erstellt werden muss, z. B. viele Antwortheader usw., können Sie all diese Logik in eine Aktionsergebnisklasse abstrahieren, die implementiert wird, IHttpActionResultund sie in mehreren Aktionsmethoden verwenden, um eine Antwort zurückzugeben.

Ein weiterer Vorteil der Verwendung IHttpActionResultals Rückgabetyp besteht darin, dass die ASP.NET-Web-API-Aktionsmethode MVC ähnelt. Sie können jedes Aktionsergebnis zurückgeben, ohne sich in Medienformatierern zu verfangen.

Wie von Darrel bemerkt, können Sie natürlich Aktionsergebnisse verketten und eine leistungsstarke Mikro-Pipeline erstellen, die den Nachrichtenhandlern selbst in der API-Pipeline ähnelt. Dies benötigen Sie abhängig von der Komplexität Ihrer Aktionsmethode.

Lange Rede kurzer Sinn - es ist nicht IHttpActionResultversus HttpResponseMessage. Grundsätzlich möchten Sie die Antwort so erstellen. Mach es selbst oder durch eine Fabrik.

Der Web - API zurückgeben grundsätzlich 4 Objekttyp: void, HttpResponseMessage, IHttpActionResult, und andere starke Typen. Die erste Version der Web-API gibt HttpResponseMessageeine ziemlich einfache HTTP-Antwortnachricht zurück.

Das IHttpActionResultwurde von WebAPI 2 eingeführt, das eine Art Wrap von ist HttpResponseMessage. Es enthält die ExecuteAsync()Methode zum Erstellen eines HttpResponseMessage. Dies vereinfacht das Testen von Einheiten Ihres Controllers.

Andere Rückgabetypen sind stark typisierte Klassen, die von der Web-API mithilfe eines Medienformatierers in den Antworttext serialisiert werden. Der Nachteil war, dass Sie einen Fehlercode wie einen 404 nicht direkt zurückgeben können. Sie können lediglich einen HttpResponseExceptionFehler auslösen.

Ich möchte lieber die TaskExecuteAsync-Schnittstellenfunktion für IHttpActionResult implementieren. Etwas wie:

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var response = _request.CreateResponse(HttpStatusCode.InternalServerError, _respContent);

        switch ((Int32)_respContent.Code)
        { 
            case 1:
            case 6:
            case 7:
                response = _request.CreateResponse(HttpStatusCode.InternalServerError, _respContent);
                break;
            case 2:
            case 3:
            case 4:
                response = _request.CreateResponse(HttpStatusCode.BadRequest, _respContent);
                break;
        } 

        return Task.FromResult(response);
    }

, wobei _request die HttpRequest und _respContent die Nutzlast ist.

Wir haben die folgenden Vorteile der Verwendung von IHttpActionResultover HttpResponseMessage:

1. Bei Verwendung von IHttpActionResultkonzentrieren wir uns nur auf die zu sendenden Daten, nicht auf den Statuscode. Hier wird der Code also sauberer und sehr einfach zu pflegen sein.
2. Unit-Tests der implementierten Controller-Methode werden einfacher.
3. Verwendet asyncund awaitstandardmäßig.