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

er（篩選器）是基于AOP（面向方面編程）的設(shè)計(jì)，它的作用是對MVC框架處理客戶端請求注入額外的邏輯，以非常簡單優(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í)行。本四種基本四種基本Filter概述MVC架支持的Filter以歸為四類，每一類都可以對處理請求的不同時(shí)間點(diǎn)引入額外的邏輯處理。這四類Filter如下表：MVC架調(diào)用acion前，它會(huì)先判斷有沒有實(shí)現(xiàn)上表中的接口的特性，如果有，則在請求管MVC框架為這些種類的Filter接口實(shí)現(xiàn)了默認(rèn)的特性類。如上表，ActionFil ttribute類實(shí)現(xiàn)了IActionFilter和IResultFilter兩個(gè)接口，這個(gè)類是一個(gè)抽象類，必須對它提供實(shí)現(xiàn)。另外兩個(gè)特性類，AuthorizeAttribute和HandleErrorAttribute，已經(jīng)提供了一些有用的方法，可以直接Filter既能應(yīng)用在單個(gè)的ation方法上，也能應(yīng)用在整個(gè)controller上，并可以在acioncontroller上應(yīng)用多個(gè)Filter。如下所示[Authorize(Roles="trader")]actionpublicclassExampleController:Controller{[ShowMessage]//ation[OutputCache(Duration=60ation publicActionResultIndex() // }Authorization注意，對于自定義的controller基類，應(yīng)用于該基類的Filter將對繼承自該基類的所有子類有AuthorizationAuthorizationFilter在action法和其他種類的Filter前運(yùn)行的。它的作用是強(qiáng)制實(shí)施權(quán)限策略，保證action方法只能被的用戶調(diào)用。AuthorizationFilter實(shí)現(xiàn)的接口如下：namespaceSystem.Web.MvcpublicinterfaceIAuthorizationFilter voidOnAuthorization(AuthorizationContext}Authorization你可以自己實(shí)現(xiàn)IAuthorizationFilter接口來創(chuàng)建自己的安全認(rèn)證邏輯，但一般沒有這個(gè)必要也不推薦這樣做。如果要自定義安全認(rèn)證策略，更安全的方式是繼承默認(rèn)的AuthorizeAttribute類。類應(yīng)用程序，和往常的示例一樣添加一個(gè)Infrastructure文件夾，然后添加一個(gè)CustomAuthAttribute.cs類文件，代碼如下：namespaceMvcApplication1.InfrastructurepublicclassCustomAuthAttribute:AuthorizeAttribute privatebool publicCustomAuthAttribute(boolallowedParam) localAllowed= protectedoverrideboolAuthorizeCore(HttpContextBasehttpContext) if(httpContext.Request.IsLocal) return else return }這個(gè)簡單的Filter，通過重寫AuthorizeCore方法，允許我們本地的請求，在應(yīng)用該Filter時(shí)，可以通過構(gòu)造函數(shù)來指定是否允許本地請求。AuthorizeAttribte類幫我們內(nèi)實(shí)現(xiàn)了很多東西，我們只需把重點(diǎn)放在AuthorizeCore方法上，在該方法中實(shí)現(xiàn)權(quán)限認(rèn)證的邏輯。為了演示這個(gè)Filter作用，我們新建一個(gè)名為Home的controller，然后在Indexaction法上應(yīng)用這個(gè)Filter。參數(shù)設(shè)置為false以保護(hù)這個(gè)action不被本地，如下：publicclassHomeController:ControllerpublicstringIndex() return"ThisistheIndexactionontheHome}運(yùn)行程序，根據(jù)系統(tǒng)生成的默認(rèn)路由值，將請求/Home/Index，結(jié)果如下類類本身作為Filter有哪些有用的功能呢Authorization當(dāng)我們直接使用AuthorizeAttribute類作為Filter，可以通過兩個(gè)屬性來指定我們的權(quán)限策略。Users屬性，string類型，指定允許action方法的用戶名，多個(gè)用戶名用逗號(hào)隔開Roles屬性，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]），那么只要是登錄用戶都能action方法你可以通過創(chuàng)建一個(gè)Internet模板的應(yīng)用程序來看一下效果，這里就不演示了Exception對于大部分應(yīng)用程序，AuthorizeAttribute特性類提供的權(quán)限策略是足夠用的。如果你有特殊的需求，則可以通過繼承AuthorizeAttribute類來滿足ExceptionExceptionFilter，在下面三種來源拋出未處理的異常時(shí)運(yùn)行另外一種Filter（如Authorization、Action或Result等Filter）Action方法本身Action方法執(zhí)行完成（即處理ActionResult的時(shí)候）ExceptionFilter須實(shí)現(xiàn)IExceptionFilter接口，該接口的定義如下namespaceSystem.Web.MvcpublicinterfaceIExceptionFilter voidOnException(ExceptionContext}ExceptionContext常用屬性說明在IExceptionFilter的接口定義中，唯一的OnException方法在未處理的異常時(shí)執(zhí)行，其中參數(shù)的類型：ExceptionContext，它繼承自ControllerContext類，ControllerContext含如下Controller，返回當(dāng)前請求的controller對象HttpContext，提供請求和響應(yīng)的詳細(xì)信息IsChildAction，如果是子action則返回true（稍后將簡單介紹子action）Reqontext，提供請求上下文信息RouteData，當(dāng)前請求的路由實(shí)例信息作為繼承ControllerContext的子類，ExceptionContext類還提供了以下對處理異常的常用屬ActionDescriptor，提供action方法的詳細(xì)信息Result，是一個(gè)ActionResult類型，通過把這個(gè)屬性值設(shè)為非空可以讓某個(gè)Filter執(zhí)行取Exception，未處理異常信息ExceptionHandled，如果另外一個(gè)Filter把這個(gè)異常標(biāo)記為已處理則返回true一個(gè)ExceptionFilter可以通過把ExceptionHandled屬性設(shè)置為true來標(biāo)注該異常已被處理過，這個(gè)屬性一般在某個(gè)action方法上應(yīng)用了多個(gè)ExceptionFilter時(shí)會(huì)用到。ExceptionHandled屬性設(shè)置為true，就可以通過該屬性的值來判斷其它應(yīng)用在同一個(gè)action方法ExceptionFilter是否已經(jīng)處理了這個(gè)異常，以免同一個(gè)異常在不同的Filter中重復(fù)被處理Infrastructure文件夾下添加一個(gè)RangeExceptionAttribute.cs類文件，代碼如下publicclassRangeExceptionAttribute: ttribute,IExceptionFilterpublicvoidOnException(ExceptionContextfilterContext) if(!filterContext.ExceptionHandled&&filterContext.ExceptionisArgumentOutOfRangeException){ filterContext.Result=new filterContext.ExceptionHandled= }這個(gè)ExceptionFilter通過重定向到Content 下的一個(gè)靜態(tài)html文件來顯示友好的ArgumentOutOfRangeException異常信息。我們定義的RangeExceptionAttribute類繼承了 ttribute類，并且實(shí)現(xiàn)了IException接口。作為一個(gè)MVCFilter，它的類必須實(shí)現(xiàn)IMvcFilter接口，你可以直接實(shí)現(xiàn)這個(gè)接口，但更簡單的方法是繼承Fil ttribute基類，該基類實(shí)現(xiàn)了一些必要的接口并提供了一些有用的基本特性，比如按照默認(rèn)的順序來處理Filter。Content件夾下面添加一個(gè)名為RangeErrorPage.html文件用來顯示友好的錯(cuò)誤信息。如<!DOCTYPE<!DOCTYPEhtml><html"> <title>RangeError</title></head> <span>Oneoftheargumentswasoutoftheexpected</body>在HomeController中添加一個(gè)值越限時(shí)拋出異常的action，如下所示 publicclassHomeController:Controller publicstringRangeTest(intid) if(id>100) returnString.Format("Theidvalueis:{0}", }else thrownewArgumentOutOfRangeException("id",id, 當(dāng)對RangeTest應(yīng)用自定義的的ExceptionFilter時(shí)，運(yùn)行程序URL請為/Home/RangeTest/50，程序拋出異常后將重定向到RangeErrorPage.html頁面由于靜態(tài)的html文件是和脫離的，所以實(shí)際項(xiàng)目中的是用一個(gè)View來呈現(xiàn)友好的錯(cuò)誤信息，以便很好的對它進(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= 我們創(chuàng)建一個(gè)ViewResult象，指定了發(fā)生異常時(shí)要重定向的View稱和傳遞的model象。然后我們在Views/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>運(yùn)行結(jié)果如下很多時(shí)候異常是不可預(yù)料的，在每個(gè)Action方法或Controller上應(yīng)用ExceptionFilter是不現(xiàn)實(shí)的。而且如果異常出現(xiàn)在View也無法應(yīng)用FilterRangeError.cshtml個(gè)View入下面代@modelvarcount=varnumber=Model/}運(yùn)行程序后，將會(huì)顯示如下信息顯然程序發(fā)布后不應(yīng)該顯示這些信息給用戶看。我們可以通過配置Web.config應(yīng)用程序不管在何時(shí)何地了異常都可以顯示統(tǒng)一的友好錯(cuò)誤信息。在Web.config文件中的<system.web>節(jié)<customErrorsmode="On"這個(gè)配置只對有效，本地運(yùn)行站點(diǎn)依然會(huì)顯示信息使用內(nèi)置的Exceptin通過上面的演示，我們理解了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）來呈現(xiàn)一個(gè)頁面。如下面代碼所示：[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對象作為View的model。HandleErrorInfo類包含ActionName、ControllerNameException性，如下面的RangeError.cshtml使用這個(gè)model呈現(xiàn)信@modelHandleErrorInfoViewBag.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法的執(zhí)行進(jìn)行“篩選”的，包括執(zhí)行前和執(zhí)行后。它需要實(shí)現(xiàn)IActionFilter接口，該接口定義如下：namespaceSystem.Web.MvcpublicinterfaceIActionFilter voidOnActionExecuting(ActionExecutingContext voidOnActionExecuted(ActionExecutedContext}其中，OnActionExecuting方法在action方法執(zhí)行之前被調(diào)用，OnActionExecuted方法action方法執(zhí)行之后被調(diào)用。我們來看一個(gè)簡單的例子在Infrastructure文件夾下添加一個(gè)ProfileActionAttribute類，代碼如下usingSystem.Diagnostics;usingSystem.Web.Mvc;namespaceMvcApplication1.Infrastructure{publicclassProfileActionAttribute: ttribute,IActionFilter privateStopwatch publicvoidOnActionExecuting(ActionExecutingContextfilterContext) timer= publicvoidOnActionExecuted(ActionExecutedContextfilterContext) if(filterContext.Exception==null) string.Format("<div>Actionmethodelapsedtime:{0}</div>", }在HomeController中添加一個(gè)Action并應(yīng)用該Filter，如下[ProfileAction]publicstringFilterTest()return"ThisistheActionFilterTest}運(yùn)行程序，URL定位到/Home/FilterTest，結(jié)果如下我們看到，ProfileActionOnActionExecuted方法是在FilterTest方法返回結(jié)果之前執(zhí)行的。確切的說，OnActionExecuted方法是在action法執(zhí)行結(jié)束之后和處理action回結(jié)果之前執(zhí)ResultOnActionExecuting法和OnActionExecuted法分別接受ActionExecutingContextActionExecutedContext對象參數(shù)，這兩個(gè)參數(shù)包含了ActionDescriptor、Canceled、Exception常用屬ResultResultFilter來處理action法返回的結(jié)果。用法和ActionFilter似，它需要實(shí)現(xiàn)IResultFilter接口，定義如下：namespaceSystem.Web.MvcpublicinterfaceIResultFilter voidOnResultExecuting(ResultExecutingContext voidOnResultExecuted(ResultExecutedContext}IResultFilter口和之前的IActionFilter接口類似，要注意的是ResultFilter在Action之后執(zhí)行的。兩者用法是一樣的，不再多講，直接給出示例代碼在Infrastructure文件夾下再添加一個(gè)ProfileResultAttribute.cs類文件，代碼如下publicclassProfileResultAttribute: ttribute,IResultFilterprivateStopwatchpublicvoidOnResultExecuting(ResultExecutingContextfilterContext) timer=publicvoidOnResultExecuted(ResultExecutedContextfilterContext) string.Format("<div>Resultelapsedtime:{0}</div>",}應(yīng)用該[ProfileAction][ProfileResult]publicstringFilterTest()return"ThisistheActionFilterTest}內(nèi)置的內(nèi)置的Action和ResultMVC框架內(nèi)置了一個(gè) ttribute類用來創(chuàng)建action和result篩選器，即可以控action方法的執(zhí)行也可以控制處理action方法返回結(jié)果。它是一個(gè)抽象類，定義如下classttribute:IActionFilter, publicvirtualvoidOnActionExecuting(ActionExecutingContextfilterContext){ publicvirtualvoidOnActionExecuted(ActionExecutedContextfilterContext){ publicvirtualvoidOnResultExecuting(ResultExecutingContextfilterContext){ publicvirtualvoidOnResultExecuted(ResultExecutedContextfilterContext){ }使用這個(gè)抽象類方便之處是你只需要實(shí)現(xiàn)需要加以處理的方法。其他和使用和IResultFilter接口沒什么不同。下面是簡單做個(gè)示例在Infrastructure文件夾下添加一個(gè)ProfileAllAttribute.cs類文件，代碼如下publicclassProfileAllAttribute: ttributeprivateStopwatchpublicoverridevoidOnActionExecuting(ActionExecutingContextfilterContext){ timer=publicoverridevoidOnResultExecuted(ResultExecutedContextfilterContext){ string.Format("<div>Totalelapsedtime:{0}</div>",}在HomeController中的FilterTest方法上應(yīng)用該[ProfileResult][ProfileAll]publicstringFilterTest()return"ThisistheFilterTest}運(yùn)行程序，URL位到/Home/FilterTest，可以看到一個(gè)Action執(zhí)行之前到結(jié)果處理完畢總共我們也可以Controller中直接重寫 ttribute抽象類中定義的四個(gè)方法，效果和使Filter是一樣的，例如publicclassHomeController:ControllerprivateStopwatchpublicstringFilterTest() return"ThisistheFilterTestprotectedoverridevoidOnActionExecuting(ActionExecutingContextfilterContext){ timer=protectedoverridevoidOnResultExecuted(ResultExecutedContextfilterContext){ string.Format("<div>Totalelapsedtime: }為全局為全局全局Filter對整個(gè)應(yīng)用程序的所有controller下的所有action方法有效。在App_Start/FilterConfig.cs文件中的RegisterGlobalFilters方法，可以把一個(gè)Filter類為全usingSystem.Web;usingSystem.Web.Mvc;usingnamespaceMvcApplication1publicclassFilterConfig publicstaticvoidRegisterGlobalFilters(GlobalFilterCollection