ASP.NET MVC异常处理模块详解
一、前言
异常处理是每个系统必不可少的一个重要部分，它可以让我们的程序在发生错误时友好地提示、记录错误信息，更重要的是不破坏正常的数据和影响系统运行。异常处理应该是一个横切点，所谓横切点就是各个部分都会使用到它，无论是分层中的哪一个层，还是具体的哪个业务逻辑模块，所关注的都是一样的。所以，横切关注点我们会统一在一个地方进行处理。无论是MVC还是WebForm都提供了这样实现，让我们可以集中处理异常。
在MVC中，在FilterConfig中，已经默认帮我们注册了一个HandleErrorAttribute，这是一个过滤器，它继承了FilterAttribute类和实现了IExceptionFilter接口。说到异常处理，马上就会联想到500错误页面、记录日志等，HandleErrorAttribute可以轻松的定制错误页，默认就是Error页面；而记录日志我们也只需要继承它，并替换它注册到GlobalFilterCollection即可。关于HandleErrorAttribute很多人都知道怎么使用了，这里就不做介绍了。
ok，开始进入主题！在MVC中处理异常，相信开始很多人都是继承HandleErrorAttribute，然后重写OnException方法，加入自己的逻辑，例如将异常信息写入日志文件等。当然，这并没有任何不妥，但良好的设计应该是场景驱动的，是动态和可配置的。例如，在场景一种，我们希望ExceptionA显示错误页面A，而在场景二中，我们希望它显示的是错误页面B，这里的场景可能是跨项目了，也可能是在同一个系统的不同模块。另外，异常也可能是分级别的，例如ExceptionA发生时，我们只需要简单的恢复状态，程序可以继续运行，ExceptionB发生时，我们希望将它记录到文件或者系统日志，而ExceptionC发生时，是个较严重的错误，我们希望程序发生邮件或者短信通知。简单地说，不同的场景有不同的需求，而我们的程序需要更好的面对变化。当然，继承HandleErrorAttribute也完全可以实现上面所说的，只不过这里我不打算去扩展它，而是重新编写一个模块，并且可以与原有的HandleErrorAttribute共同使用。
二、设计及实现
2.1定义配置信息
从上面已经可以知道我们要做的事了，针对不同的异常，我们希望可以配置它的处理程序，错误页等。如下一个配置：
<!--自定义异常配置--> <settingException> <exceptions> <!--add优先级高于group--> <addexception="Exceptions.PasswordErrorException" view="PasswordErrorView" handler="ExceptionHandlers.PasswordErrorExceptionHandler"/> <groups> <!--group可以配置一种异常的view和handler--> <groupview="EmptyErrorView"handler="ExceptionHandlers.EmptyExceptionHandler"> <addexception="Exceptions.UserNameEmptyException"/> <addexception="Exceptions.EmailEmptyException"/> </group> </groups> </exceptions> </settingException>
其中，add节点用于增加具体的异常，它的exception属性是必须的，而view表示错误页，handler表示具体处理程序，如果view和handler都没有，异常将交给默认的HandleErrorAttribute处理。而group节点用于分组，例如上面的UserNameEmptyException和EmailEmptyException对应同一个处理程序和视图。
程序会反射读取这个配置信息，并创建相应的对象。我们把这个配置文件放到Web.config中，保证它可以随时改随时生效。
2.2异常信息包装对象
这里我们定义一个实体对象，对应上面的节点。如下：
publicclassExceptionConfig
{
///<summary>
///视图
///</summary>
publicstringView{get;set;}
///<summary>
///异常对象
///</summary>
publicExceptionException{get;set;}
///<summary>
///异常处理程序
///</summary>
publicIExceptionHandlerHandler{get;set;}
}
2.3定义Handler接口
上面我们说到，不同异常可能需要不同处理方式。这里我们设计一个接口如下：
publicinterfaceIExceptionHandler
{
///<summary>
///异常是否处理完成
///</summary>
boolHasHandled{get;set;}
///<summary>
///处理异常
///</summary>
///<paramname="ex"></param>
voidHandle(Exceptionex);
}
各种异常处理程序只要实现该接口即可。
2.3实现IExceptionFilter
这是必须的。如下，实现IExceptionFilter接口，SettingExceptionProvider会根据异常对象类型从配置信息（缓存）获取包装对象。
publicclassSettingHandleErrorFilter:IExceptionFilter
{
publicvoidOnException(ExceptionContextfilterContext)
{
if(filterContext==null)
{
thrownewArgumentNullException("filterContext");
}
ExceptionConfigconfig=SettingExceptionProvider.Container[filterContext.Exception.GetType()];
if(config==null)
{
return;
}
if(config.Handler!=null)
{
//执行Handle方法
config.Handler.Handle(filterContext.Exception);
if(config.Handler.HasHandled)
{
//异常已处理，不需要后续操作
filterContext.ExceptionHandled=true;
return;
}
}
//否则，如果有定制页面，则显示
if(!string.IsNullOrEmpty(config.View))
{
//这里还可以扩展成实现IView的视图
ViewResultview=newViewResult();
view.ViewName=config.View;
filterContext.Result=view;
filterContext.ExceptionHandled=true;
return;
}
//否则将异常继续传递
}
}
2.4读取配置文件，创建异常信息包装对象
这部分代码比较多，事实上，你只要知道它是在读取web.config的自定义配置节点即可。SettingExceptionProvider用于提供容器对象。
publicclassSettingExceptionProvider
{
publicstaticDictionary<Type,ExceptionConfig>Container=
newDictionary<Type,ExceptionConfig>();
staticSettingExceptionProvider()
{
InitContainer();
}
//读取配置信息，初始化容器
privatestaticvoidInitContainer()
{
varsection=WebConfigurationManager.GetSection("settingException")asSettingExceptionSection;
if(section==null)
{
return;
}
InitFromGroups(section.Exceptions.Groups);
InitFromAddCollection(section.Exceptions.AddCollection);
}
privatestaticvoidInitFromGroups(GroupCollectiongroups)
{
foreach(vargroupingroups.Cast<GroupElement>())
{
ExceptionConfigconfig=newExceptionConfig();
config.View=group.View;
config.Handler=CreateHandler(group.Handler);
foreach(varitemingroup.AddCollection.Cast<AddElement>())
{
Exceptionex=CreateException(item.Exception);
config.Exception=ex;
Container[ex.GetType()]=config;
}
}
}
privatestaticvoidInitFromAddCollection(AddCollectioncollection)
{
foreach(varitemincollection.Cast<AddElement>())
{
ExceptionConfigconfig=newExceptionConfig();
config.View=item.View;
config.Handler=CreateHandler(item.Handler);
config.Exception=CreateException(item.Exception);
Container[config.Exception.GetType()]=config;
}
}
//根据完全限定名创建IExceptionHandler对象
privatestaticIExceptionHandlerCreateHandler(stringfullName)
{
if(string.IsNullOrEmpty(fullName))
{
returnnull;
}
Typetype=Type.GetType(fullName);
returnActivator.CreateInstance(type)asIExceptionHandler;
}
//根据完全限定名创建Exception对象
privatestaticExceptionCreateException(stringfullName)
{
if(string.IsNullOrEmpty(fullName))
{
returnnull;
}
Typetype=Type.GetType(fullName);
returnActivator.CreateInstance(type)asException;
}
}
以下是各个配置节点的信息：
settingExceptions节点：
///<summary>
///settingExceptions节点
///</summary>
publicclassSettingExceptionSection:ConfigurationSection
{
[ConfigurationProperty("exceptions",IsRequired=true)]
publicExceptionsElementExceptions
{
get
{
return(ExceptionsElement)base["exceptions"];
}
}
}
exceptions节点：
///<summary>
///exceptions节点
///</summary>
publicclassExceptionsElement:ConfigurationElement
{
privatestaticreadonlyConfigurationProperty_addProperty=
newConfigurationProperty("",typeof(AddCollection),null,ConfigurationPropertyOptions.IsDefaultCollection);
[ConfigurationProperty("",IsDefaultCollection=true)]
publicAddCollectionAddCollection
{
get
{
return(AddCollection)base[_addProperty];
}
}
[ConfigurationProperty("groups")]
publicGroupCollectionGroups
{
get
{
return(GroupCollection)base["groups"];
}
}
}
Group节点集：
///<summary>
///group节点集
///</summary>
[ConfigurationCollection(typeof(GroupElement),AddItemName="group")]
publicclassGroupCollection:ConfigurationElementCollection
{
/*override*/
protectedoverrideConfigurationElementCreateNewElement()
{
returnnewGroupElement();
}
protectedoverrideobjectGetElementKey(ConfigurationElementelement)
{
returnelement;
}
}
group节点：
///<summary>
///group节点
///</summary>
publicclassGroupElement:ConfigurationElement
{
privatestaticreadonlyConfigurationProperty_addProperty=
newConfigurationProperty("",typeof(AddCollection),null,ConfigurationPropertyOptions.IsDefaultCollection);
[ConfigurationProperty("view")]
publicstringView
{
get
{
returnbase["view"].ToString();
}
}
[ConfigurationProperty("handler")]
publicstringHandler
{
get
{
returnbase["handler"].ToString();
}
}
[ConfigurationProperty("",IsDefaultCollection=true)]
publicAddCollectionAddCollection
{
get
{
return(AddCollection)base[_addProperty];
}
}
}
add节点集：
///<summary>
///add节点集
///</summary>
publicclassAddCollection:ConfigurationElementCollection
{
/*override*/
protectedoverrideConfigurationElementCreateNewElement()
{
returnnewAddElement();
}
protectedoverrideobjectGetElementKey(ConfigurationElementelement)
{
returnelement;
}
}
add节点：
///<summary>
///add节点
///</summary>
publicclassAddElement:ConfigurationElement
{
[ConfigurationProperty("view")]
publicstringView
{
get
{
returnbase["view"]asstring;
}
}
[ConfigurationProperty("handler")]
publicstringHandler
{
get
{
returnbase["handler"]asstring;
}
}
[ConfigurationProperty("exception",IsRequired=true)]
publicstringException
{
get
{
returnbase["exception"]asstring;
}
}
}
三、测试
ok，下面测试一下，首先要在FilterConfig的RegisterGlobalFilters方法中在，HandlerErrorAttribute前注册我们的过滤器：
filters.Add(newSettingHandleErrorFilter())。
3.1准备异常对象
准备几个简单的异常对象：
publicclassPasswordErrorException:Exception{}
publicclassUserNameEmptyException:Exception{}
publicclassEmailEmptyException:Exception{}
3.2准备Handler
针对上面的异常，我们准备两个Handler，一个处理密码错误异常，一个处理空异常。这里没有实际处理代码，具体怎么处理，应该结合具体业务了。如：
publicclassPasswordErrorExceptionHandler:IExceptionHandler
{
publicboolHasHandled{get;set;}
publicvoidHandle(Exceptionex)
{
//具体处理逻辑...
}
}
publicclassEmptyExceptionHandler:IExceptionHandler
{
publicboolHasHandled{get;set;}
publicvoidHandle(Exceptionex)
{
//具体处理逻辑...
}
}
3.3抛出异常
按照上面的配置，我们在Action中手动throw异常
publicActionResultIndex()
{
thrownewPasswordErrorException();
}
publicActionResultIndex2()
{
thrownewUserNameEmptyException();
}
publicActionResultIndex3()
{
thrownewEmailEmptyException();
}
可以看到，相应的Handler会被执行，浏览器也会出现我们配置的错误页面。
四、总结
事实上这只是一个比较简单的例子，所以我称它为简单的模块，而是用框架、库之类的词。当然我们可以根据实际情况对它进行扩展和优化。微软企业库视乎也集成这样的模块，有兴趣的朋友可以了解一下。