01net進(jìn)階開發(fā)版7個(gè)專題08課程代碼課件mvc57filter

er（篩選器）是基于AOP（面向方面編程）的設(shè)計(jì)，它的作用是對(duì)MVC框架處理客戶端請(qǐng)求注入額外的邏輯，以非常簡(jiǎn)單優(yōu)美的方式實(shí)現(xiàn)橫切關(guān)注點(diǎn)(s-cuttingoncerns)。橫切關(guān)注點(diǎn)是指橫越應(yīng)該程序的多個(gè)甚至所有模塊的功能，經(jīng)典的橫切關(guān)注點(diǎn)有日志記錄、緩存處理、異常處理和權(quán)限驗(yàn)證等。本文將分別介紹MVC框架所支持的不同種類的er的創(chuàng)建和使用，以及如何控制它們的執(zhí)行。四種基本四種基本FilterMVCFilter理。這四類Filter如下表：MVCacionMVC框架為這些種類的Filter接口實(shí)現(xiàn)了默認(rèn)的特性類。如上表，ActionFil ttribute類實(shí)現(xiàn)了IActionFilter和IResultFilter兩個(gè)接口，這個(gè)類是一個(gè)抽象類，必須對(duì)它提供實(shí)現(xiàn)。另外兩個(gè)特性類，AuthorizeAttribute和HandleErrorAttribute，已經(jīng)提供了一些有用的方法，可以直接既能應(yīng)用在單個(gè)的[Authorize(Roles="trader")]actionpublicclassExampleController:Controller{[ShowMessage]//ation[OutputCache(Duration=60ation publicActionResultIndex() // }AuthorizationcontrollerFilterAuthorizationAuthorizationFilteractionFilter策略，保證action方法只能被的用戶調(diào)用。AuthorizationFilter實(shí)現(xiàn)的接口如下：namespaceSystem.Web.MvcpublicinterfaceIAuthorizationFilter voidOnAuthorization(AuthorizationContext}Authorization你可以自己實(shí)現(xiàn)IAuthorizationFilter接口來(lái)創(chuàng)建自己的安全認(rèn)證邏輯，但一般沒(méi)有這個(gè)必要也不推薦這樣做。如果要自定義安全認(rèn)證策略，更安全的方式是繼承默認(rèn)的AuthorizeAttribute類。類來(lái)演示自定義應(yīng)用程序，和往常的示例一樣添加一個(gè)Infrastructure文件夾，然后添加一個(gè)CustomAuthAttribute.cs類文件，代碼如下：namespaceMvcApplication1.InfrastructurepublicclassCustomAuthAttribute:AuthorizeAttribute privatebool publicCustomAuthAttribute(boolallowedParam) localAllowed= protectedoverrideboolAuthorizeCore(HttpContextBasehttpContext) if(httpContext.Request.IsLocal) return else return }這個(gè)簡(jiǎn)單的Filter，通過(guò)重寫AuthorizeCore方法，允許我們本地的請(qǐng)求，在應(yīng)用該Filter時(shí)，可以通過(guò)構(gòu)造函數(shù)來(lái)指定是否允許本地請(qǐng)求。AuthorizeAttribte類幫我們內(nèi)實(shí)現(xiàn)了很多東西，我們只需把重點(diǎn)放在AuthorizeCore方法上，在該方法中實(shí)現(xiàn)權(quán)限認(rèn)證的邏輯。FilterHome的controller，然后在Indexaction上應(yīng)用這個(gè)Filter。參數(shù)設(shè)置為false以保護(hù)這個(gè)action不被本地，如下：publicclassHomeController:ControllerpublicstringIndex() return"ThisistheIndexactionontheHome}運(yùn)行程序，根據(jù)系統(tǒng)生成的默認(rèn)路由值，將請(qǐng)求那么AuthorizationAuthorizeAttribute類作為FilterRoles屬性，string類型，用逗號(hào)分隔的角色名，action方法的用戶必須屬于這些角色publicclassHomeController:Controller[Authorize(Users="jim,steve,jack",Roles=publicstringIndex() return"ThisistheIndexactionontheHome}這里我們?yōu)镮ndex方法應(yīng)用了Authorize特性，并同時(shí)指定了能該方法的用戶和角色。要Indexaction，必須兩者都滿足條件，即用戶名必須是jim,steve,jack中的一個(gè)，而且必須屬性admin角色。另外，如果不指定任何用戶名和角色名（即[Authorize]），那么只要是登錄用戶都能Exception對(duì)于大部分應(yīng)用程序，AuthorizeAttribute特性類提供的權(quán)限策略是足夠用的。如果你有特殊的需求，則可以通過(guò)繼承AuthorizeAttributeExceptionExceptionFilterIExceptionFilternamespaceSystem.Web.MvcpublicinterfaceIExceptionFilter voidOnException(ExceptionContext}ExceptionContext常用屬性說(shuō)明在IExceptionFilter的接口定義中，唯一的OnException方法在未處理的異常時(shí)執(zhí)行，其中參數(shù)的類型：ExceptionContext，ControllerContext類，ControllerContext ControllerContext，ExceptionContext類還提供了以下對(duì)處理異常的常用屬ResultActionResultFilterExceptionFilterExceptionHandled屬性設(shè)置為true過(guò)，這個(gè)屬性一般在某個(gè)action方法上應(yīng)用了多個(gè)ExceptionFilter時(shí)會(huì)用到。屬性設(shè)置為InfrastructureRangeExceptionAttribute.cspublicclassRangeExceptionAttribute: ttribute,IExceptionFilterpublicvoidOnException(ExceptionContextfilterContext) if(!filterContext.ExceptionHandled&&filterContext.ExceptionisArgumentOutOfRangeException){ filterContext.Result=new filterContext.ExceptionHandled= }這個(gè)ExceptionFilter通過(guò)重定向到Content 下的一個(gè)靜態(tài)html文件來(lái)顯示友好的ArgumentOutOfRangeException異常信息。我們定義的RangeExceptionAttribute類繼承了 ttribute類，并且實(shí)現(xiàn)了IException接口。作為一個(gè)MVCFilter，它的類必須實(shí)現(xiàn)IMvcFilter接口，你可以直接實(shí)現(xiàn)這個(gè)接口，但更簡(jiǎn)單的方法是繼承Fil ttribute基類，該基類實(shí)現(xiàn)了一些必要的接口并提供了一些有用的基本特性，比如按照默認(rèn)的順序來(lái)處理Filter。ContentRangeErrorPage.html<!DOCTYPE<!DOCTYPEhtml><html"> <title>RangeError</title></head> <span>Oneoftheargumentswasoutoftheexpected</body> publicclassHomeController:Controller publicstringRangeTest(intid) if(id>100) returnString.Format("Theidvalueis:{0}", }else thrownewArgumentOutOfRangeException("id",id, 為/由于靜態(tài)的html文件是和脫離的，所以實(shí)際項(xiàng)目中的是用一個(gè)View來(lái)呈現(xiàn)友好的錯(cuò)誤信息，以便很好的對(duì)它進(jìn)行一些動(dòng)態(tài)的控制。如下面把示例改動(dòng)一下，RangeExceptionAttribute類 publicclassRangeExceptionAttribute: ttribute,{ publicvoidOnException(ExceptionContextfilterContext) if(!filterContext.ExceptionHandled&&filterContext.ExceptionisArgumentOutOfRangeException){ intval= filterContext.Result=newViewResult ViewName= ViewData=new filterContext.ExceptionHandled= ViewResultViewmodel然后我們?cè)赩iews/Shared文件夾下添加一個(gè)RangeError.cshtml文件，代碼如下：@model<!DOCTYPEhtml><html> <metaname="viewport"content="width=device-width" <title>RangeError</title></head> <span>Thevalue@Modelwasoutoftheexpected @Html.ActionLink("Changevalueandtryagain",</div></body>很多時(shí)候異常是不可預(yù)料的，在每個(gè)Action方法或Controller上應(yīng)用ExceptionFilter是不現(xiàn)實(shí)ViewFilterRangeError.cshtmlView@modelvarcount=varnumber=Model/}Web.config何時(shí)何地了異常都可以顯示統(tǒng)一的友好錯(cuò)誤信息。在Web.config文件中的<system.web>節(jié)<customErrorsmode="On"使用內(nèi)置的Exceptin通過(guò)上面的演示，我們理解了ExceptinFilter在MVC背后是如何運(yùn)行的。但我們并不會(huì)經(jīng)常去創(chuàng)建自己的ExceptinFilter，因?yàn)槲④浽贛VC框架中內(nèi)置的HandleErrorAttribute(實(shí)現(xiàn)了IExceptionFilter接口)已經(jīng)足夠我們平時(shí)使用。它包含ExceptionType、View和Master三個(gè)屬性。當(dāng)ExceptionType屬性指定類型的異常被時(shí)，這個(gè)Filter將用View屬性指定的View（使用默認(rèn)的Layout或Mast屬性指定的Layout）來(lái)呈現(xiàn)一個(gè)頁(yè)面。如下面代碼所示：[HandleError(ExceptionType=typeof(ArgumentOutOfRangeException),View"RangeError")]publicstringRangeTest(intid)if(id>100) returnString.Format("Theidvalueis:{0}",}else thrownewArgumentOutOfRangeException("id",id,}使用內(nèi)置的HandleErrorAttribute，將異常信息呈現(xiàn)到View時(shí)，這個(gè)特性同時(shí)會(huì)傳遞一個(gè)HandleErrorInfo對(duì)象作為View的model。HandleErrorInfo類包含ActionName、ControllerNameException屬性，如下面的RangeError.cshtml使用這個(gè)model@modelViewBag.Title="Sorry,therewasa}<!DOCTYPEhtml><html> <metaname="viewport"content="width=device-width" <title>RangeError</title></head> <span>Thevalue wasoutoftheexpected @Html.ActionLink("Changevalueandtryagain", <div y: </div></body>ActionAction顧名思義，ActionFilteraction現(xiàn)IActionFilter接口，該接口定義如下：namespaceSystem.Web.MvcpublicinterfaceIActionFilter voidOnActionExecuting(ActionExecutingContext voidOnActionExecuted(ActionExecutedContext}usingSystem.Diagnostics;usingnamespaceMvcApplication1.InfrastructurepublicclassProfileActionAttribute: ttribute,IActionFilter privateStopwatch publicvoidOnActionExecuting(ActionExecutingContextfilterContext) timer= publicvoidOnActionExecuted(ActionExecutedContextfilterContext) if(filterContext.Exception==null) string.Format("<div>Actionmethodelapsedtime:{0}</div>", }[ProfileAction]publicstringFilterTest()return"ThisistheActionFilterTest}定位到我們看到，ProfileActionOnActionExecuted方法是在FilterTest方法返回結(jié)果之前執(zhí)行的。確切的說(shuō)，OnActionExecuted方法是在actionactionResultOnActionExecutingOnActionExecutedActionExecutingContextResultResultFilteractionActionFilter現(xiàn)IResultFilter接口，定義如下：namespaceSystem.Web.MvcpublicinterfaceIResultFilter voidOnResultExecuting(ResultExecutingContext voidOnResultExecuted(ResultExecutedContext}IResultFilterIActionFilterResultFilterAction類文件，代碼如下：publicclassProfileResultAttribute: ttribute,IResultFilterprivateStopwatchpublicvoidOnResultExecuting(ResultExecutingContextfilterContext) timer=publicvoidOnResultExecuted(ResultExecutedContextfilterContext) string.Format("<div>Resultelapsedtime:{0}</div>",}[ProfileAction][ProfileResult]publicstringFilterTest()return"ThisistheActionFilterTest}內(nèi)置的內(nèi)置的Action和ResultMVC框架內(nèi)置了一個(gè) ttribute類用來(lái)創(chuàng)建action和result篩選器，即可以控classttribute:IActionFilter, publicvirtualvoidOnActionExecuting(ActionExecutingContextfilterContext){ publicvirtualvoidOnActionExecuted(ActionExecutedContextfilterContext){ publicvirtualvoidOnResultExecuting(ResultExecutingContextfilterContext){ publicvirtualvoidOnResultExecuted(ResultExecutedContextfilterContext){ }和類文件，代碼如下：publicclassProfileAllAttribute: ttributeprivateStopwatchpublicoverridevoidOnActionExecuting(ActionExecutingContextfilterContext){ timer=publicoverridevoidOnResultExecuted(ResultExecutedContextfilterContext){ string.Format("<div>Totalelapsedtime:{0}</div>",}[ProfileResult][ProfileAll]publicstringFilterTest()return"ThisistheFilterTest}運(yùn)行程序，URL/Home/FilterTestAction publicclassHomeController:ControllerprivateStopwatchpublicstringFilterTest() return"ThisistheFilterTestprotectedoverridevoidOnActionExecuting(ActionExecutingContextfilterContext){ timer=protectedoverridevoidOnResultExecuted(ResultExecutedContextfilterContext){ string.Format("<div>Totalelapsedtime: }為全局為全局全局Filter對(duì)整個(gè)應(yīng)用程序的所有controller下的所有action方法有效。在App_Start/FilterConfig.cs文件中的RegisterGlobalFilters方法，可以把一個(gè)Filter類為全usingSystem.Web;usingSystem.Web.Mvc;usingnamespaceMvcApplication1publicclassFilterConfig publicstaticvoidRegisterGlobalF