何时返回 IHttpActionResult vs Object

Question

在使用 ASP.NET Web API 的示例中，我看到了两种不同的方法用于将数据返回给调用 jQuery 函数。第一种方法返回Client 类型的对象，但我不确定第二种方法返回的是什么。

方法#1（返回Client对象）

public IEnumerable<Client> GetAllClients()
{
     using (var context = new PQRSModel.PQRSEntities())
     {
       context.Configuration.ProxyCreationEnabled = false; 
       var query = context.Clients.OrderBy(c = c.OrgName);
       var customers = query.ToList();
       return customers;
     }
}

方法#2（IHttpActionResult 有什么好处？）

public IHttpActionResult GetClient(int clientId)
{
     using (var context = new PQRSModel.PQRSEntities())
     {
       context.Configuration.ProxyCreationEnabled = false;
       var client = context.Clients.FirstOrDefault(c = c.ID == clientId);
       if (client == null)
       {
         return NotFound();
       }
       return Ok(client);
     }
}

如果第二种方法找到单个对象，是否有任何原因不能返回 Client 对象类型？

Answer 1

返回IHttpActionResult 提供了一个很好的关注点分离。

您的控制器可以专注于以最明智的方式响应请求（状态代码、错误消息等）。另一个（服务）层可以专注于实际检索和转换业务数据。

副作用是，您的控制器方法变得更加可单元测试。考虑以下简单示例：

public class MyController : ApiController
{
    //or better yet, dependency-inject this
    SomeService _service = new SomeService();

    public IHttpActionResult Get(int id)
    {
         if (id < 0)
             return BadRequest("Some error message");

         var data = _service.GetData(id);

         if (data == null)
            return NotFound();

         return Ok(data);
    }
}

这个方法的逻辑不仅可以通过阅读理解，而且您现在可以更轻松自然地测试逻辑，例如（使用 NUnit 语法）：

[TestFixture]
public class MyControllerTests
{    
    [Test]
    public void Get_WithIdLessThan0_ReturnsBadRequest()
    {
        var controller = new MyController();
        int id = -1;

        IHttpActionResult actionResult = controller.Get(id);

        Assert.IsInstanceOf<BadRequestErrorMessageResult>(actionResult);
    }
}

同样，您可以模拟服务层并测试当您将已知的id 参数提供给控制器等时会发生什么。

这是Unit Testing Controllers in Web Api上的一篇好文章

Answer 2

第二种方法允许您只返回状态码（如示例中的 404）、流文件内容和其他类型的非对象内容。