Tornando stringa di errore dal regolatore/WepApi MVC6

Question

Il controller WebAPI modello in MVC6/WebAPI implementa un'azione che restituisce una collezione per il metodo Get in questo modo:

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

Supponendo che il mio codice per restituire il risultato genera eccezione, come dovrei restituire un messaggio di errore al consumatore?

Per quanto ho notato un'eccezione si tradurrebbe in HTTP 500. Questo va bene, ma vorrei dare al chiamante un messaggio che gli dice cosa è andato storto. A causa della firma dell'azione del modello, non riesco a rilevare l'eccezione e restituire qualche istanza di Http *** o ObjectResult.

Answer 1

Sarà necessario aggiungere un pezzo di codice per gestire gli errori e restituire un messaggio.

Un'opzione consiste nell'utilizzare un filtro di eccezione e aggiungerlo a livello globale o su controller selezionati, sebbene questo approccio riguardi solo le eccezioni provenienti dai metodi di azione del controllore. Per esempio il seguente filtro restituirà un oggetto JSON solo quando la richiesta di accettare era application/json (In caso contrario, avrebbe lasciato l'eccezione passare attraverso il quale ad esempio potrebbe essere trattato dalla pagina di errore globale):

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()); 
}); 

Un'altra opzione È possibile modificare la firma per rendere più flessibile la risposta. Quindi è possibile gestire l'errore come si farebbe normalmente e quindi restituire un messaggio di errore facile da usare.

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

Proprio come si farebbe per mantenere in esecuzione qualsiasi programma.

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

In alternativa è possibile utilizzare HandleErrorAttribute.

Answer 3

cambiare il metodo per assomigliare

[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

Si può pasticciare con le eccezioni, ma ho l'impressione che non dovremmo pensare più così. Questo sembra essere lo zen di 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); 
    }