ASP.NET MVC編程——錯誤處理與日記
ASP.NET MVC的錯誤處理應考慮到這幾個方面：模型綁定期間發生的錯誤，未能路由到指定操作，針對控制器的錯誤處理。使用配置文件可以幫助我們處理異常，但是不夠靈活和全面；使用HandleErrorAttribute、自定義錯誤過濾器或重寫控制器OnException方法只能解決針對控制器的錯誤，無法解決模型綁定期間發生的錯誤，也無法處理404錯誤，即使將錯誤過濾器註冊為全局過濾器也是如此。有時候需要多種方法配合使用。
在捕獲錯誤的地方，可以將有用的信息記錄下來，便於我們查出引起問題的原因和糾正錯誤。
1啟用自定義錯誤
使用這種方式一定要註意將defaultRedirect設置為指定的錯誤頁面，防止黑客探測各種錯誤情形進而發現系統的額漏洞。
<system.web> <customErrors mode="On" defaultRedirect="/error/error2"> <error statusCode="404" redirect="/error/error1" /> </customErrors> <!--其他配置--> </system.web>
Mode:處理模式，有三種處理模式
- On,啟用自定義處理功能，當錯誤發生時顯示自定義錯誤頁
- Off,關閉自定義錯誤處理功能，當錯誤發生時顯示默認的錯誤頁。
- RemoteOnly，啟用自定義錯誤處理功能，但只針對來自遠程機器的請求有效。
defaultRedirect：發生錯誤時，顯示指定錯誤頁。
<error>:根據狀態碼顯示指定的錯誤頁。mode必須為On或RemoteOnly模式，否則不會起作用。
註意：不論defaultRedirect和redirect都配置為指定的路徑，例如上述配置中控制器error，控制器操作為error1和error2，相應地錯誤頁為Error1.cshtml和Error2.cshtml。
2針對控制器的錯誤處理
2.1使用HandleErrorAttribute修飾控制器或操作。
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = true, AllowMultiple = true)] public class HandleErrorAttribute : FilterAttribute, IExceptionFilter { //獲取或設置異常的類型。 public Type ExceptionType { get; set; } //獲取或設置用於顯示異常信息的母版視圖 public string Master { get; set; } //獲取此特性的唯一標識符。 public override object TypeId { get; } //獲取或設置用於顯示異常信息的頁視圖。 public string View { get; set; } //在發生異常時調用。 //filterContext:操作篩選器上下文 public virtual void OnException(ExceptionContext filterContext); }
例：
當發生KeyNotFoundException類型的異常時，顯示KeyNotFind視圖
[HandleError(ExceptionType=typeof(KeyNotFoundException),View="KeyNotFound")] public ActionResult Index() { ...... }
還可以使用自定義的錯誤過濾器，並將其應用到控制器或操作上。
例：
public class CustomHandleError : HandleErrorAttribute { public override void OnException(ExceptionContext filterContext) { if (filterContext==null) base.OnException(filterContext); //記錄日誌 LogError(filterContext.Exception); //判斷是否啟用了自定義錯誤 if (filterContext.HttpContext.IsCustomErrorEnabled) { //將錯誤設置為已處理 filterContext.ExceptionHandled = true; base.OnException(filterContext); } } }
可以設置全局過濾器，這樣對每一個控制器都起作用。
App_Start文件夾下FilterConfig.cs文件中設置全局錯誤過濾器，過濾器會按照他們註冊的順序執行。但可以通過Order屬性指定執行順序。
例：
public class FilterConfig { public static void RegisterGlobalFilters(GlobalFilterCollection filters) { filters.Add(new HandleErrorAttribute { ExceptionType = typeof(KeyNotFoundException), View = "KeyNotFound", Order = 2 }); filters.Add(new HandleErrorAttribute(),1); } }
將自定義錯誤過濾器設置為全局過濾器：
在App_Start文件夾下FilterConfig.cs文件中
例：
public class FilterConfig { public static void RegisterGlobalFilters(GlobalFilterCollection filters) { //其他過濾器 filters.Add(new CustomHandleError()); } }
2.2重寫控制器OnException方法
註意將錯誤設置為已處理，不然錯誤繼續拋出，但如果設置了全局錯誤過濾器，那麽即使不標記為已處理，也不要緊，因為錯誤最終會被全局過濾器捕獲並處理。
例：
public class HomeController : Controller { //其他控制器操作 protected override void OnException(ExceptionContext filterContext) { if (filterContext==null) base.OnException(filterContext); //記錄日誌 LogError(filterContext.Exception); //判斷是否啟用了自定義錯誤 if (filterContext.HttpContext.IsCustomErrorEnabled) { //將錯誤設置為已處理 filterContext.ExceptionHandled = true; //顯示錯誤頁 this.View("Error").ExecuteResult(this.ControllerContext); } } }
或者創建控制器基類
public class BaseController : Controller { protected override void OnException(ExceptionContext filterContext) { //錯誤日誌記錄 } }
3全局錯誤處理
針對模型綁定或路由等過程中拋出的異常我們只能使用全局錯誤處理策略。
3.1 Global.asax中添加處理異常的代碼
例：
public class MvcApplication : System.Web.HttpApplication { protected void Application_Start() { AreaRegistration.RegisterAllAreas(); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); BundleConfig.RegisterBundles(BundleTable.Bundles); } protected void Application_Error(object sender, EventArgs e) { var exception = Server.GetLastError(); if (exception == null) { return; } //異常發生記錄日誌或發送郵件 //清除異常 Server.ClearError(); //重定向 Response.Redirect("home/index"); } }
3.2捕獲未匹配的路由
在路由註冊列表最底端註冊路由。
public class RouteConfig { public static void RegisterRoutes(RouteCollection routes) { //其他配置 routes.MapRoute( name: "MatchAll", url: "{*anyurl}", defaults: new { controller = "Error",action ="Missing" } ); } }
定義Error控制器及Missing操作
public class ErrorController : Controller { // GET: Error public ActionResult Missing() { HttpContext.Response.StatusCode = 404; //禁用IIS7默認的錯誤頁，這樣才能展示我們指定都的視圖 HttpContext.Response.TrySkipIisCustomErrors = true; //也可以在此處記錄日誌信息 //要展示的信息 var model = ...... return View(model); } }
需要註意的是，這種方式不一定能處理所有未匹配的情形。
例如：http://localhost/mvcpointapp/home/index1，這個url請求說我home是存在，但是index1操作不存在，上面配置MatchAll路由無法匹配這個url。
可以匹配的情形如：http://localhost/mvcpointapp/v1/home/index/1，這個url能被上面配置的MatchAll路由匹配，所以可以顯示Missing視圖。
4實踐
4.1使用HandleErrorAttribute註意要對<system.web>的<customErrors>節進行設置 。
例如：
控制器為
public class HomeController : Controller { [HandleError(ExceptionType = typeof(KeyNotFoundException), View = "Error")] public ActionResult Index() { throw new KeyNotFoundException(); return View(); } //其他控制操作 }
<system.web>的<customErrors>節
<customErrors mode="On" defaultRedirect="Error/Error2"></customErrors>
Error.cshtml文件位於Views文件夾下的子文件夾Shared文件夾下
瀏覽器中輸入：http://localhost/mvcpointapp/
結果可以正常顯示Error.cshtml頁面,同時註意到雖然在customErrors 配置節中指定了defaultRedirect，但還是跳轉到Error.cshtml頁面。
將<customErrors>的mode設置為Off,則顯示經典錯誤頁。
4.2 Application_Error
代碼如3.1節所示，控制器如4.1所示，<system.web>的<customErrors>節為<customErrors mode="On" defaultRedirect="Error/Error2"></customErrors>
輸入：http://localhost/mvcpointapp/home/index，斷點調試，發現錯誤被HandleError攔截，Global.asax的Application_Error方法沒有執行。而當輸入：http://localhost/mvcpointapp/home/indexr，Application_Error執行了。
關閉<customErrors>配置節，而不註掉控制器上的HandleErrorAttribute特性，輸入：http://localhost/mvcpointapp/home/index，發現Application_Error執行了。
通過上述實踐，充分證明HandleErrorAttribute會攔截控制器內拋出的異常，而無法攔截無法找到資源這種異常。
4.3策略
一種常用的攔截錯誤信息、記錄錯誤日誌與顯示自定義錯誤頁的策略為：
1）首先配置<system.web>的<customErrors>節，註意務必設置defaultRedirect；並且定義錯誤控制器及相應的操作和視圖。
2）定義基類控制器或自定義錯誤過濾器，記錄異常。對於自定義錯誤過濾器的情形一般將其註冊為全局過濾器。
3）在Global.asax中添加Application_Error方法攔截意想不到的異常並記錄異常。
參考：
1.Jess Chadwick/Todd Snyder/Hrusikesh Panda，徐雷/徐揚
譯。ASP.NET MVC4 Web編程
2.Jon Galloway/Phil Haack/Brad Wilson/K. Scott Allen，孫遠帥/鄒權譯 ASP.NET MVC4 高級編程（第四版）
3.黃保翕，ASP.NET MVC4開發指南
4.蔣金楠，ASP.NET MVC4框架揭秘
5.https://www.asp.net/mvc
-----------------------------------------------------------------------------------------
轉載與引用請註明出處。
時間倉促，水平有限，如有不當之處，歡迎指正。
ASP.NET MVC編程——錯誤處理與日記