摘要
????? 本文將對“MVC公告發布系統”的發布公告功能添加日志功能和異常處理功能,借此來討論ASP.NET MVC中攔截器的使用方法。
一個小難題
????? 我們繼續完善“MVC公告發布系統”,這次,我們的需求是對公告發布功能添加日志記錄能力,即在發布公告前,記錄一次,在公告發布成功后,再記錄一次。然后還要使得其具備異常處理,即當業務組件出現問題時,跳轉到相應的錯誤頁面并顯示相應提示。
????? 有人可能笑了,這有什么難的,在DoRelease這個Action的開始和結束處各加入相應日志功能不久結了。異常處理更不在話下,直接try...catch搞定。
????? 沒錯,以上方法確實行得通,但是存在以下兩點問題:
????? 1.代碼重復問題。很多日志處理代碼和異常處理代碼是很相似的,這樣就導致了各個Action中存在大量重復代碼。
????? 2.職責被破壞。不要忘了,我們的Controller僅僅是控制器,它應該只負責表示邏輯,而不應該被一大堆日志處理代碼和try...catch塊包圍。我們要的Action,應該是干凈的、工整的、僅包含表示邏輯的Action。
????? 以上兩點,造成了我們系統中的壞味代碼。那么,怎么解決這個問題呢?
從廚師到AOP
????? 先來想象一個場景:飯店里的高級廚師怎么工作?我們知道,他不用洗菜切菜、不用端著盤子送菜、如果發現手里牛肉變質了他更不用拿著牛肉去找肉店老板理論,他的工作很單一:炒菜。
????? 當原料送來后,有專門的順菜切菜工進行洗菜、切菜,然后把處理好的菜送給廚師,廚師只管下鍋炒,炒完了送菜自然也不必關心,因為有專門的服務員負責這事。如果發現牛肉變質了,它只管說一聲,自然有相應的人處理這事。
????? 這個場景就是典型的AOP(面向切面編程)。廚師可以看成是業務組件,它有個方法就是“炒菜”,但是炒菜前要切菜,炒完了要有人送菜,可這不是廚師該關心的事啊!于是我們的切菜工和服務員就相當于攔截器,其中切菜工在炒菜前攔截,進行切菜,服務員在炒菜后攔截,負責送菜。當然,我們還有個異常攔截器:處理問題的人,就是那個當廚師發現肉變質了喊一聲,就來處理的人。
????? 基于這個場景,我們看看這樣有什么好處。首先是廚師職責單一了,他可以專注于自己的工作:炒菜,而不必理會不該自己關心的問題。而且“攔截器們”可以復用的,例如一個摳門的老板完全可以找3個廚師但是只招一名服務員,反正一名服務員就可以給三名廚師端菜,這樣,攔截器的復用使得代碼重復不見了!
回來
????? 好的,現在回到我們的“MVC
400電話
公告發布系統”。相信看了上面的場景,你的靈感一定來了:對啊,Action不就是廚師嗎,如果我們可以將日志功能做成攔截器,在DoRelease執行前先攔截一次完成記錄日志功能,DoRelease執行后再攔截一次記錄一次日志。最好還有個攔截器,在Action發生異常的時候可以攔截處理(就像上文處理變質牛肉的人),不就搞定了嗎。
????? 可是要怎么實現攔截Action呢?真是幸運之極,ASP.NET MVC框架中內置了這種機制!哈哈,我們趕快來做吧!
實現攔截器
????? 在ASP.NET MVC中,有三種攔截器:Action攔截器、Result攔截器和Exception攔截器。我要用到第一種和第三種。其實所謂的ASP.NET MVC攔截器,也沒什么神秘的,就是一個普通的類而已。只不過需要繼承FilterAttribute基類,Action攔截器還要實現
IActionFilter
接口,而Exception攔截器需要實現
IExceptionFilter接口。
????? 我們先來看實現:讓我們在Controllers目錄下新建一個Filters目錄,然后在Filters下新建兩個類,一個叫LoggerFilter一個叫ExceptionFilter。首先是LoggerFilter的代碼。
LoggerFilter.cs:
- using ?System; ??
- using ?System.Collections.Generic; ??
- using ?System.Linq; ??
- using ?System.Web; ??
- using ?System.Web.Mvc; ??
- using ?System.Web.Mvc.Ajax; ??
- ??
- namespace ?MVCDemo.Controllers.Filters ??
- { ??
- ???? public ? class ?LoggerFilter?:?FilterAttribute,?IActionFilter ??
- ????{ ??
- ???????? void ?IActionFilter.OnActionExecuting(ActionExecutingContext?filterContext) ??
- ????????{ ??
- ????????????filterContext.Controller.ViewData[ "ExecutingLogger" ]?=? "正要添加公告,已以寫入日志!時間:" ?+?DateTime.Now;? ??
- ????????} ??
- ??
- ???????? void ?IActionFilter.OnActionExecuted(ActionExecutedContext?filterContext) ??
- ????????{ ??
- ????????????filterContext.Controller.ViewData[ "ExecutedLogger" ]?=? "公告添加完成,已以寫入日志!時間:" ?+?DateTime.Now; ??
- ????????} ??
- ????} ??
- }??
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; using System.Web.Mvc.Ajax; namespace MVCDemo.Controllers.Filters { public class LoggerFilter : FilterAttribute, IActionFilter { void IActionFilter.OnActionExecuting(ActionExecutingContext filterContext) { filterContext.Controller.ViewData["ExecutingLogger"] = "正要添加公告,已以寫入日志!時間:" + DateTime.Now; } void IActionFilter.OnActionExecuted(ActionExecutedContext filterContext) { filterContext.Controller.ViewData["ExecutedLogger"] = "公告添加完成,已以寫入日志!時間:" + DateTime.Now; } } }?
????? 可以看到,這個類繼承了FilterAttribute并實現了IActionFilter。其中關鍵是IActionFilter,它有兩個方法,OnActionExecuting在被攔截Action前執行,OnActionExecuted在被攔截Action后執行。兩個方法都有一個參數,雖然類型不同,但其實都是一個作用:被攔截Action的上下文。
????? 這個地方我得解釋一下,你攔截器攔截了Action,在做處理時難免要用到被攔截Action相關的東西,例如在我們的例子中,就需要想被攔截 Action所在Controller的ViewData中添加內容,所以,攔截器方法有一個參數表示被攔截Action的上下文是順理成章的事。
??????下面再看ExceptionFilter這個攔截器,它是在Action出現異常時發揮作用的。
ExceptionFilter.cs:
- using ?System; ??
- using ?System.Collections.Generic; ??
- using ?System.Linq; ??
- using ?System.Web; ??
- using ?System.Web.Mvc; ??
- using ?System.Web.Mvc.Ajax; ??
- ??
- namespace ?MVCDemo.Controllers.Filters ??
- { ??
- ???? public ? class ?ExceptionFilter?:?FilterAttribute,IExceptionFilter ??
- ????{ ??
- ??????? //????http://www.my400800.cn ??
- ???????? void ?IExceptionFilter.OnException(ExceptionContext?filterContext) ??
- ????????{ ??
- ????????????filterContext.Controller.ViewData[ "ErrorMessage" ]?=?filterContext.Exception.Message; ??
- ????????????filterContext.Result?=? new ?ViewResult() ??
- ????????????{ ??
- ????????????????ViewName?=? "Error" , ??
- ????????????????ViewData?=?filterContext.Controller.ViewData, ??
- ????????????}; ??
- ????????????filterContext.ExceptionHandled?=? true ; ??
- ????????} ??
- ????} ??
- }??
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; using System.Web.Mvc.Ajax; namespace MVCDemo.Controllers.Filters { public class ExceptionFilter : FilterAttribute,IExceptionFilter { // http://www.my400800.cn void IExceptionFilter.OnException(ExceptionContext filterContext) { filterContext.Controller.ViewData["ErrorMessage"] = filterContext.Exception.Message; filterContext.Result = new ViewResult() { ViewName = "Error", ViewData = filterContext.Controller.ViewData, }; filterContext.ExceptionHandled = true; } } }?
????? 異常攔截器一樣需要繼承FilterAttribute,但是不要實現IActionFilter,而是要實現IExceptionFilter接口,這個接口只有一個方法:OnException,顧名思義,當然是發生異常時被調用了。我們看看我讓它做了什么:首先將異常信息(ExceptionContext一樣也是上下文,而其成員的Exception就是一個Exception類型的實例,就是被拋出的異常)記錄到 ViewData相應的鍵值里,然后我們要呈現Error這個視圖。
????? 注意!這里已經不是Controller里了,而是另一個類,所以當然不能調用View方法? 返回ViewResult實例了。我們只好新建一個ViewResult實例,并將其視圖名設為Error,將上下文中的DataView傳過去。
????? 最后那行filterContext.ExcepitonHandled = true;很重要,這行的意思是告訴系統,異常已經處理,不要再次處理了。
應用攔截器
????? 好了,攔截器建立完了,要怎么應用到相應的Action上呢?如果你使用過Spring,你一定對其AOP是實現之麻煩深有感觸,如果你和我一樣討厭寫各種XML的話,你真是太幸福了。因為在ASP.NET MVC中,應用攔截器簡直是輕松加愉快。只要將攔截器當做Attribute寫在要應用此攔截器的Action上就行了。看代碼。
AnnounceController.cs:
- using ?System; ??
- using ?System.Collections.Generic; ??
- using ?System.Linq; ??
- using ?System.Web; ??
- using ?System.Web.Mvc; ??
- using ?System.Web.Mvc.Ajax; ??
- using ?MVCDemo.Models; ??
- using ?MVCDemo.Models.Interfaces; ??
- using ?MVCDemo.Models.Entities; ??
- using ?MVCDemo.Controllers.Filters; ??
- ??
- namespace ?MVCDemo.Controllers ??
- { ??
- ???? public ? class ?AnnounceController?:?Controller ??
- ????{ ??
- ???????? public ?ActionResult?Release() ??
- ????????{ ??
- ????????????ICategoryService?cServ?=?ServiceBuilder.BuildCategoryService(); ??
- ????????????List<CategoryInfo>?categories?=?cServ.GetAll(); ??
- ????????????ViewData[ "Categories" ]?=? new ?SelectList(categories,? "ID" ,? "Name" ); ??
- ???????????? return ?View( "Release" ); ??
- ????????} ??
- ??
- ????????[LoggerFilter()] ??
- ????????[ExceptionFilter()] ??
- ???????? public ?ActionResult?DoRelease() ??
- ????????{ ??
- ????????????AnnounceInfo?announce?=? new ?AnnounceInfo() ??
- ????????????{ ??
- ????????????????ID?=?1, ??
- ????????????????Title?=?Request.Form[ "Title" ], ??
- ????????????????Category?=?Int32.Parse(Request.Form[ "Category" ]), ??
- ????????????????Content?=?Request.Form[ "Content" ], ??
- ????????????}; ??
- ??
- ????????????IAnnounceService?aServ?=?ServiceBuilder.BuildAnnounceService(); ??
- ????????????aServ.Release(announce); ??
- ??
- ????????????ViewData[ "Announce" ]?=?announce; ??
- ??
- ????????????System.Threading.Thread.Sleep(2000); ??
- ????????????ViewData[ "Time" ]?=?DateTime.Now; ??
- ????????????System.Threading.Thread.Sleep(2000); ??
- ??
- ???????????? return ?View( "ReleaseSucceed" ); ??
- ????????} ??
- ????} ??
- }??
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; using System.Web.Mvc.Ajax; using MVCDemo.Models; using MVCDemo.Models.Interfaces; using MVCDemo.Models.Entities; using MVCDemo.Controllers.Filters; namespace MVCDemo.Controllers { public class AnnounceController : Controller { public ActionResult Release() { ICategoryService cServ = ServiceBuilder.BuildCategoryService(); List<CategoryInfo> categories = cServ.GetAll(); ViewData["Categories"] = new SelectList(categories, "ID", "Name"); return View("Release"); } [LoggerFilter()] [ExceptionFilter()] public ActionResult DoRelease() { AnnounceInfo announce = new AnnounceInfo() { ID = 1, Title = Request.Form["Title"], Category = Int32.Parse(Request.Form["Category"]), Content = Request.Form["Content"], }; IAnnounceService aServ = ServiceBuilder.BuildAnnounceService(); aServ.Release(announce); ViewData["Announce"] = announce; System.Threading.Thread.Sleep(2000); ViewData["Time"] = DateTime.Now; System.Threading.Thread.Sleep(2000); return View("ReleaseSucceed"); } } }?
????? 看到沒有,只要在DoRelease上寫這么兩個Attribute,一切就完成了,至于什么時候該調用什么攔截器,都是框架幫你完成了。注意一點,為了讓我們看出攔截器的時序,我們在DoRelease中加了一點東西,就是加了一個ViewData["Time"],里面記錄了執行此Action的時間,因為日志攔截器在前后都會記錄時間,我們通過比較時間就可以看出執行順序了。至于那兩個Sleep則是讓效果更明顯的,這行代碼的意思是讓程序在這里延遲2秒。
????? 要執行這個程序,我們還要改一下ReleaseSucceed.aspx視圖,其實就是加幾個地方顯示ViewData里相應的數據。
ReleaseSucceed.aspx:
- <%@?Page?Language= "C#" ?AutoEventWireup= "true" ?CodeBehind= "ReleaseSucceed.aspx.cs" ?Inherits= "MVCDemo.Views.Announce.ReleaseSucceed" ?%> ??
- <%@?Import?Namespace= "MVCDemo.Models.Entities" ?%> ??
- ??
- <!DOCTYPE?html?PUBLIC? "-//W3C//DTD?XHTML?1.0?Transitional//EN" ? "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" > ??
- ??
- <html?xmlns= "http://www.w3.org/1999/xhtml" ?> ??
- <head?runat= "server" > ??
- ????<title></title> ??
- </head> ??
- <body> ??
- ????<%?AnnounceInfo?announce?=?ViewData[ "Announce" ]? as ?AnnounceInfo;?%> ??
- ????<div> ??
- ????????<h1>MVC公告發布系統——發布公告成功</h1> ??
- ????????<dl> ??
- ????????????<dt>ID:</dt> ??
- ????????????<dd><%=?announce.ID?%></dd> ??
- ????????????<dt>標題:</dt> ??
- ????????????<dd><%=?announce.Title?%></dd> ??
- ????????????<dt>類別ID:</dt> ??
- ????????????<dd><%=?announce.Category?%></dd> ??
- ????????????<dt>內容:</dt> ??
- ????????????<dd><%=?announce.Content?%></dd> ??
- ????????????<dt>發布時間:</dt> ??
- ????????????<dd><%=?ViewData[ "Time" ]?%></dd> ??
- ????????</dl> ??
- ????????<p><%=?ViewData[ "ExecutingLogger" ]?%></p> ??
- ????????<p><%=?ViewData[ "ExecutedLogger" ]?%></p> ??
- ????</div> ??
- </body> ??
- </html>??
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="ReleaseSucceed.aspx.cs" Inherits="MVCDemo.Views.Announce.ReleaseSucceed" %> <%@ Import Namespace="MVCDemo.Models.Entities" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title></title> </head> <body> <% AnnounceInfo announce = ViewData["Announce"] as AnnounceInfo; %> <div> <h1>MVC公告發布系統——發布公告成功</h1> <dl> <dt>ID:</dt> <dd><%= announce.ID %></dd> <dt>標題:</dt> <dd><%= announce.Title %></dd> <dt>類別ID:</dt> <dd><%= announce.Category %></dd> <dt>內容:</dt> <dd><%= announce.Content %></dd> <dt>發布時間:</dt> <dd><%= ViewData["Time"] %></dd> </dl> <p><%= ViewData["ExecutingLogger"] %></p> <p><%= ViewData["ExecutedLogger"] %></p> </div> </body> </html>?
????? 現在可以提交一則公告看結果了:
????? 下面我們來看看異常攔截器的效果。要觸發異常攔截器,首先要拋出一個異常,所以,我們在業務邏輯組件做點手腳。將MockAnnounceServices的Release方法改成如下:
- /**/ ///?<summary> ??
- ///?發布公告 ??
- ///?</summary> ??
- ///?<param?name="announce"></param> ??
- public ? void ?Release(AnnounceInfo?announce) ??
- { ??
- ???? throw ? new ?Exception( "發布公告失敗了!原因?沒有原因!我是業務組件,我說失敗就失敗!" ); ??
- ???? return ; ??
- }??
/**//// <summary> /// 發布公告 /// </summary> /// <param name="announce"></param> public void Release(AnnounceInfo announce) { throw new Exception("發布公告失敗了!原因?沒有原因!我是業務組件,我說失敗就失敗!"); return; }?
????? 另外,我們還要實現一個Error.aspx視圖,這是在異常攔截器中定義的錯誤視圖。我們將它新建在Views/Shared下就可以了。順便說一下,共用的視圖一般放在Shared下,因為ASP.NET MVC的視圖尋找機理是當與Controller同名目錄下不存在時,就到Shared下看看有沒有此視圖。
Error.aspx:
- <%@?Page?Language= "C#" ?AutoEventWireup= "true" ?CodeBehind= "Error.aspx.cs" ?Inherits= "MVCDemo.Views.Shared.Error" ?%> ??
- ??
- <!DOCTYPE?html?PUBLIC? "-//W3C//DTD?XHTML?1.0?Transitional//EN" ? "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" > ??
- ??
- <html?xmlns= "http://www.w3.org/1999/xhtml" ?> ??
- <head?runat= "server" > ??
- ????<title></title> ??
- </head> ??
- <body> ??
- ????<div> ??
- ????????<h1>系統發生異常</h1> ??
- ????????<%=?ViewData[ "ErrorMessage" ]?%> ??
- ????</div> ??
- </body> ??
- </html>??
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Error.aspx.cs" Inherits="MVCDemo.Views.Shared.Error" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title></title> </head> <body> <div> <h1>系統發生異常</h1> <%= ViewData["ErrorMessage"] %> </div> </body> </html>?
????? 好了,現在我們再提交新公告,會返回如下結果:
????? 我們再回過頭看看,使用了攔截器后,代碼是不是很清晰呢。
小結
????? 通過本文,朋友們應該可以掌握攔截器的基本使用以及使用它在表示層實現AOP了。下一篇作為本系列的終結篇,將對ASP.NET MVC做一個全面的討論,并與Web Form模型進行一個比較,使朋友們看清其優勢、劣勢,從而更好的學習使用這個框架。
更多文章、技術交流、商務合作、聯系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
