摘要
????? 本文將對(duì)“MVC公告發(fā)布系統(tǒng)”的發(fā)布公告功能添加日志功能和異常處理功能,借此來討論ASP.NET MVC中攔截器的使用方法。
一個(gè)小難題
????? 我們繼續(xù)完善“MVC公告發(fā)布系統(tǒng)”,這次,我們的需求是對(duì)公告發(fā)布功能添加日志記錄能力,即在發(fā)布公告前,記錄一次,在公告發(fā)布成功后,再記錄一次。然后還要使得其具備異常處理,即當(dāng)業(yè)務(wù)組件出現(xiàn)問題時(shí),跳轉(zhuǎn)到相應(yīng)的錯(cuò)誤頁面并顯示相應(yīng)提示。
????? 有人可能笑了,這有什么難的,在DoRelease這個(gè)Action的開始和結(jié)束處各加入相應(yīng)日志功能不久結(jié)了。異常處理更不在話下,直接try...catch搞定。
????? 沒錯(cuò),以上方法確實(shí)行得通,但是存在以下兩點(diǎn)問題:
????? 1.代碼重復(fù)問題。很多日志處理代碼和異常處理代碼是很相似的,這樣就導(dǎo)致了各個(gè)Action中存在大量重復(fù)代碼。
????? 2.職責(zé)被破壞。不要忘了,我們的Controller僅僅是控制器,它應(yīng)該只負(fù)責(zé)表示邏輯,而不應(yīng)該被一大堆日志處理代碼和try...catch塊包圍。我們要的Action,應(yīng)該是干凈的、工整的、僅包含表示邏輯的Action。
????? 以上兩點(diǎn),造成了我們系統(tǒng)中的壞味代碼。那么,怎么解決這個(gè)問題呢?
從廚師到AOP
????? 先來想象一個(gè)場(chǎng)景:飯店里的高級(jí)廚師怎么工作?我們知道,他不用洗菜切菜、不用端著盤子送菜、如果發(fā)現(xiàn)手里牛肉變質(zhì)了他更不用拿著牛肉去找肉店老板理論,他的工作很單一:炒菜。
????? 當(dāng)原料送來后,有專門的順菜切菜工進(jìn)行洗菜、切菜,然后把處理好的菜送給廚師,廚師只管下鍋炒,炒完了送菜自然也不必關(guān)心,因?yàn)橛袑iT的服務(wù)員負(fù)責(zé)這事。如果發(fā)現(xiàn)牛肉變質(zhì)了,它只管說一聲,自然有相應(yīng)的人處理這事。
????? 這個(gè)場(chǎng)景就是典型的AOP(面向切面編程)。廚師可以看成是業(yè)務(wù)組件,它有個(gè)方法就是“炒菜”,但是炒菜前要切菜,炒完了要有人送菜,可這不是廚師該關(guān)心的事啊!于是我們的切菜工和服務(wù)員就相當(dāng)于攔截器,其中切菜工在炒菜前攔截,進(jìn)行切菜,服務(wù)員在炒菜后攔截,負(fù)責(zé)送菜。當(dāng)然,我們還有個(gè)異常攔截器:處理問題的人,就是那個(gè)當(dāng)廚師發(fā)現(xiàn)肉變質(zhì)了喊一聲,就來處理的人。
????? 基于這個(gè)場(chǎng)景,我們看看這樣有什么好處。首先是廚師職責(zé)單一了,他可以專注于自己的工作:炒菜,而不必理會(huì)不該自己關(guān)心的問題。而且“攔截器們”可以復(fù)用的,例如一個(gè)摳門的老板完全可以找3個(gè)廚師但是只招一名服務(wù)員,反正一名服務(wù)員就可以給三名廚師端菜,這樣,攔截器的復(fù)用使得代碼重復(fù)不見了!
回來
????? 好的,現(xiàn)在回到我們的“MVC
400電話
公告發(fā)布系統(tǒng)”。相信看了上面的場(chǎng)景,你的靈感一定來了:對(duì)啊,Action不就是廚師嗎,如果我們可以將日志功能做成攔截器,在DoRelease執(zhí)行前先攔截一次完成記錄日志功能,DoRelease執(zhí)行后再攔截一次記錄一次日志。最好還有個(gè)攔截器,在Action發(fā)生異常的時(shí)候可以攔截處理(就像上文處理變質(zhì)牛肉的人),不就搞定了嗎。
????? 可是要怎么實(shí)現(xiàn)攔截Action呢?真是幸運(yùn)之極,ASP.NET MVC框架中內(nèi)置了這種機(jī)制!哈哈,我們趕快來做吧!
實(shí)現(xiàn)攔截器
????? 在ASP.NET MVC中,有三種攔截器:Action攔截器、Result攔截器和Exception攔截器。我要用到第一種和第三種。其實(shí)所謂的ASP.NET MVC攔截器,也沒什么神秘的,就是一個(gè)普通的類而已。只不過需要繼承FilterAttribute基類,Action攔截器還要實(shí)現(xiàn)
IActionFilter
接口,而Exception攔截器需要實(shí)現(xiàn)
IExceptionFilter接口。
????? 我們先來看實(shí)現(xiàn):讓我們?cè)贑ontrollers目錄下新建一個(gè)Filters目錄,然后在Filters下新建兩個(gè)類,一個(gè)叫LoggerFilter一個(gè)叫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" ]?=? "正要添加公告,已以寫入日志!時(shí)間:" ?+?DateTime.Now;? ??
- ????????} ??
- ??
- ???????? void ?IActionFilter.OnActionExecuted(ActionExecutedContext?filterContext) ??
- ????????{ ??
- ????????????filterContext.Controller.ViewData[ "ExecutedLogger" ]?=? "公告添加完成,已以寫入日志!時(shí)間:" ?+?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"] = "正要添加公告,已以寫入日志!時(shí)間:" + DateTime.Now;
}
void IActionFilter.OnActionExecuted(ActionExecutedContext filterContext)
{
filterContext.Controller.ViewData["ExecutedLogger"] = "公告添加完成,已以寫入日志!時(shí)間:" + DateTime.Now;
}
}
}
?
????? 可以看到,這個(gè)類繼承了FilterAttribute并實(shí)現(xiàn)了IActionFilter。其中關(guān)鍵是IActionFilter,它有兩個(gè)方法,OnActionExecuting在被攔截Action前執(zhí)行,OnActionExecuted在被攔截Action后執(zhí)行。兩個(gè)方法都有一個(gè)參數(shù),雖然類型不同,但其實(shí)都是一個(gè)作用:被攔截Action的上下文。
????? 這個(gè)地方我得解釋一下,你攔截器攔截了Action,在做處理時(shí)難免要用到被攔截Action相關(guān)的東西,例如在我們的例子中,就需要想被攔截 Action所在Controller的ViewData中添加內(nèi)容,所以,攔截器方法有一個(gè)參數(shù)表示被攔截Action的上下文是順理成章的事。
??????下面再看ExceptionFilter這個(gè)攔截器,它是在Action出現(xiàn)異常時(shí)發(fā)揮作用的。
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,但是不要實(shí)現(xiàn)IActionFilter,而是要實(shí)現(xiàn)IExceptionFilter接口,這個(gè)接口只有一個(gè)方法:OnException,顧名思義,當(dāng)然是發(fā)生異常時(shí)被調(diào)用了。我們看看我讓它做了什么:首先將異常信息(ExceptionContext一樣也是上下文,而其成員的Exception就是一個(gè)Exception類型的實(shí)例,就是被拋出的異常)記錄到 ViewData相應(yīng)的鍵值里,然后我們要呈現(xiàn)Error這個(gè)視圖。
????? 注意!這里已經(jīng)不是Controller里了,而是另一個(gè)類,所以當(dāng)然不能調(diào)用View方法? 返回ViewResult實(shí)例了。我們只好新建一個(gè)ViewResult實(shí)例,并將其視圖名設(shè)為Error,將上下文中的DataView傳過去。
????? 最后那行filterContext.ExcepitonHandled = true;很重要,這行的意思是告訴系統(tǒng),異常已經(jīng)處理,不要再次處理了。
應(yīng)用攔截器
????? 好了,攔截器建立完了,要怎么應(yīng)用到相應(yīng)的Action上呢?如果你使用過Spring,你一定對(duì)其AOP是實(shí)現(xiàn)之麻煩深有感觸,如果你和我一樣討厭寫各種XML的話,你真是太幸福了。因?yàn)樵贏SP.NET MVC中,應(yīng)用攔截器簡(jiǎn)直是輕松加愉快。只要將攔截器當(dāng)做Attribute寫在要應(yīng)用此攔截器的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");
}
}
}
?
????? 看到?jīng)]有,只要在DoRelease上寫這么兩個(gè)Attribute,一切就完成了,至于什么時(shí)候該調(diào)用什么攔截器,都是框架幫你完成了。注意一點(diǎn),為了讓我們看出攔截器的時(shí)序,我們?cè)贒oRelease中加了一點(diǎn)東西,就是加了一個(gè)ViewData["Time"],里面記錄了執(zhí)行此Action的時(shí)間,因?yàn)槿罩緮r截器在前后都會(huì)記錄時(shí)間,我們通過比較時(shí)間就可以看出執(zhí)行順序了。至于那兩個(gè)Sleep則是讓效果更明顯的,這行代碼的意思是讓程序在這里延遲2秒。
????? 要執(zhí)行這個(gè)程序,我們還要改一下ReleaseSucceed.aspx視圖,其實(shí)就是加幾個(gè)地方顯示ViewData里相應(yīng)的數(shù)據(jù)。
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公告發(fā)布系統(tǒng)——發(fā)布公告成功</h1> ??
- ????????<dl> ??
- ????????????<dt>ID:</dt> ??
- ????????????<dd><%=?announce.ID?%></dd> ??
- ????????????<dt>標(biāo)題:</dt> ??
- ????????????<dd><%=?announce.Title?%></dd> ??
- ????????????<dt>類別ID:</dt> ??
- ????????????<dd><%=?announce.Category?%></dd> ??
- ????????????<dt>內(nèi)容:</dt> ??
- ????????????<dd><%=?announce.Content?%></dd> ??
- ????????????<dt>發(fā)布時(shí)間:</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公告發(fā)布系統(tǒng)——發(fā)布公告成功</h1>
<dl>
<dt>ID:</dt>
<dd><%= announce.ID %></dd>
<dt>標(biāo)題:</dt>
<dd><%= announce.Title %></dd>
<dt>類別ID:</dt>
<dd><%= announce.Category %></dd>
<dt>內(nèi)容:</dt>
<dd><%= announce.Content %></dd>
<dt>發(fā)布時(shí)間:</dt>
<dd><%= ViewData["Time"] %></dd>
</dl>
<p><%= ViewData["ExecutingLogger"] %></p>
<p><%= ViewData["ExecutedLogger"] %></p>
</div>
</body>
</html>
?
????? 現(xiàn)在可以提交一則公告看結(jié)果了:
????? 下面我們來看看異常攔截器的效果。要觸發(fā)異常攔截器,首先要拋出一個(gè)異常,所以,我們?cè)跇I(yè)務(wù)邏輯組件做點(diǎn)手腳。將MockAnnounceServices的Release方法改成如下:
- /**/ ///?<summary> ??
- ///?發(fā)布公告 ??
- ///?</summary> ??
- ///?<param?name="announce"></param> ??
- public ? void ?Release(AnnounceInfo?announce) ??
- { ??
- ???? throw ? new ?Exception( "發(fā)布公告失敗了!原因?沒有原因!我是業(yè)務(wù)組件,我說失敗就失敗!" ); ??
- ???? return ; ??
- }??
/**//// <summary>
/// 發(fā)布公告
/// </summary>
/// <param name="announce"></param>
public void Release(AnnounceInfo announce)
{
throw new Exception("發(fā)布公告失敗了!原因?沒有原因!我是業(yè)務(wù)組件,我說失敗就失敗!");
return;
}
?
????? 另外,我們還要實(shí)現(xiàn)一個(gè)Error.aspx視圖,這是在異常攔截器中定義的錯(cuò)誤視圖。我們將它新建在Views/Shared下就可以了。順便說一下,共用的視圖一般放在Shared下,因?yàn)锳SP.NET MVC的視圖尋找機(jī)理是當(dāng)與Controller同名目錄下不存在時(shí),就到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>系統(tǒng)發(fā)生異常</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>系統(tǒng)發(fā)生異常</h1>
<%= ViewData["ErrorMessage"] %>
</div>
</body>
</html>
?
????? 好了,現(xiàn)在我們?cè)偬峤恍鹿妫瑫?huì)返回如下結(jié)果:
????? 我們?cè)倩剡^頭看看,使用了攔截器后,代碼是不是很清晰呢。
小結(jié)
????? 通過本文,朋友們應(yīng)該可以掌握攔截器的基本使用以及使用它在表示層實(shí)現(xiàn)AOP了。下一篇作為本系列的終結(jié)篇,將對(duì)ASP.NET MVC做一個(gè)全面的討論,并與Web Form模型進(jìn)行一個(gè)比較,使朋友們看清其優(yōu)勢(shì)、劣勢(shì),從而更好的學(xué)習(xí)使用這個(gè)框架。
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索:z360901061
微信掃一掃加我為好友
QQ號(hào)聯(lián)系: 360901061
您的支持是博主寫作最大的動(dòng)力,如果您喜歡我的文章,感覺我的文章對(duì)您有幫助,請(qǐng)用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點(diǎn)擊下面給點(diǎn)支持吧,站長非常感激您!手機(jī)微信長按不能支付解決辦法:請(qǐng)將微信支付二維碼保存到相冊(cè),切換到微信,然后點(diǎn)擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對(duì)您有幫助就好】元

