ASP.NET MVC下基于異常處理的完整解決方案總結(jié)
EntLib的異常處理應用塊（Exception Handling Application Block）是一個不錯的異常處理框架，它使我們可以采用配置的方式來定義異常處理策略。而ASP.NET MVC是一個極具可擴展開發(fā)框架，在這篇文章中我將通過它的擴展實現(xiàn)與EntLib的集成，并提供一個完整的解決異常處理解決方案。
一、基本異常處理策略
我們首先來討論我們的解決方案具體采用的異常處理策略：
對于執(zhí)行Controller的某個Action方法拋出的異常，我們會按照指定配置策略進行處理。我們可以采取日志記錄、異常替換和封裝這些常用的異常處理方式；
對于處理后的異常，如果異常處理策略規(guī)定需要將其拋出，則會自動重定向到與異常類型匹配的出錯頁面。我們會維護一個異常類型和Error View的匹配關(guān)系；
對于處理后的異常，如果異常處理策略規(guī)定不需要將其拋出，則會執(zhí)行與當前Action操作相匹配的錯誤處理Action進行處理。異常處理Action方法默認采用“On{Action}Error”這樣的命名規(guī)則，而當前上下文會與異常處理操作方法的參數(shù)進行綁定。除次之外，我們會設置當前ModelState的錯誤信息；
如果用戶不曾定義相應的異常處理Action，依然采用“錯誤頁面重定向”方式進行異常處理。
二、通過自定義Action處理異常
為了讓讀者對上面介紹的異常處理頁面有一個深刻的理解，我們來進行一個實例演示。該實例用于模擬用戶登錄，我們定義了如下一個只包含用戶名和密碼兩個屬性的Model：LoginInfoModel。
namespace Artech.Mvc.ExceptionHandling.Models
{
public class LoginInfo
{
[Display(Name ="User Name")]
[Required(ErrorMessage = "User Name is manadatory!")]
public string UserName { get; set; }
[Display(Name = "Password")]
[DataType(DataType.Password)]
[Required(ErrorMessage = "Password is manadatory!")]
public string Password { get; set; }
}
}
我們定義了如下一個AccountController，它是我們自定義的BaseController的子類。AccountController在構(gòu)造的時候調(diào)用基類構(gòu)造函數(shù)指定的參數(shù)代表異常處理策略的配置名稱。SignIn方法代表用于進行“登錄”的操作，而OnSignInError就表示該操作對應的異常處理操作。如果在SignIn操作中拋出的異常經(jīng)過處理后無需再拋出，則會通過調(diào)用OnSignInError，而此時ModelState已經(jīng)被設置了相應的錯誤消息。
public class AccountController BaseController
{
public AccountController()
base("myPolicy")
{ }
public ActionResult SignIn()
{
return View(new LoginInfo());
}
[HttpPost]
public ActionResult SignIn(LoginInfo loginInfo)
{
if (!ModelState.IsValid)
{
return this.View(new LoginInfo { UserName = loginInfo.UserName });
}
if (loginInfo.UserName != "Foo")
{
throw new InvalidUserNameException();
}
if (loginInfo.Password != "password")
{
throw new UserNamePasswordNotMatchException();
}
ViewBag.Message = "Authentication Succeeds!";
return this.View(new LoginInfo { UserName = loginInfo.UserName });
}
public ActionResult OnSignInError(string userName)
{
return this.View(new LoginInfo { UserName = userName });
}
}
具體定義在SignIn操作方法中的認證邏輯是這樣的：如果用戶名不是“Foo”則拋出InvalidUserNameException異常；如果密碼不是“password”則拋出UserNamePasswordNotMatchException異常。下面是SignIn操作對應的View的定義：
@model Artech.Mvc.ExceptionHandling.Models.LoginInfo
@{
ViewBag.Title = "SignIn";
}
@Html.ValidationSummary()
@if (ViewBag.Messages != null)
{
@ViewBag.Messages
}
@using (Html.BeginForm())
{
@Html.EditorForModel()
<input type="submit" value="SignIn" />
}
在AccountController初始化時指定的異常處理策略“myPolicy”定義在如下的配置中。我們專門針對SignIn操作方法拋出的InvalidUserNameException和UserNamePasswordNotMatchException進行了處理，而ErrorMessageSettingHandler是我們自定義的異常處理器，它僅僅用于設置錯誤消息。如下面的代碼片斷所示，如果上述的這兩種類型的異常被拋出，最終的錯誤消息會被指定為“User name does not exist!”和“User name does not match password!”。
<exceptionHandling>
<exceptionPolicies>
<add name="myPolicy">
<exceptionTypes>
<add name="InvalidUserNameException"
type="Artech.Mvc.ExceptionHandling.Models.InvalidUserNameException, Artech.Mvc.ExceptionHandling"
postHandlingAction="None">
<exceptionHandlers>
<add name="ErrorMessageSettingHandler"
type="Artech.Mvc.ExceptionHandling.ErrorMessageSettingHandler, Artech.Mvc.ExceptionHandling"
errorMessage="User name does not exist!"/>
</exceptionHandlers>
</add>
<add name="UserNamePasswordNotMatchException"
type="Artech.Mvc.ExceptionHandling.Models.UserNamePasswordNotMatchException, Artech.Mvc.ExceptionHandling"
postHandlingAction="None">
<exceptionHandlers>
<add name="ErrorMessageSettingHandler"
type="Artech.Mvc.ExceptionHandling.ErrorMessageSettingHandler, Artech.Mvc.ExceptionHandling"
errorMessage="User name does not match password!"/>
</exceptionHandlers>
</add>
</exceptionTypes>
</add>
</exceptionPolicies>
</exceptionHandling>
現(xiàn)在我們通過路由映射將AccountController和Sign設置為默認Controller和Action后，開啟我們的應用程序。在輸入錯誤的用戶名和錯誤明碼的情況下在ValidationSummary中將自動得到相應的錯誤消息。
三、通過配置的Error View處理異常
在上面的配置中，針對InvalidUserNameException和UserNamePasswordNotMatchException這兩種異常類型的配置策略都將PostHandlingAction屬性設置為“None”，意味著不會將原來的異常和處理后的異常進行重新拋出?，F(xiàn)在我們將該屬性設置為“ThrowNewException”，意味著我們會將處理后的異常重新拋出來。
<exceptionHandling>
<exceptionPolicies>
<add name="myPolicy">
<exceptionTypes>
<add name="InvalidUserNameException" type="Artech.Mvc.ExceptionHandling.Models.InvalidUserNameException, Artech.Mvc.ExceptionHandling"
postHandlingAction="ThrowNewException">
...
<add name="UserNamePasswordNotMatchException" type="Artech.Mvc.ExceptionHandling.Models.UserNamePasswordNotMatchException, Artech.Mvc.ExceptionHandling"
postHandlingAction="ThrowNewException">
...
</add>
</exceptionTypes>
</add>
</exceptionPolicies>
</exceptionHandling>
按照我們上面的異常處理策略，在這種情況下我們將采用“錯誤頁面”的方式來進行異常處理。也HandleErrorAttribute的處理方式類似，我們支持異常類型和Error View之間的匹配關(guān)系，而這是通過類似于如下的配置來定義的。值得一提的是，這里的異常類型是經(jīng)過處理后重新拋出的異常。
<artech.exceptionHandling>
<add exceptionType="Artech.Mvc.ExceptionHandling.Models.InvalidUserNameException, Artech.Mvc.ExceptionHandling"
errorView="InvalideUserNameError"/>
<add exceptionType="Artech.Mvc.ExceptionHandling.Models.UserNamePasswordNotMatchException, Artech.Mvc.ExceptionHandling"
errorView="UserNamePasswordNotMatchError"/>
</artech.exceptionHandling>
如上面的配置所示，我們?yōu)镮nvalidUserNameException和UserNamePasswordNotMatchException這兩種異常類型定義了不同的Error View，分別是“InvalideUserNameError”和“UserNamePasswordNotMatchError”，詳細定義如下所示：
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<title>Error</title>
</head>
<body>
<p style="colorRed; font-weightbold">Sorry,the user name you specify does not exist!</p>
</body>
</html>
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<title>Error</title>
</head>
<body>
<p style="colorRed; font-weightbold">Sorry, The password does not match the given user name!</p>
</body>
</html>
現(xiàn)在我們按照上面的方式運行我們的程序，在分別輸入錯誤的用戶名和密碼的情況下會自動顯現(xiàn)相應的錯誤頁面。
四、自定義ActionInvoker：ExceptionActionInvoker
對于上述的兩種不同的異常處理方式最終是通過自定義的ActionInvoker來實現(xiàn)的，我們將其命名為ExceptionActionInvoker。如下面的代碼片斷所式，ExceptionActionInvoker直接繼承自ControllerActionInvoker。屬性ExceptionPolicy是一個基于指定的異常策略名稱創(chuàng)建的ExceptionPolicyImpl 對象，用于針對EntLib進行的異常處理。而屬性GetErrorView是一個用于獲得作為錯誤頁面的ViewResult對象的委托。整個異常處理的核心定義在InvokeAction方法中，該方法中指定的handleErrorActionName參數(shù)代表的是“異常處理操作名稱”，整個方法就是按照上述的異常處理策略實現(xiàn)的。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using Artech.Mvc.ExceptionHandling.Configuration;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
using Microsoft.Practices.EnterpriseLibrary.ExceptionHandling;
namespace Artech.Mvc.ExceptionHandling
{
public class ExceptionActionInvoker ControllerActionInvoker
{
protected ExceptionHandlingSettings ExceptionHandlingSettings{get; private set;}
protected virtual Func<string, HandleErrorInfo, ViewResult> GetErrorView { get; private set; }
public ExceptionPolicyImpl ExceptionPolicy { get; private set; }
public ExceptionActionInvoker(string exceptionPolicy,Func<string, HandleErrorInfo, ViewResult> getErrorView)
{
this.ExceptionPolicy = EnterpriseLibraryContainer.Current.GetInstance<ExceptionPolicyImpl>(exceptionPolicy);
this.GetErrorView = getErrorView;
this.ExceptionHandlingSettings = ExceptionHandlingSettings.GetSection();
}
public override bool InvokeAction(ControllerContext controllerContext, string handleErrorActionName)
{
ExceptionContext exceptionContext = controllerContext as ExceptionContext;
if (null == exceptionContext)
{
throw new ArgumentException("The controllerContext must be ExceptionContext!", "controllerContext");
}
try
{
exceptionContext.ExceptionHandled = true;
if (this.ExceptionPolicy.HandleException(exceptionContext.Exception))
{
HandleRethrownException(exceptionContext);
}
else
{
if (ExceptionHandlingContext.Current.Errors.Count == 0)
{
ExceptionHandlingContext.Current.Errors.Add(exceptionContext.Exception.Message);
}
ControllerDescriptor controllerDescriptor = this.GetControllerDescriptor(exceptionContext);
ActionDescriptor handleErrorAction = FindAction(exceptionContext, controllerDescriptor, handleErrorActionName);
if (null != handleErrorAction)
{
IDictionary<string, object> parameters = GetParameterValues(controllerContext, handleErrorAction);
exceptionContext.Result = this.InvokeActionMethod(exceptionContext, handleErrorAction, parameters);
}
else
{
HandleRethrownException(exceptionContext);
}
}
return true;
}
catch (Exception ex)
{
exceptionContext.Exception = ex;
HandleRethrownException(exceptionContext);
return true;
}
}
protected virtual void HandleRethrownException(ExceptionContext exceptionContext)
{
string errorViewName = this.GetErrorViewName(exceptionContext.Exception.GetType());
string controllerName = (string)exceptionContext.RouteData.GetRequiredString("controller");
string action = (string)exceptionContext.RouteData.GetRequiredString("action");
HandleErrorInfo handleErrorInfo = new HandleErrorInfo(exceptionContext.Exception, controllerName, action);
exceptionContext.Result = this.GetErrorView(errorViewName, handleErrorInfo);
}
protected string GetErrorViewName(Type exceptionType)
{
ExceptionErrorViewElement element = ExceptionHandlingSettings.ExceptionErrorViews
.Cast<ExceptionErrorViewElement>().FirstOrDefault(el=>el.ExceptionType == exceptionType);
if(null != element)
{
return element.ErrorView;
}
if(null== element && null != exceptionType.BaseType!= null)
{
return GetErrorViewName(exceptionType.BaseType);
}
else
{
return "Error";
}
}
}
}
五、自定義Controller：BaseController
ExceptionActionInvoker最終在我們自定義的Controller基類BaseController中被調(diào)用的。ExceptionActionInvoker對象在構(gòu)造函數(shù)中被初始化，并在重寫的OnException方法中被調(diào)用。
using System;
using System.Web.Mvc;
namespace Artech.Mvc.ExceptionHandling
{
public abstract class BaseController Controller
{
public BaseController(string exceptionPolicy)
{
Func<string, HandleErrorInfo, ViewResult> getErrorView = (viewName, handleErrorInfo) => this.View(viewName, handleErrorInfo);
this.ExceptionActionInvoker = new ExceptionActionInvoker(exceptionPolicy,getErrorView);
}
public BaseController(ExceptionActionInvoker actionInvoker)
{
this.ExceptionActionInvoker = actionInvoker;
}
public virtual ExceptionActionInvoker ExceptionActionInvoker { get; private set; }
protected virtual string GetHandleErrorActionName(string actionName)
{
return string.Format("On{0}Error", actionName);
}
protected override void OnException(ExceptionContext filterContext)
{
using (ExceptionHandlingContextScope contextScope = new ExceptionHandlingContextScope(filterContext))
{
string actionName = RouteData.GetRequiredString("action");
string handleErrorActionName = this.GetHandleErrorActionName(actionName);
this.ExceptionActionInvoker.InvokeAction(filterContext, handleErrorActionName);
foreach (var error in ExceptionHandlingContext.Current.Errors)
{
ModelState.AddModelError(Guid.NewGuid().ToString() ,error.ErrorMessage);
}
}
}
}
}
值得一提的是：整個OnException方法中的操作都在一個ExceptionHandlingContextScope中進行的。顧名思義， 我們通過ExceptionHandlingContextScope為ExceptionHandlingContext創(chuàng)建了一個范圍。ExceptionHandlingContext定義如下，我們可以通過它獲得當前的ExceptionContext和ModelErrorCollection，而靜態(tài)屬性Current返回當前的ExceptionHandlingContext對象。
public class ExceptionHandlingContext
{
[ThreadStatic]
private static ExceptionHandlingContext current;
public ExceptionContext ExceptionContext { get; private set; }
public ModelErrorCollection Errors { get; private set; }
public ExceptionHandlingContext(ExceptionContext exceptionContext)
{
this.ExceptionContext = exceptionContext;
this.Errors = new ModelErrorCollection();
}
public static ExceptionHandlingContext Current
{
get { return current; }
set { current = value; }
}
}
在BaseController的OnException方法中，當執(zhí)行了ExceptionActionInvoker的InvokeAction之后，我們會將當前ExceptionHandlingContext的ModelError轉(zhuǎn)移到當前的ModelState中。這就是為什么我們會通過ValidationSummary顯示錯誤信息的原因。對于我們的例子來說，錯誤消息的指定是通過如下所示的ErrorMessageSettingHandler 實現(xiàn)的，而它僅僅將指定的錯誤消息添加到當前ExceptionHandlingContext的Errors屬性集合中而已。
[ConfigurationElementType(typeof(ErrorMessageSettingHandlerData))]
public class ErrorMessageSettingHandler IExceptionHandler
{
public string ErrorMessage { get; private set; }
public ErrorMessageSettingHandler(string errorMessage)
{
thisErrorMessage = errorMessage;
}
public Exception HandleException(Exception exception, Guid handlingInstanceId)
{
if (null == ExceptionHandlingContextCurrent)
{
throw new InvalidOperationException("");
}
if (stringIsNullOrEmpty(thisErrorMessage))
{
ExceptionHandlingContextCurrentErrorsAdd(exceptionMessage);
}
else
{
ExceptionHandlingContextCurrentErrorsAdd(thisErrorMessage);
}
return exception;
}
}
源代碼從這里下載：http://xiazai.jb51.net/201701/yuanma/ExceptionHandling_jb51.rar
以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于ASP.NET Core中如何實現(xiàn)重定向的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-01-01
這篇文章主要介紹了.NET Core之微信支付之公眾號、H5支付篇，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-03-03
ASP.NET ashx實現(xiàn)無刷新頁面生成驗證碼
這篇文章主要為大家詳細介紹了ASP.NET ashx實現(xiàn)無刷新頁面生成驗證碼，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-09-09
asp.net(c#)復數(shù)類(復數(shù)加減乘除四則運算)
asp.net(c#)復數(shù)類(復數(shù)加減乘除四則運算)...2007-06-06
asp.net下URL處理兩個小工具方法...2007-04-04
sqlserver 批量數(shù)據(jù)替換助手V1.0版發(fā)布
前段時間網(wǎng)站被掛馬，數(shù)據(jù)庫表中很多文本字段都被加上了一段js腳本。修復完程序漏洞之后便開始著手清理這些被注入的數(shù)據(jù)，其間參考了一些網(wǎng)上的方法，大都是寫一個存儲過程進行一個表一個表逐一清理。2011-10-10
ASP.NET.4.5.1+MVC5.0設置系統(tǒng)角色與權(quán)限(一)
這篇文章主要介紹了ASP.NET.4.5.1+MVC5.0設置系統(tǒng)角色與權(quán)限的部分內(nèi)容，后續(xù)我們將繼續(xù)討論這個話題，希望小伙伴們喜歡。2015-01-01
ASP.NET AJAX 1.0 RC開發(fā)10分鐘圖解
12月15日，ASP.NET AJAX 1.0 RC版發(fā)布，我下載安裝試用了一下，沒有寫一行代碼，實現(xiàn)了一個簡單的AJAX應用，以下為截圖說明。2008-03-03
asp.net 上傳或下載當文件名包含有特殊字符"#"的處理
在上傳或下載文件時，當文件名包含有"#"特殊字符時，上傳以后的文件會被改名字，造成下載也下載不了。2010-03-03
C#時間格式化Datetime.ToString參數(shù)format格式詳細用法，本文將進行介紹，感興趣的朋友可以了解下啊2013-01-01