Devolver JSON con código de estado de error MVC

Question

Estaba tratando de devolver un error a la llamada al controlador como se aconseja en This link para que el cliente pueda tomar las medidas adecuadas. El controlador es llamado por javascript a través de jquery AJAX. Recupero el objeto Json solo si no establezco el estado en error. Aquí es el código de ejemplo

if (response.errors.Length > 0) 
    Response.StatusCode = (int)HttpStatusCode.BadRequest; 
return Json(response); 

consigo el JSON si no se establece la statuscode. Si configuro el código de estado, obtengo el código de estado pero no el objeto de error Json.

Actualización Quiero enviar un objeto de error como JSON para que se pueda manejar la devolución de llamada de error de ajax.

Answer 1

he encontrado la solución here

tuve que crear un filtro de acción para anular el comportamiento por defecto de la MVC

Aquí está mi clase de excepción

class ValidationException : ApplicationException 
{ 
    public JsonResult exceptionDetails; 
    public ValidationException(JsonResult exceptionDetails) 
    { 
     this.exceptionDetails = exceptionDetails; 
    } 
    public ValidationException(string message) : base(message) { } 
    public ValidationException(string message, Exception inner) : base(message, inner) { } 
    protected ValidationException(
    System.Runtime.Serialization.SerializationInfo info, 
    System.Runtime.Serialization.StreamingContext context) 
     : base(info, context) { } 
} 

Tenga en cuenta que tengo constructor que inicializa mi JSON. Aquí está el filtro de acción

public class HandleUIExceptionAttribute : FilterAttribute, IExceptionFilter 
{ 
    public virtual void OnException(ExceptionContext filterContext) 
    { 
     if (filterContext == null) 
     { 
      throw new ArgumentNullException("filterContext"); 
     } 
     if (filterContext.Exception != null) 
     { 
      filterContext.ExceptionHandled = true; 
      filterContext.HttpContext.Response.Clear(); 
      filterContext.HttpContext.Response.TrySkipIisCustomErrors = true; 
      filterContext.HttpContext.Response.StatusCode = (int)System.Net.HttpStatusCode.InternalServerError; 
      filterContext.Result = ((ValidationException)filterContext.Exception).myJsonError; 
     } 
    } 

Ahora que tengo el filtro de la acción, voy a decorar mi controlador con el atributo de filtro

[HandleUIException] 
public JsonResult UpdateName(string objectToUpdate) 
{ 
    var response = myClient.ValidateObject(objectToUpdate); 
    if (response.errors.Length > 0) 
    throw new ValidationException(Json(response)); 
} 

Cuando el error es lanzado el filtro de acción que implementa IExceptionFilter ser llamado y Devuelvo el Json al cliente en caso de devolución de llamada por error.

Answer 2

usted tiene que volver JSON objeto de error a sí mismo después de ajustar el StatusCode, al igual que ...

if (BadRequest) 
{ 
    Dictionary<string, object> error = new Dictionary<string, object>(); 
    error.Add("ErrorCode", -1); 
    error.Add("ErrorMessage", "Something really bad happened"); 
    return Json(error); 
} 

Otra forma es tener un JsonErrorModel y rellenarla

public class JsonErrorModel 
{ 
    public int ErrorCode { get; set;} 

