MVC5 ApiController异常时如何设置500响应码并返回JSON错误信息

嘿，这个需求在MVC5里挺常见的，我来给你捋几个实用的方案，既能返回500状态码，又能把错误信息包装成JSON返回给前端：

方案一：全局自定义异常过滤器（推荐） #

这种方式可以统一处理整个项目的异常，不用在每个Action里重复写捕获逻辑，非常适合全局统一的错误格式。

步骤1：创建异常过滤器类 #

新建一个继承自HandleErrorAttribute的过滤器，重写OnException方法来定制异常处理逻辑：

using System.Web.Mvc;
using System.Net;

public class JsonExceptionFilter : HandleErrorAttribute
{
    public override void OnException(ExceptionContext filterContext)
    {
        // 标记异常已被处理，阻止MVC跳转到默认错误页
        filterContext.ExceptionHandled = true;
        
        // 设置HTTP响应状态码为500（内部服务器错误）
        filterContext.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
        
        // 清除响应流中已有的内容，避免干扰JSON输出
        filterContext.HttpContext.Response.Clear();
        
        // 构造返回的错误JSON结构，可根据需求调整字段
        var errorModel = new 
        {
            Success = false,
            Message = "服务器发生内部错误，请稍后重试",
            // 注意：生产环境建议注释掉StackTrace，避免泄露代码细节
            DetailedError = filterContext.Exception.Message,
            StackTrace = filterContext.Exception.StackTrace
        };
        
        // 返回JSON结果
        filterContext.Result = new JsonResult
        {
            Data = errorModel,
            JsonRequestBehavior = JsonRequestBehavior.AllowGet // 允许GET请求获取JSON响应
        };
    }
}

步骤2：注册全局过滤器 #

在Global.asax.cs的Application_Start方法中，把这个过滤器添加到全局过滤器集合里：

protected void Application_Start()
{
    // 其他初始化代码...
    GlobalFilters.Filters.Add(new JsonExceptionFilter());
}

方案二：控制器Action内手动捕获（适合局部自定义） #

如果某个Action需要特殊的错误处理逻辑，不想用全局规则，可以在Action内部用try-catch手动处理：

public ActionResult YourBusinessAction()
{
    try
    {
        // 这里写你的业务逻辑代码
        var resultData = new { Success = true, Data = "正常业务数据" };
        return Json(resultData, JsonRequestBehavior.AllowGet);
    }
    catch (Exception ex)
    {
        // 设置响应状态码为500
        Response.StatusCode = (int)HttpStatusCode.InternalServerError;
        
        // 返回自定义错误JSON
        var errorResponse = new 
        {
            Success = false,
            ErrorMessage = $"处理请求时出错：{ex.Message}"
        };
        return Json(errorResponse, JsonRequestBehavior.AllowGet);
    }
}

注意事项 #

• 生产环境中，不要返回StackTrace，这会泄露服务器端的代码结构和敏感信息，只保留友好的提示信息即可。
• 如果你的项目主要是API接口，也可以考虑使用HttpStatusCodeResult结合JSON输出，但上面的两种方法更直接适配MVC的场景。
• 确保调用Response.Clear()，避免MVC默认的错误页内容混入JSON响应中，导致前端解析失败。

内容的提问来源于stack exchange，提问作者davecove