返回帶有錯誤狀態碼MVC的JSON

Question

我試圖按照 This link中的建議將錯誤返回給控制器的調用，以便客戶端可以採取適當的措施。 控制器通過jquery AJAX通過javascript調用。只有當我沒有將狀態設置爲錯誤時，我纔會返回Json對象。 下面是示例代碼

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

我得到JSON的，如果我不設置的StatusCode。 如果我設置了狀態碼，我會返回狀態碼，但不會返回Json錯誤對象。

更新 我想發送一個Error對象作爲JSON，以便它可以處理ajax的錯誤回調。

Answer 1

我找到了解決辦法here

我不得不創建一個動作過濾器來覆蓋MVC

這裏的默認行爲是我的異常類

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

請注意，我有構造函數初始化我的JSON。這裏是動作過濾器

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

現在，我有行動過濾器，我來裝飾我的控制器與過濾器屬性

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

當錯誤被拋出的動作過濾器，它實現個IExceptionFilter被調用和我在錯誤回調中返回客戶端上的Json。

Answer 2

你必須返回設置的StatusCode後JSON錯誤對象自己，像這樣......

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

另一種方法是有一個JsonErrorModel和填充它

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 
} 

看看答案here以及

Answer 3

您需要決定是否想要「HTTP級別錯誤」（即哪些錯誤代碼適用）或「應用程序級別錯誤」（即w你自定義的JSON響應是爲了）。

如果錯誤代碼設置爲非2xx（成功範圍），則使用HTTP的大多數高級對象都不會查看響應流。在你的情況下，你明確地設置錯誤代碼爲失敗（我認爲403或500）並強制XMLHttp對象忽略響應的主體。

修復 - 處理客戶端的錯誤條件或不設置錯誤代碼並返回帶有錯誤信息的JSON（詳見Sbossb回覆）。

Answer 4

這個問題有一個非常優雅的解決方案，只需通過網站配置您的網站。配置：

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

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

Answer 5

如果你的需求是不一樣複雜薩拉特的你可以逃脫的東西更簡單：

[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

最巧妙的解決方案，我發現是創建自己的JsonResult，它擴展了原始實現並允許指定一個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); 
    } 
} 

你可以在你的控制器動作，然後用這個像這樣：從理查德·加賽德答案

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

Answer 7

大廈，這裏的ASP.Net Core版本

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

然後在你的控制器，作爲回報如下：

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