Возвращение строки ошибки из MVC6 контроллера/WepApi

Question

Шаблон контроллера WebAPI в MVC6/WebAPI реализует действие, которое возвращает коллекцию для метода Получить как это:

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

Если предположить, что мой код, чтобы вернуть результат Выдает исключение, как я могу вернуть сообщение об ошибке потребителю?

Насколько я заметил, исключение приведет к HTTP 500. Это нормально, но я хотел бы дать вызывающему сообщение сообщение о том, что пошло не так. Из-за подписи действия шаблона я не могу поймать исключение и возвратить экземпляр Http *** или ObjectResult.

Answer 1

Вам нужно будет добавить код, который будет обрабатывать ошибки и возвращать сообщение.

Один из вариантов - использовать фильтр исключений и добавить его либо глобально, либо выбранные контроллеры, хотя этот подход будет охватывать исключения, исходящие из методов действий контроллера. Например, следующий фильтр будет возвращать объект JSON только тогда, когда запрос принимает было применение/JSON (В противном случае это позволило бы исключению пройти через которые, например, могут быть обработаны с помощью глобальной страницы ошибок):

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

Другого варианта Вы можете изменить подпись, чтобы сделать ответ более гибким. Затем вы можете обрабатывать ошибку, как обычно, и затем возвращать удобное сообщение об ошибке.

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

Как и для любой программы.

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

В качестве альтернативы вы можете использовать HandleErrorAttribute.

Answer 3

Изменить способ выглядеть

[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

Вы можете бездельничать с исключениями, но я получаю впечатление, что мы не должны думать, как что-либо другое. Это, как представляется, Дзен 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); 
    }