ASP.NET MVC 攔截器

     本文將對“MVC公告發布系統”的發布公告功能添加日誌功能和異常處理功能，藉此來討論ASP.NET MVC中攔截器的使用方法。

一個小難題

　　我們繼續完善“MVC公告發布系統”，這次，我們的需求是對公告發布功能添加日誌記錄能力，即在發布公告前，記錄一次，在公告發布成功後，再記錄一次。然後還要使得其具備異常處理，即當業務組件出現問題時，跳轉到相應的錯誤頁面並顯示相應提示。

　　有人可能笑了，這有什麼難的，在DoRelease這個Action的開始和結束處各加入相應日誌功能不久結了。異常處理更不在話下，直接try...catch搞定。

　　沒錯，以上方法確實行得通，但是存在以下兩點問題:

　　1.代碼重複問題。很多Tlog代碼和異常處理代碼是很相似的，這樣就導致了各個Action中存在大量重複代碼。

　　2.職責被破壞。不要忘了，我們的Controller僅僅是控制器，它應該只負責表示邏輯，而不應該被一大堆Tlog代碼和try...catch塊包圍。我們要的Action，應該是乾淨的、工整的、僅包含表示邏輯的Action。

　　以上兩點，造成了我們系統中的壞味代碼。那麼，怎麼解決這個問題呢？

　　從廚師到AOP

　　先來想象一個情境：飯店裡的進階廚師怎麼工作？我們知道，他不用洗菜切菜、不用端著盤子送菜、如果發現手裡牛肉變質了他更不用拿著牛肉去找肉店老闆理論，他的工作很單一：炒菜。

　　當原料送來後，有專門的順菜切菜工進行洗菜、切菜，然後把處理好的菜送給廚師，廚師只管下鍋炒，炒完了送菜自然也不必關心，因為有專門的服務員負責這事。如果發現牛肉變質了，它只管說一聲，自然有相應的人處理這事。

　　這個情境就是典型的AOP（面向切面編程）。廚師可以看成是業務組件，它有個方法就是“炒菜”，但是炒菜前要切菜，炒完了要有人送菜，可這不是廚師該關心的事啊！於是我們的切菜工和服務員就相當於攔截器，其中切菜工在炒菜前攔截，進行切菜，服務員在炒菜後攔截，負責送菜。當然，我們還有個異常攔截器：處理問題的人，就是那個當廚師發現肉變質了喊一聲，就來處理的人。

基於這個情境，我們看看這樣有什麼好處。首先是廚師職責單一了，他可以專註於自己的工作：炒菜，而不必理會不該自己關心的問題。而且“攔截器們”可以複用的，例如一個摳門的老闆完全可以找3個廚師但是只招一名服務員，反正一名服務員就可以給三名廚師端菜，這樣，攔截器的複用使得代碼重複不見了！

　　回來

　　好的，現在回到我們的“MVC公告發布系統”。相信看了上面的情境，你的靈感一定來了：對啊，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:

1using System;
2using System.Collections.Generic;
3using System.Linq;
4using System.Web;
5using System.Web.Mvc;
6using System.Web.Mvc.Ajax;
7
8namespace MVCDemo.Controllers.Filters
9{
10　　public class LoggerFilter : FilterAttribute, IActionFilter
11　　{
12　　　　void IActionFilter.OnActionExecuting(ActionExecutingContext filterContext)
13　　　　{
14　　　　　　filterContext.Controller.ViewData["ExecutingLogger"] = "正要添加公告，已以寫入日誌！時間：" + DateTime.Now;
15　　　　}
16
17　　　　void IActionFilter.OnActionExecuted(ActionExecutedContext filterContext)
18　　　　{
19　　　　　　filterContext.Controller.ViewData["ExecutedLogger"] = "公告添加完成，已以寫入日誌！時間：" + DateTime.Now;
20　　　　}
21　　}
22}

 

