ASP.NET MVC 異常Exception攔截

時間 2019-11-11

標籤 asp.net asp mvc 異常 exception 攔截欄目 ASP 简体版

原文原文鏈接

1、前言

因爲客戶端的環境不一致，有可能會形成咱們預計不到的異常錯誤，因此在項目中，友好的異常信息提示，是很是重要的。在asp.net mvc中實現異常屬性攔截也很是簡單，只須要繼承另外一個類(System.Web.Mvc.FilterAttribute)和一個接口(System.Web.Mvc.IExceptionFilter)，實現接口裏面OnException方法，或者直接繼承Mvc 提供的類System.Web.Mvc.HandleErrorAttribute。前端

2、實現關鍵邏輯

繼承System.Web.Mvc.HandleErrorAttribute，重寫了OnException方法，主要實現邏輯代碼以下：ajax

public class HandlerErrorAttribute : HandleErrorAttribute
{
/// <summary>
/// 控制器方法中出現異常，會調用該方法捕獲異常
/// </summary>
/// <param name="context">提供使用</param>
public override void OnException(ExceptionContext context)
{
WriteLog(context);
base.OnException(context);
context.ExceptionHandled = true;
if (context.Exception is UserFriendlyException)
{
context.HttpContext.Response.StatusCode = (int)HttpStatusCode.OK;
context.Result = new ContentResult { Content = new AjaxResult { type = ResultType.error, message = context.Exception.Message }.ToJson() };
}
else if (context.Exception is NoAuthorizeException)
{
context.HttpContext.Response.StatusCode = (int)HttpStatusCode.Unauthorized;
if (!context.HttpContext.Request.IsAjaxRequest())
{
context.HttpContext.Response.RedirectToRoute("Default", new { controller = "Error", action = "Error401", errorUrl = context.HttpContext.Request.RawUrl });
}
else
{
context.Result = new ContentResult { Content = context.HttpContext.Request.RawUrl };
}
}
else
{
context.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
ExceptionMessage error = new ExceptionMessage(context.Exception);
var s = error.ToJson();
if (!context.HttpContext.Request.IsAjaxRequest())
{
context.HttpContext.Response.RedirectToRoute("Default", new { controller = "Error", action = "Error500", data = WebHelper.UrlEncode(s) });
}
else
{
context.Result = new ContentResult { Content = WebHelper.UrlEncode(s) };
}
}
}
/// <summary>
/// 寫入日誌（log4net）
/// </summary>
/// <param name="context">提供使用</param>
private void WriteLog(ExceptionContext context)
{
if (context == null)
return;
if (context.Exception is NoAuthorizeException || context.Exception is UserFriendlyException)
{
//友好錯誤提示,未受權錯誤提示，記錄警告日誌
LogHelper.Warn(context.Exception.Message);
}
else
{
//異常錯誤，
LogHelper.Error(context.Exception);
////TODO :寫入錯誤日誌到數據庫
}
}
}

MVC 過濾器全局註冊異常攔截: 數據庫

public class FilterConfig
{
public static void RegisterGlobalFilters(GlobalFilterCollection filters)
{
filters.Add(new HandlerErrorAttribute());
}
}

咱們看到，context.Exception 分爲3種：UserFriendlyException，NoAuthorizeException 或 Exception；UserFriendlyException 是指友好異常，前端友好提示錯誤信息。NoAuthorizeException 爲401未受權異常，當頁面未被受權訪問時，返回該異常，並攜帶有未受權的路徑地址。其餘異常統一返回500錯誤，並攜帶異常信息。 json

3、異常處理

1.401 未受權錯誤

異常定義代碼：瀏覽器

/// <summary>
/// 沒有被受權的異常
/// </summary>
public class NoAuthorizeException : Exception
{
public NoAuthorizeException(string message)
: base(message)
{
}
}

拋出異常代碼：服務器

throw new NoAuthorizeException("未受權");

前端UI效果：mvc

2.404 未找到頁面錯誤

MVC的404異常處理，有幾種方式，咱們採用了在Global.asax全局請求函數中處理, 請查看如下代碼 app

protected void Application_EndRequest()
{
if (Context.Response.StatusCode == 404)
{
bool isAjax = new HttpRequestWrapper(Context.Request).IsAjaxRequest();
if (isAjax)
{
Response.Clear();
Response.Write(Context.Request.RawUrl);
}
else
{
Response.RedirectToRoute("Default", new { controller = "Error", action = "Error404", errorUrl = Context.Request.RawUrl });
}
}
}

前端UI效果:asp.net

3.500服務器內部錯誤

500異常錯誤拋出的異常信息對象定義:異步

/// <summary>
/// 異常錯誤信息
/// </summary>
[Serializable]
public class ExceptionMessage
{
public ExceptionMessage()
{
}
/// <summary>
/// 構造函數
/// 默認顯示異常頁面
/// </summary>
/// <param name="ex">異常對象</param>
public ExceptionMessage(Exception ex)
:this(ex, true)
{
}
/// <summary>
/// 構造函數
/// </summary>
/// <param name="ex">異常對象</param>
/// <param name="isShowException">是否顯示異常頁面</param>
public ExceptionMessage(Exception ex, bool isShowException)
{
MsgType = ex.GetType().Name;
Message = ex.InnerException != null ? ex.InnerException.Message : ex.Message;
StackTrace = ex.StackTrace.Length > 300 ? ex.StackTrace.Substring(0, 300) : ex.StackTrace;
Source = ex.Source;
Time = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");
Assembly = ex.TargetSite.Module.Assembly.FullName;
Method = ex.TargetSite.Name;
ShowException = isShowException;
var request = HttpContext.Current.Request;
IP = Net.Ip;
UserAgent = request.UserAgent;
Path = request.Path;
HttpMethod = request.HttpMethod;
}
/// <summary>
/// 消息類型
/// </summary>
public string MsgType { get; set; }
/// <summary>
/// 消息內容
/// </summary>
public string Message { get; set; }
/// <summary>
/// 請求路徑
/// </summary>
public string Path { get; set; }
/// <summary>
/// 程序集名稱
/// </summary>
public string Assembly { get; set; }
/// <summary>
/// 異常參數
/// </summary>
public string ActionArguments { get; set; }
/// <summary>
/// 請求類型
/// </summary>
public string HttpMethod { get; set; }
/// <summary>
/// 異常堆棧
/// </summary>
public string StackTrace { get; set; }
/// <summary>
/// 異常源
/// </summary>
public string Source { get; set; }
/// <summary>
/// 服務器IP 端口
/// </summary>
public string IP { get; set; }
/// <summary>
/// 客戶端瀏覽器標識
/// </summary>
public string UserAgent { get; set; }
/// <summary>
/// 是否顯示異常界面
/// </summary>
public bool ShowException { get; set; }
/// <summary>
/// 異常發生時間
/// </summary>
public string Time { get; set; }
/// <summary>
/// 異常發生方法
/// </summary>
public string Method { get; set; }
}