asp.net-mvc-4 - 空响应的 ASP.NET Web API 和状态代码

Question

如果服务层未找到请求的资源，则向 Web API 控制器返回 null；HttpStatusCode.NotFound将响应返回给客户端而不在控制器中硬编码并检查它是否为空的最佳方法是什么？

Answer 1

就我个人而言，我会根据反对派的评论对控制器进行检查，但你所要求的完全合理。再次使用每个控制器附加的动作过滤器（或全局注册），您可以按照以下方式执行操作：

示例模型：

public class Foo
{
    public string Bar { get; set; }
}

示例控制器：

public class FoosController : ApiController
{
    [NullObjectActionFilter]
    public Foo Get(string id)
    {
        // - Returns model and 200
        //return new Foo() { Bar = "TEST" };

        // - Returns 404
        //return null;
    }
}

过滤器：

public class NullObjectActionFilter : ActionFilterAttribute
{
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        object outValue = null;
        actionExecutedContext.Response.TryGetContentValue<object>(out outValue);
        if (outValue == null)
        {
            throw new HttpResponseException(HttpStatusCode.NotFound);
        }

        base.OnActionExecuted(actionExecutedContext);

    }
}

Answer 2

我同意 Mark 的观点，即 ActionFilter 是要走的路——小动作方法是一种好味道。

但是，HttpActionExecutedContext.Response可以null在发生异常时；并且上面显示的 NullObjectActionFilter 类可以掩盖错误 HTTP 状态代码。您最好检查成功退出和成功的 HTTP 代码。

这是我使用的动作过滤器：

/// <summary>
/// Converts <c>null</c> return values into an HTTP 404 return code.
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public sealed class NullResponseIs404Attribute : ActionFilterAttribute
{

    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        if ((actionExecutedContext.Response != null) && actionExecutedContext.Response.IsSuccessStatusCode)
        {
            object contentValue = null;
            actionExecutedContext.Response.TryGetContentValue<object>(out contentValue);
            if (contentValue == null)
            {
                actionExecutedContext.Response = actionExecutedContext.Request.CreateErrorResponse(HttpStatusCode.NotFound, "Object not found");
            }
        }
    }

}