Rückkehr Fehlerstring aus MVC6/WepApi Controller

Question

Die Steuerung Vorlage WebAPI in MVC6/WebAPI implementiert eine Aktion, die eine Kollektion für die Get-Methode wie folgt zurück:

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

Unter der Annahme, dass mein Code das Ergebnis wirft eine zurückzukehren Ausnahme, wie würde ich eine Fehlermeldung an den Verbraucher zurückgeben?

Soweit ich bemerkte eine Ausnahme würde HTTP 500 ergeben. Das ist in Ordnung, aber ich möchte dem Anrufer eine Nachricht sagen, was schief gelaufen ist. Wegen der Signatur der Template-Aktion kann ich die Ausnahme nicht abfangen und einige Http *** oder ObjectResult Instanz zurückgeben.

Answer 1

Sie müssen selbst ein Stück Code hinzufügen, das Fehler behandelt und eine Nachricht zurückgibt.

Eine Option besteht darin, einen Ausnahmefilter zu verwenden und ihn entweder global oder auf ausgewählten Controllern hinzuzufügen, obwohl dieser Ansatz nur Ausnahmen abdecken würde, die von den Controller-Aktionsmethoden kommen. Zum Beispiel werden die folgenden Filter ein Json-Objekt zurück nur, wenn die Anforderung akzeptieren war application/json (Sonst wäre es die Ausnahme passieren lassen, durch die beispielsweise durch die globale Fehlerseite behandelt werden könnte):

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

Eine weitere Option Sie können die Signatur ändern, um flexibler zu reagieren. Dann können Sie den Fehler so behandeln, wie normalerweise, und dann eine benutzerfreundliche Fehlermeldung zurückgeben.

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

Genau wie Sie würden jedes Programm laufen lassen.

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

Alternativ können Sie die HandleErrorAttribute verwenden.

Answer 3

Ihre Methode ändern, um wie

[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

Sie können Kampf mit Ausnahmen, aber ich habe den Eindruck, wir sind nicht so mehr denken soll. Dies scheint die zen von MVC6 zu sein:

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