定义配置信息
从上面已经可以知道我们要做的事了,针对不同的异常,我们希望可以配置它的处理程序,错误页等。如下一个配置:
其中,add 节点用于增加具体的异常,它的 exception 属性是必须的,而view表示错误页,handler表示具体处理程序,如果view和handler都没有,异常将交给默认的HandleErrorAttribute处理。而group节点用于分组,例如上面的UserNameEmptyException和EmailEmptyException对应同一个处理程序和视图。
程序会反射读取这个配置信息,并创建相应的对象。我们把这个配置文件放到Web.config中,保证它可以随时改随时生效。
2.2 异常信息包装对象
这里我们定义一个实体对象,对应上面的节点。如下:
public class ExceptionConfig
{
///
/// 视图
///
public string View{get;set;}
///
/// 异常对象
///
public Exception Exception{get;set;}
///
/// 异常处理程序
///
public IExceptionHandler Handler{get;set;}
}2.3 定义Handler接口
上面我们说到,不同异常可能需要不同处理方式。这里我们设计一个接口如下:
public interface IExceptionHandler
{
///
/// 异常是否处理完成
///
bool HasHandled{get;set;}
///
/// 处理异常
///
///
void Handle(Exception ex);
}各种异常处理程序只要实现该接口即可。
2.3 实现IExceptionFilter
这是必须的。如下,实现IExceptionFilter接口,SettingExceptionProvider会根据异常对象类型从配置信息(缓存)获取包装对象。
public class SettingHandleErrorFilter : IExceptionFilter
{
public void OnException(ExceptionContext filterContext)
{
if(filterContext == null)
{
throw new ArgumentNullException("filterContext");
}
ExceptionConfig config = 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的视图
ViewResult view = new ViewResult();
view.ViewName = config.View;
filterContext.Result = view;
filterContext.ExceptionHandled = true;
return;
}
//否则将异常继续传递
}
}2.4 读取配置文件,创建异常信息包装对象
这部分代码比较多,事实上,你只要知道它是在读取web.config的自定义配置节点即可。SettingExceptionProvider用于提供容器对象。
public class SettingExceptionProvider
{
public static Dictionary Container =
new Dictionary();
static SettingExceptionProvider()
{
InitContainer();
}
//读取配置信息,初始化容器
private static void InitContainer()
{
var section = WebConfigurationManager.GetSection("settingException") as SettingExceptionSection;
if(section == null)
{
return;
}
InitFromGroups(section.Exceptions.Groups);
InitFromAddCollection(section.Exceptions.AddCollection);
}
private static void InitFromGroups(GroupCollection groups)
{
foreach (var group in groups.Cast())
{
ExceptionConfig config = new ExceptionConfig();
config.View = group.View;
config.Handler = CreateHandler(group.Handler);
foreach(var item in group.AddCollection.Cast())
{
Exception ex = CreateException(item.Exception);
config.Exception = ex;
Container[ex.GetType()] = config;
}
}
}
private static void InitFromAddCollection(AddCollection collection)
{
foreach(var item in collection.Cast())
{
ExceptionConfig config = new ExceptionConfig();
config.View = item.View;
config.Handler = CreateHandler(item.Handler);
config.Exception = CreateException(item.Exception);
Container[config.Exception.GetType()] = config;
}
}
//根据完全限定名创建IExceptionHandler对象
private static IExceptionHandler CreateHandler(string fullName)
{
if(string.IsNullOrEmpty(fullName))
{
return null;
}
Type type = Type.GetType(fullName);
return Activator.CreateInstance(type) as IExceptionHandler;
}
//根据完全限定名创建Exception对象
private static Exception CreateException(string fullName)
{
if(string.IsNullOrEmpty(fullName))
{
return null;
}
Type type = Type.GetType(fullName);
return Activator.CreateInstance(type) as Exception;
}
} 以下是各个配置节点的信息:
settingExceptions节点:
////// settingExceptions节点 /// public class SettingExceptionSection : ConfigurationSection { [ConfigurationProperty("exceptions",IsRequired=true)] public ExceptionsElement Exceptions { get { return (ExceptionsElement)base["exceptions"]; } } }
exceptions节点:
////// exceptions节点 /// public class ExceptionsElement : ConfigurationElement { private static readonly ConfigurationProperty _addProperty = new ConfigurationProperty("", typeof(AddCollection), null, ConfigurationPropertyOptions.IsDefaultCollection); [ConfigurationProperty("", IsDefaultCollection = true)] public AddCollection AddCollection { get { return (AddCollection)base[_addProperty]; } } [ConfigurationProperty("groups")] public GroupCollection Groups { get { return (GroupCollection)base["groups"]; } } }
Group节点集:
////// group节点集 /// [ConfigurationCollection(typeof(GroupElement),AddItemName="group")] public class GroupCollection : ConfigurationElementCollection { /*override*/ protected override ConfigurationElement CreateNewElement() { return new GroupElement(); } protected override object GetElementKey(ConfigurationElement element) { return element; } }
group节点:
////// group节点 /// public class GroupElement : ConfigurationElement { private static readonly ConfigurationProperty _addProperty = new ConfigurationProperty("", typeof(AddCollection), null, ConfigurationPropertyOptions.IsDefaultCollection); [ConfigurationProperty("view")] public string View { get { return base["view"].ToString(); } } [ConfigurationProperty("handler")] public string Handler { get { return base["handler"].ToString(); } } [ConfigurationProperty("", IsDefaultCollection = true)] public AddCollection AddCollection { get { return (AddCollection)base[_addProperty]; } } }
add节点集:
////// add节点集 /// public class AddCollection : ConfigurationElementCollection { /*override*/ protected override ConfigurationElement CreateNewElement() { return new AddElement(); } protected override object GetElementKey(ConfigurationElement element) { return element; } }
add节点:
////// add节点 /// public class AddElement : ConfigurationElement { [ConfigurationProperty("view")] public string View { get { return base["view"] as string; } } [ConfigurationProperty("handler")] public string Handler { get { return base["handler"] as string; } } [ConfigurationProperty("exception", IsRequired = true)] public string Exception { get { return base["exception"] as string; } } }
三、测试
ok,下面测试一下,首先要在FilterConfig的RegisterGlobalFilters方法中在,HandlerErrorAttribute前注册我们的过滤器:
filters.Add(new SettingHandleErrorFilter())。
3.1 准备异常对象
准备几个简单的异常对象:
public class PasswordErrorException : Exception{}
public class UserNameEmptyException : Exception{}
public class EmailEmptyException : Exception{}3.2 准备Handler
针对上面的异常,我们准备两个Handler,一个处理密码错误异常,一个处理空异常。这里没有实际处理代码,具体怎么处理,应该结合具体业务了。如:
public class PasswordErrorExceptionHandler : IExceptionHandler
{
public bool HasHandled{get;set;}
public void Handle(Exception ex)
{
//具体处理逻辑...
}
}
public class EmptyExceptionHandler : IExceptionHandler
{
public bool HasHandled { get; set; }
public void Handle(Exception ex)
{
//具体处理逻辑...
}
}3.3 抛出异常
按照上面的配置,我们在Action中手动throw异常
public ActionResult Index()
{
throw new PasswordErrorException();
}
public ActionResult Index2()
{
throw new UserNameEmptyException();
}
public ActionResult Index3()
{
throw new EmailEmptyException();
}