可以看到，這個類繼承了FilterAttribute並實現了IActionFilter。其中關鍵是IActionFilter，它有兩個方法，OnActionExecuting在被攔截Action前執行，OnActionExecuted在被攔截Action後執行。兩個方法都有一個參數，雖然類型不同，但其實都是一個作用：被攔截Action的上下文。

　　這個地方我得解釋一下，你攔截器攔截了Action，在做處理時難免要用到被攔截Action相關的東西，例如在我們的例子中，就需要想被攔截Action所在Controller的ViewData中新增內容，所以，攔截器方法有一個參數表示被攔截Action的上下文是順理成章的事。

　　下面再看ExceptionFilter這個攔截器，它是在Action出現異常時發揮作用的。

　　ExceptionFilter.cs:

1using System;
2using System.Collections.Generic;
3using System.Linq;
4using System.Web;
5using System.Web.Mvc;
6using System.Web.Mvc.Ajax;
7
8namespace MVCDemo.Controllers.Filters
9{
10　　public class ExceptionFilter : FilterAttribute,IExceptionFilter
11　　{
12　　　　void IExceptionFilter.OnException(ExceptionContext filterContext)
13　　　　{
14　　　　　　filterContext.Controller.ViewData["ErrorMessage"] = filterContext.Exception.Message;
15　　　　　　filterContext.Result = new ViewResult()
16　　　　　　{
17　　　　　　　　ViewName = "Error",
18　　　　　　　　ViewData = filterContext.Controller.ViewData,
19　　　　　　};
20　　　　　　filterContext.ExceptionHandled = true;
21　　　　}
22　　}
23}

 

異常攔截器一樣需要繼承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:

1using System;
2using System.Collections.Generic;
3using System.Linq;
4using System.Web;
5using System.Web.Mvc;
6using System.Web.Mvc.Ajax;
7using MVCDemo.Models;
8using MVCDemo.Models.Interfaces;
9using MVCDemo.Models.Entities;
10using MVCDemo.Controllers.Filters;
11
12namespace MVCDemo.Controllers
13{
14　　public class AnnounceController : Controller
15　　{
16　　　　public ActionResult Release()
17　　　　{
18　　　　　　ICategoryService cServ = ServiceBuilder.BuildCategoryService();
19　　　　　　List<CategoryInfo> categories = cServ.GetAll();
20　　　　　　ViewData["Categories"] = new SelectList(categories, "ID", "Name");
21　　　　　　return View("Release");
22　　　　}
23
24　　　　[LoggerFilter()]
25　　　　[ExceptionFilter()]
26　　　　public ActionResult DoRelease()
27　　　　{
28　　　　　　AnnounceInfo announce = new AnnounceInfo()
29　　　　　　{
30　　　　　　　　ID = 1,
31　　　　　　　　Title = Request.Form["Title"],
32　　　　　　　　Category = Int32.Parse(Request.Form["Category"]),
33　　　　　　　　Content = Request.Form["Content"],
34　　　　　　};
35
36　　　　　　IAnnounceService aServ = ServiceBuilder.BuildAnnounceService();
37　　　　　　aServ.Release(announce);
38
39　　　　　　ViewData["Announce"] = announce;
40
41　　　　　　System.Threading.Thread.Sleep(2000);
42　　　　　　ViewData["Time"] = DateTime.Now;
43　　　　　　System.Threading.Thread.Sleep(2000);
44
45　　　　　　return View("ReleaseSucceed");
46　　　　}
47　　}
48}

 

看到沒有，只要在DoRelease上寫這麼兩個Attribute，一切就完成了，至於什麼時候該調用什麼攔截器，都是架構幫你完成了。注意一點，為了讓我們看出攔截器的時序，我們在DoRelease中加了一點東西，就是加了一個ViewData["Time"]，裡面記錄了執行此Action的時間，因為日誌攔截器在前後都會記錄時間，我們通過比較時間就可以看出執行順序了。至於那兩個Sleep則是讓效果更明顯的，這行代碼的意思是讓程式在這裡延遲2秒。

