Wracając błędzie ciąg od MVC6 kontrolera/WepApi

Question

Szablon kontroler WebAPI w MVC6/WebAPI realizuje akcję, która zwraca kolekcję dla metody GET jak ten:

[HttpGet] 
public IEnumerable<MyEntity> Get() 
{ 
    //my code to return entities 
} 

Zakładając, że mój kod, aby powrócić wynik Zgłasza wyjątek, w jaki sposób zwrócę komunikat o błędzie do konsumenta?

O ile zauważyłem, wyjątek spowodowałby HTTP 500. To dobrze, ale chciałbym przekazać dzwoniącemu wiadomość informującą go, co poszło nie tak. Z powodu sygnatury akcji szablonu nie mogę wychwycić wyjątku i zwrócić niektórych instancji Http *** lub ObjectResult.

Answer 1

Musisz samemu dodać fragment kodu, który poradzi sobie z błędami i zwróci wiadomość.

Jedną z opcji jest użycie filtru wyjątków i dodanie go globalnie lub na wybranych kontrolerach, chociaż to podejście obejmowałoby tylko wyjątki wynikające z metod działania kontrolera. Na przykład następujący filtr zwróci obiekt json tylko wtedy, gdy żądanie akceptować był application/json (W przeciwnym razie byłoby to niech wyjątek przechodzić przez które na przykład mogą być obsługiwane przez globalną stronę błędu):

public class CustomJSONExceptionFilter : ExceptionFilterAttribute 
{  
    public override void OnException(ExceptionContext context) 
    { 
     if (context.HttpContext.Request.GetTypedHeaders().Accept.Any(header => header.MediaType == "application/json")) 
     { 
      var jsonResult = new JsonResult(new { error = context.Exception.Message }); 
      jsonResult.StatusCode = Microsoft.AspNetCore.Http.StatusCodes.Status500InternalServerError; 
      context.Result = jsonResult; 
     } 
    } 
} 

services.AddMvc(opts => 
{ 
    //Here it is being added globally. 
    //Could be used as attribute on selected controllers instead 
    opts.Filters.Add(new CustomJSONExceptionFilter()); 
}); 

Inną opcją można zmienić podpis, aby zwiększyć elastyczność odpowiedzi. Wtedy możesz obsłużyć błąd jak zwykle, a następnie zwrócić komunikat przyjazny dla użytkownika.

public IActionResult Get() { 
    try { 
     IEnumerable<MyEntity> result; 
     //...result populated 
     return new HttpOkObjectResult(result); 
    } catch (Exception ex) { 
     //You should handle the error 
     HandleError(ex);//the is not an actual method. Create your own. 
     //You could then create your own error so as not to leak 
     //internal information. 
     var error = new 
      { 
       message = "Enter you user friendly error message", 
       status = Microsoft.AspNetCore.Http.StatusCodes.Status500InternalServerError 
      }; 
     Context.Response.StatusCode = error.status;    
     return new ObjectResult(error); 
    } 
} 

Answer 2

Tak samo, jak w przypadku każdego uruchomionego programu.

try { 
    ... 
} catch (Exception e) { 
    return errorMessageView; 
} 

Alternatywnie można użyć HandleErrorAttribute.

Answer 3

zmienić metodę wyglądać

[HttpGet] 
[ResponseType(typeof(IEnumerable<MyEntity>))] 
public IHttpActionResult Get() 
{ 
    //when ok 
    return Ok(response); // response is your IEnumerable<MyEntity> 

    //when error 
    throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.WhateverStatusCodeSuitable) 
      { 
       ReasonPhrase = "your message" 
      }); 

} 

Answer 4

Mona poeksperymentować z wyjątkami, ale mam wrażenie, że nie powinniśmy myśleć, że jak dłużej. To wydaje się być Zen MVC6:

[HttpGet("{id}")] 
    [ProducesResponseType(typeof(IEnumerable<string>), 200)] 
    [ProducesResponseType(typeof(void), 404)] 
    public IActionResult Get(int id) 
    { 
     Product product = null; 
     if (!this.productRepository.TryGet(id, out product)) 
     { 
      return NotFound(); 
     } 

     return Ok(product); 
    }