Trả về JSON có mã trạng thái lỗi MVC

Question

Tôi đã cố gắng trả lại lỗi cho cuộc gọi tới bộ điều khiển như được thông báo trong This link để khách hàng có thể thực hiện hành động thích hợp. Bộ điều khiển được gọi là javascript qua jquery AJAX. Tôi chỉ nhận được đối tượng Json nếu tôi không đặt trạng thái thành lỗi. Đây là mẫu mã

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

tôi nhận được Json nếu tôi không đặt statusCode. Nếu tôi đặt mã trạng thái, tôi nhận lại mã trạng thái nhưng không nhận được đối tượng lỗi Json.

Cập nhật Tôi muốn gửi đối tượng Lỗi dưới dạng JSON để có thể xử lý lỗi gọi lại của ajax.

Answer 1

Tôi tìm thấy giải pháp here

tôi đã phải tạo ra một bộ lọc hành động để ghi đè lên hành vi mặc định của MVC

Dưới đây là lớp ngoại lệ của tôi

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) { } 
} 

Lưu ý rằng tôi có constructor mà khởi JSON của tôi. Dưới đây là bộ lọc hành động

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

Bây giờ tôi có bộ lọc hành động, tôi sẽ trang trí điều khiển của tôi với các thuộc tính lọc

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

Khi lỗi được ném lọc hành động mà thực hiện IExceptionFilter được gọi và Tôi lấy lại Json trên máy khách về lỗi gọi lại.

Answer 2

Bạn phải trả lại JSON lỗi phản đối chính mình sau khi cài đặt StatusCode, như vậy ...

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

Một cách khác là phải có một JsonErrorModel và cư nó

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 
} 

Hãy nhìn vào câu trả lời here cũng như

Answer 3

Bạn cần quyết định xem bạn có muốn "lỗi cấp HTTP" không (là mã lỗi nào) hoặc "lỗi cấp ứng dụng" (w mũ đáp ứng JSON tùy chỉnh của bạn là dành cho).

Hầu hết các đối tượng cấp cao sử dụng HTTP sẽ không bao giờ xem xét luồng phản hồi nếu mã lỗi được đặt thành thứ không phải là 2xx (phạm vi thành công). Trong trường hợp của bạn, bạn đang thiết lập rõ ràng mã lỗi thành thất bại (tôi nghĩ 403 hoặc 500) và buộc đối tượng XMLHttp bỏ qua phần thân của phản hồi.

Để khắc phục - xử lý các điều kiện lỗi về phía máy khách hoặc không đặt mã lỗi và trả về JSON với thông tin lỗi (xem trả lời Sbossb để biết chi tiết).

Answer 4

Có một giải pháp rất thanh lịch cho vấn đề này, chỉ cần định cấu hình trang web của bạn qua web.cấu hình:

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

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

Answer 5

Và nếu nhu cầu của bạn không phải là phức tạp như Sarath của bạn có thể nhận được ngay với một cái gì đó thậm chí đơn giản hơn:

[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

Các giải pháp thú vị nhất tôi đã tìm thấy là tạo JsonResult của riêng bạn để mở rộng triển khai ban đầu và cho phép bạn chỉ định một 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); 
    } 
} 

Sau đó bạn có thể sử dụng trong hành động điều khiển của bạn như sau:

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

Answer 7

xây dựng trên câu trả lời từ Richard Garside, đây là phiên bản ASP.Net Lõi

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

Sau đó, trong điều khiển của bạn, trở lại như sau:

// 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);