　　要執行這個程式，我們還要改一下ReleaseSucceed.aspx視圖，其實就是加幾個地方顯示ViewData裡相應的資料。

　　ReleaseSucceed.aspx:

1<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="ReleaseSucceed.aspx.cs" Inherits="MVCDemo.Views.Announce.ReleaseSucceed" %>
2<%@ Import Namespace="MVCDemo.Models.Entities" %>
3
4<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://tech.ddvip.com/%22http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd/%22">
5
6<html xmlns="http://tech.ddvip.com/%22http://www.w3.org/1999/xhtml/%22" >
7<head runat="server">
8　　<title></title>
9</head>
10<body>
11　　<% AnnounceInfo announce = ViewData["Announce"] as AnnounceInfo; %>
12　　<div>
13　　　　<h1>MVC公告發布系統——發布公告成功</h1>
14　　　　<dl>
15　　　　　　<dt>ID：</dt>
16　　　　　　<dd><%= announce.ID %></dd>
17　　　　　　<dt>標題：</dt>
18　　　　　　<dd><%= announce.Title %></dd>
19　　　　　　<dt>類別ID：</dt>
20　　　　　　<dd><%= announce.Category %></dd>
21　　　　　　<dt>內容：</dt>
22　　　　　　<dd><%= announce.Content %></dd>
23　　　　　　<dt>發布時間：</dt>
24　　　　　　<dd><%= ViewData["Time"] %></dd>
25　　　　</dl>
26　　　　<p><%= ViewData["ExecutingLogger"] %></p>
27　　　　<p><%= ViewData["ExecutedLogger"] %></p>
28　　</div>
29</body>
30</html>

 

沒有問題，攔截器方法順利執行，而且從時間可以看出，OnActionExecuting先執行，Action執行，然後OnActionExecuted執行。

　　下面我們來看看異常攔截器的效果。要觸發異常攔截器，首先要拋出一個異常，所以，我們在商務邏輯組件做點手腳。將MockAnnounceServices的Release方法改成如下：

1/**//// <summary>
2/// 發布公告
3/// </summary>
4/// <param name="announce"></param>
5public void Release(AnnounceInfo announce)
6{
7　　throw new Exception("發布公告失敗了！原因？沒有原因！我是業務組件，我說失敗就失敗！");
8　　return;
9}

　　另外，我們還要實現一個Error.aspx視圖，這是在異常攔截器中定義的錯誤視圖。我們將它建立在Views/Shared下就可以了。順便說一下，共用的視圖一般放在Shared下，因為ASP.NET MVC的視圖尋找機理是當與Controller同名目錄下不存在時，就到Shared下看看有沒有此視圖。

　　Error.aspx:

1<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Error.aspx.cs" Inherits="MVCDemo.Views.Shared.Error" %>
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://tech.ddvip.com/%22http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd/%22">
4
5<html xmlns="http://tech.ddvip.com/%22http://www.w3.org/1999/xhtml/%22" >
6<head runat="server">
7　　<title></title>
8</head>
9<body>
10　　<div>
11　　　　<h1>系統發生異常</h1>
12　　　　<%= ViewData["ErrorMessage"] %>
13　　</div>
14</body>
15</html>

 

            很明顯，業務組件拋出了異常，但是我們的Action方法中並沒有用try...catch處理，但是異常攔截器成功攔截了異常，並做了相應處理。

　　我們再回過頭看看，使用了攔截器後，代碼是不是很清晰呢。

　　小結

　　通過本文，朋友們應該可以掌握攔截器的基本使用以及使用它在展示層實現AOP了。下一篇作為本系列的終結篇，將對ASP.NET MVC做一個全面的討論，並與Web Form模型進行一個比較，使朋友們看清其優勢、劣勢，從而更好的學習使用這個架構。