ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
2012-01-11 13:00
483 查看
摘要
本文将对“MVC公告发布系统”的发布公告功能添加日志功能和异常处理功能，借此来讨论ASP.NET MVC中拦截器的使用方法。
一个小难题
我们继续完善“MVC公告发布系统”，这次，我们的需求是对公告发布功能添加日志记录能力，即在发布公告前，记录一次，在公告发布成功后，再记录一次。然后还要使得其具备异常处理，即当业务组件出现问题时，跳转到相应的错误页面并显示相应提示。
有人可能笑了，这有什么难的，在DoRelease这个Action的开始和结束处各加入相应日志功能不久结了。异常处理更不在话下，直接try...catch搞定。
没错，以上方法确实行得通，但是存在以下两点问题:
1.代码重复问题。很多日志处理代码和异常处理代码是很相似的，这样就导致了各个Action中存在大量重复代码。
2.职责被破坏。不要忘了，我们的Controller仅仅是控制器，它应该只负责表示逻辑，而不应该被一大堆日志处理代码和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
9using 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
9using 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
4<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml" >
7<head runat="server">
8 <title></title>
9</head>
10<body>
11 <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>复制代码
现在可以提交一则公告看结果了：
public void Release(AnnounceInfo announce)
6
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml" >
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模型进行一个比较，使朋友们看清其优势、劣势，从而更好的学习使用这个框架。
本文将对“MVC公告发布系统”的发布公告功能添加日志功能和异常处理功能，借此来讨论ASP.NET MVC中拦截器的使用方法。
一个小难题
我们继续完善“MVC公告发布系统”，这次，我们的需求是对公告发布功能添加日志记录能力，即在发布公告前，记录一次，在公告发布成功后，再记录一次。然后还要使得其具备异常处理，即当业务组件出现问题时，跳转到相应的错误页面并显示相应提示。
有人可能笑了，这有什么难的，在DoRelease这个Action的开始和结束处各加入相应日志功能不久结了。异常处理更不在话下，直接try...catch搞定。
没错，以上方法确实行得通，但是存在以下两点问题:
1.代码重复问题。很多日志处理代码和异常处理代码是很相似的，这样就导致了各个Action中存在大量重复代码。
2.职责被破坏。不要忘了，我们的Controller仅仅是控制器，它应该只负责表示逻辑，而不应该被一大堆日志处理代码和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
9using 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
9using 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
4<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml" >
7<head runat="server">
8 <title></title>
9</head>
10<body>
11 <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>复制代码
现在可以提交一则公告看结果了：
public void Release(AnnounceInfo announce)
6
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml" >
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模型进行一个比较，使朋友们看清其优势、劣势，从而更好的学习使用这个框架。
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- 第六篇：拦截器（ MVC案例教程（基于ASP.NET MVC beta））
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第六篇：拦截器
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第七篇：闲话ASP.NET MVC
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第二篇：第一个页面
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第七篇：闲话ASP.NET MVC
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第七篇：闲话ASP.NET MVC
- ASP.NET MVC案例教程（基于ASP.NET MVC beta）——第一篇：准备工作