    public string ErrorMessage { get; set; } 
} 

public ActionResult SomeMethod() 
{ 

    if (BadRequest) 
    { 
     var error = new JsonErrorModel 
     { 
      ErrorCode = -1, 
      ErrorMessage = "Something really bad happened" 
     }; 

     return Json(error); 
    } 

    //Return valid response 
} 

Ven a ver la respuesta here así como

Answer 3

Debe decidir si desea "error de nivel HTTP" (para qué son los códigos de error) o "error de nivel de aplicación" (que para qué sirve su respuesta JSON personalizada).

La mayoría de los objetos de alto nivel que usan HTTP nunca buscarán en el flujo de respuesta si el código de error se establece en algo que no es 2xx (rango de éxito). En su caso, está configurando explícitamente un error en el código de error (creo que 403 o 500) y fuerza al objeto XMLHttp a ignorar el cuerpo de la respuesta.

Para corregir: maneje las condiciones de error en el lado del cliente o no configure el código de error y devuelva JSON con información de error (consulte la respuesta de Sbossb para obtener más información).

Answer 4

Existe una solución muy elegante a este problema, simplemente configure su sitio a través de la web.config:

<system.webServer> 
    <httpErrors errorMode="DetailedLocalOnly" existingResponse="PassThrough"/> 
</system.webServer> 

Fuente: https://serverfault.com/questions/123729/iis-is-overriding-my-response-content-if-i-manually-set-the-response-statuscode

Answer 5

Y si sus necesidades no son tan complejos como Sarath de que puede salirse con algo aún más simple:

[MyError] 
public JsonResult Error(string objectToUpdate) 
{ 
    throw new Exception("ERROR!"); 
} 

public class MyErrorAttribute : FilterAttribute, IExceptionFilter 
{ 
    public virtual void OnException(ExceptionContext filterContext) 
    { 
     if (filterContext == null) 
     { 
     throw new ArgumentNullException("filterContext"); 
     } 
     if (filterContext.Exception != null) 
     { 
     filterContext.ExceptionHandled = true; 
     filterContext.HttpContext.Response.Clear(); 
     filterContext.HttpContext.Response.TrySkipIisCustomErrors = true; 
     filterContext.HttpContext.Response.StatusCode = (int)System.Net.HttpStatusCode.InternalServerError; 
     filterContext.Result = new JsonResult() { Data = filterContext.Exception.Message }; 
     } 
    } 
} 

Answer 6

La solución más elegante que he encontrado es crear su propio JsonResult que extiende la implementación original y le permite especificar un HttpStatusCode:

public class JsonHttpStatusResult : JsonResult 
{ 
    private readonly HttpStatusCode _httpStatus; 

    public JsonHttpStatusResult(object data, HttpStatusCode httpStatus) 
    { 
     Data = data; 
     _httpStatus = httpStatus; 
    } 

    public override void ExecuteResult(ControllerContext context) 
    { 
     context.RequestContext.HttpContext.Response.StatusCode = (int)_httpStatus; 
     base.ExecuteResult(context); 
    } 
} 

A continuación, puede utilizar esto en su acción de controlador de este modo:

if(thereWereErrors) 
{ 
    var errorModel = new { error = "There was an error" }; 
    return new JsonHttpStatusResult(errorModel, HttpStatusCode.InternalServerError); 
} 

Answer 7

Sobre la base de la respuesta de Richard Garside, aquí está la versión Core ASP.Net

public class JsonErrorResult : JsonResult 
{ 
    private readonly HttpStatusCode _statusCode; 

    public JsonErrorResult(object json) : this(json, HttpStatusCode.InternalServerError) 
    { 
    } 

    public JsonErrorResult(object json, HttpStatusCode statusCode) : base(json) 
    { 
     _statusCode = statusCode; 
    } 

    public override void ExecuteResult(ActionContext context) 
    { 
     context.HttpContext.Response.StatusCode = (int)_statusCode; 
     base.ExecuteResult(context); 
    } 

    public override Task ExecuteResultAsync(ActionContext context) 
    { 
     context.HttpContext.Response.StatusCode = (int)_statusCode; 
     return base.ExecuteResultAsync(context); 
    } 
} 

Luego, en su controlador, de regreso si lo sigue:

// Set a json object to return. The status code defaults to 500 
return new JsonErrorResult(new { message = "Sorry, an internal error occurred."}); 

// Or you can override the status code 
return new JsonErrorResult(new { foo = "bar"}, HttpStatusCode.NotFound);