某些 404 响应缺少内容

Question

我正在尝试从 web.api 返回自定义错误响应。让它成为简单的字符串"Oops!"，格式为json。所以我创建了简单的委托处理程序，它替换了这样的错误响应：

public class ErrorMessageHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(
       HttpRequestMessage request, CancellationToken cancellationToken)
    {
       var response = await base.SendAsync(request, cancellationToken);

       if (response.IsSuccessStatusCode)
           return response;

       var formatter = new JsonMediaTypeFormatter();
       var errorResponse = request.CreateResponse(response.StatusCode, "Oops!", formatter);
       return errorResponse;
    }
}

接下来我确保这是管道中唯一的一个消息处理程序：

httpConfig.MessageHandlers.Clear();
httpConfig.MessageHandlers.Add(new ErrorMessageHandler());

// Only default route
httpConfig.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );

app.UseWebApi(httpConfig); // OWIN self-hosting

控制器也是最简单的一个：

public class ValuesController : ApiController
{
   public IHttpActionResult Get(int id)
   {
      if (id == 42)
        return Ok("Answer to the Ultimate Question of Life, the Universe, and Everything");

      return NotFound();
   }
}

这里很有趣：

• /api/values/42 给了我 200 个带有值字符串的响应
• /api/values/13 用我的自定义 "Oops!" 字符串给我 404 响应
• /api/values/42/missing 给我 empty 404 响应

最后一种情况是我的问题。当我在委托处理程序的最后一行设置断点时，我清楚地看到errorResponse 包含具有正确值的ObjectContent<string>。但是为什么这个值稍后会被清除呢？

Answer 1

原因是HttpMessageHandlerAdapter.InvokeCore中的这段代码（所以基本上在UseWebApi中间件中）：

response = await _messageInvoker.SendAsync(request, cancellationToken);
// ...
if (IsSoftNotFound(request, response)) {
       callNext = true;
}
else { 
    // ...
}

IsSoftNotFound 在哪里：

private static bool IsSoftNotFound(HttpRequestMessage request, HttpResponseMessage response)
{
    if (response.StatusCode == HttpStatusCode.NotFound)
    {
        bool routingFailure;
        if (request.Properties.TryGetValue<bool>(HttpPropertyKeys.NoRouteMatched, out routingFailure)
            && routingFailure)
        {
            return true;
        }
    }
    return false;
}

所以基本上在“软”404 的情况下，其中“软”表示没有匹配的路由（并由request.Properties 中的特定键的属性指示） - 中间件将调用一些下一个组件。否则 - 只会发送响应。

这个IsSoftDelete 对你的情况是正确的（因为确实没有匹配的路由）并且下一个组件（没有时间弄清楚那是什么）清除你的响应内容。

要“修复”此问题 - 在请求由前一个处理程序处理后，使用该键从请求中删除属性：

public class ErrorMessageHandler : DelegatingHandler {
    protected override async Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request, CancellationToken cancellationToken) {
        var response = await base.SendAsync(request, cancellationToken);

        if (response.IsSuccessStatusCode)
            return response;

        // here, can also check if 404
        request.Properties.Remove(HttpPropertyKeys.NoRouteMatched);
        var formatter = new JsonMediaTypeFormatter();
        var errorResponse = request.CreateResponse(response.StatusCode, "Oops!", formatter);
        return errorResponse;
    }
}