Por que devo usar IHttpActionResult em vez de HttpResponseMessage?

Estou desenvolvendo com o WebApi e fui para o WebApi2, onde a Microsoft introduziu uma nova IHttpActionResultinterface que parece recomendada para ser usada no retorno de a HttpResponseMessage. Estou confuso sobre as vantagens desta nova interface. Parece fornecer apenas uma maneira ligeiramente mais fácil de criar um HttpResponseMessage.

Eu argumentaria que isso é "abstração em prol da abstração". Estou esquecendo de algo? Quais são as vantagens do mundo real que recebo ao usar essa nova interface, além de talvez salvar uma linha de código?

Maneira antiga (WebApi):

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

Nova maneira (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();
    }
}

Você pode optar por não usar, IHttpActionResultporque o código existente cria um HttpResponseMessageque não se encaixa em uma das respostas em lata. No entanto, você pode se adaptar HttpResponseMessageao IHttpActionResultuso da resposta enlatada de ResponseMessage. Demorei um pouco para descobrir isso, então eu queria publicá-lo mostrando que você não precisa necessariamente escolher um ou outro:

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

Observe que ResponseMessageé um método da classe base ApiControllerque seu controlador deve herdar.

Você ainda pode usar HttpResponseMessage. Essa capacidade não desaparece. Eu me senti da mesma maneira que você e argumentei extensivamente com a equipe que não havia necessidade de uma abstração adicional. Houve alguns argumentos para tentar justificar sua existência, mas nada que me convenceu de que valia a pena.

Ou seja, até eu ver essa amostra de Brad Wilson . Se você construir IHttpActionResultclasses de uma maneira que possa ser encadeada, você poderá criar um pipeline de resposta "no nível de ação" para gerar o HttpResponseMessage. Nos bastidores, é assim que ActionFilterssão implementadas, no entanto, a ordenação ActionFiltersdelas não é óbvia ao ler o método de ação, que é uma das razões pelas quais eu não sou fã de filtros de ação.

No entanto, ao criar um IHttpActionResultque possa ser explicitamente encadeado em seu método de ação, você poderá compor todos os tipos de comportamentos diferentes para gerar sua resposta.

Aqui estão vários benefícios mencionados IHttpActionResultacima HttpResponseMessagena documentação do Microsoft ASP.Net :

• Simplifica o teste de unidade de seus controladores.
• Move a lógica comum para criar respostas HTTP em classes separadas.
• Torna mais clara a intenção da ação do controlador, ocultando os detalhes de baixo nível da construção da resposta.

Mas aqui estão algumas outras vantagens do uso que IHttpActionResultvale a pena mencionar:

• Respeitando o princípio de responsabilidade única : faça com que os métodos de ação tenham a responsabilidade de atender às solicitações HTTP e não os envolva na criação das mensagens de resposta HTTP.
• Implementações úteis já definidas no System.Web.Http.Results, a saber: Ok NotFound Exception Unauthorized BadRequest Conflict Redirect InvalidModelState( link para a lista completa )
• Usa Assíncrono e Aguardar por padrão.
• Fácil de criar o próprio ActionResult apenas implementando o ExecuteAsyncmétodo.
• você pode usar ResponseMessageResult ResponseMessage(HttpResponseMessage response)para converter HttpResponseMessage em IHttpActionResult .

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

Esta é apenas a minha opinião pessoal e o pessoal da equipe de APIs da web provavelmente pode articular melhor, mas aqui está o meu 2c.

Antes de tudo, acho que não se trata de um sobre o outro. Você pode usá-los tanto dependendo do que você quer fazer em seu método de ação, mas a fim de compreender o verdadeiro poder IHttpActionResult, você provavelmente terá que passo fora desses métodos auxiliares convenientes de ApiControllertais como Ok, NotFound, etc.

Basicamente, acho que uma classe implementada IHttpActionResultcomo uma fábrica de HttpResponseMessage. Com essa mentalidade, agora se torna um objeto que precisa ser devolvido e uma fábrica que o produz. No sentido geral de programação, você pode criar o objeto em certos casos e, em certos casos, precisa de uma fábrica para fazer isso. O mesmo aqui.

Se você deseja retornar uma resposta que precisa ser construída por meio de uma lógica complexa, digamos muitos cabeçalhos de resposta, etc., você pode abstrair toda essa lógica em uma classe de resultado de ação implementada IHttpActionResulte usá-la em vários métodos de ação para retornar a resposta.

Outra vantagem de usar IHttpActionResultcomo tipo de retorno é que ele torna o método de ação da API da Web do ASP.NET semelhante ao MVC. Você pode retornar qualquer resultado de ação sem ser pego nos formatadores de mídia.

Obviamente, como observado por Darrel, você pode encadear os resultados das ações e criar um micro-pipeline poderoso semelhante aos próprios manipuladores de mensagens no pipeline da API. Isso será necessário dependendo da complexidade do seu método de ação.

Para encurtar a história - não é IHttpActionResultcontra HttpResponseMessage. Basicamente, é assim que você deseja criar a resposta. Faça você mesmo ou através de uma fábrica.

A API Web retornar basicamente 4 tipo de objeto: void, HttpResponseMessage, IHttpActionResult, e outros tipos fortes. A primeira versão da API da Web retorna, o HttpResponseMessageque é uma mensagem de resposta HTTP bastante direta.

O IHttpActionResultfoi introduzido pelo WebAPI 2, que é uma espécie de quebra de HttpResponseMessage. Ele contém o ExecuteAsync()método para criar um HttpResponseMessage. Simplifica o teste de unidade do seu controlador.

Outro tipo de retorno são tipos de classes de tipo forte serializadas pela API da Web usando um formatador de mídia no corpo da resposta. A desvantagem foi que você não pode retornar diretamente um código de erro como o 404. Tudo o que você pode fazer é gerar um HttpResponseExceptionerro.

Prefiro implementar a função de interface TaskExecuteAsync para IHttpActionResult. Algo como:

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

, em que _request é o HttpRequest e _respContent é a carga útil.

Temos os seguintes benefícios do uso IHttpActionResultexcessivo HttpResponseMessage:

1. Ao usar o IHttpActionResult, estamos nos concentrando apenas nos dados a serem enviados e não no código de status. Portanto, aqui o código será mais limpo e fácil de manter.
2. O teste de unidade do método do controlador implementado será mais fácil.
3. Usa asynce awaitpor padrão.