ASP.NET Web API i kod stanu dla zerowej odpowiedzi

Question

Jeśli żądany zasób nie zostanie znaleziony przez warstwę usługi zwracającą wartość null do kontrolera Web API; jaki jest najlepszy sposób na przesłanie odpowiedzi do klienta bez twardego kodowania jej w kontrolerze i sprawdzanie, czy jest ona zerowa?

Answer 1

Osobiście po prostu wykonuję kontrole w kontrolerach zgodnie z komentarzem Oppozycyjnym, ale to, o co prosisz, jest całkowicie uzasadnione. Ponownie za pomocą filtrów działania albo przymocowane na kontroler (lub zarejestrowanym globalnie) można zrobić coś wzdłuż tych linii:

Przykład Model:

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

Przykład Kontroler:

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

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

Filtr:

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

Zgadzam się z Markiem, że ActionFilter jest drogą do zrobienia - Małe metody działania są dobrym zapachem.

Jednak HttpActionExecutedContext.Response może być null kiedy wystąpi wyjątek; a klasa NullObjectActionFilter pokazana powyżej może ukrywać kody stanu błędów HTTP. Lepiej sprawdź, czy udało się zakończyć pomyślnie i udany kod HTTP.

Oto filtr działanie używam:

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

}