ASP.NET MVC集成EntLib实现“自动化”异常处理[实现篇]

通过《实例篇》的实演示可以看出我们通过扩展实现的自动异常处理机制能够利用EntLib的EHAB根据执行的一场处理策略对某个Action方法执行过程中抛出的异常进行处理。对于处理后的结果，则按照如下的机制对请求进行响应。[源代码从这里下载][本文已经同步到《How ASP.NET MVC Works?》中]

• 对于Ajax请求，直接创建一个用于封装被处理后异常的数据对象，并据此创建一个JsonResult将异常信息回复给客户端。
• 对于非Ajax请求，如果当前Action方法上应用HandleErrorActionAttribute特性设置了匹配的Action方法用于处理该方法抛出的异常，那么执行该方法并用返回的ActionResult对象响应当前请求。
• 如果HandleErrorActionAttribute特性不曾应用在当前Action方法上，或者通过该特性指定的Action不存在，则将默认的错误View呈现出来作为多请求的响应。

目录
一、ExceptionPolicyAttribute & HandleErrorActionAttribute
二、实现在OnException方法中的异常处理逻辑
三、将处理后的错误消息存放在HttpContext的Items中
四、用于设置错误消息的ErrorMessageHandler

一、ExceptionPolicyAttribute & HandleErrorActionAttribute

所有的这些都是通过一个自定义的ExceptionFilter来实现的。不过我们并没有定义任何的ExceptionFilter特性，而是将异常处理实现在一个自定义的ExtendedController基类中，对异常的自动处理实现在重写的OnException方法中，不过在介绍该方法的逻辑之前我们先来看看定义在ExtendedController中的其他辅助成员。

public class ExtendedController: Controller
{
    private static Dictionary<Type, ControllerDescriptor> controllerDescriptors = new Dictionary<Type, ControllerDescriptor>();
    private static object syncHelper = new object();

    protected override void OnException(ExceptionContext filterContext)
    {
        //省略成员
    }

    //描述当前Controller的ControllerDescriptor
    public ControllerDescriptor Descriptor
    {
        get
        {
            ControllerDescriptor descriptor;
            if(controllerDescriptors.TryGetValue(this.GetType(), out descriptor))
            {
                return descriptor;
            }
            lock (syncHelper)
            {
                if (controllerDescriptors.TryGetValue(this.GetType(), out descriptor))
                {
                    return descriptor;
                }
                else
                {
                    descriptor = new ReflectedControllerDescriptor(this.GetType());
                    controllerDescriptors.Add(this.GetType(), descriptor);
                    return descriptor;
                }
            }
        }
    }
    //获取异常处理策略名称
    public string GetExceptionPolicyName()
    {
        string actionName = ControllerContext.RouteData.GetRequiredString("action");
        ActionDescriptor actionDescriptor = this.Descriptor.FindAction(ControllerContext, actionName);
        if (null == actionDescriptor)
        {
            return string.Empty;
        }
        ExceptionPolicyAttribute exceptionPolicyAttribute = actionDescriptor.GetCustomAttributes(true).OfType<ExceptionPolicyAttribute>().FirstOrDefault()??
           Descriptor.GetCustomAttributes(true).OfType<ExceptionPolicyAttribute>().FirstOrDefault()?? new ExceptionPolicyAttribute("");
        return exceptionPolicyAttribute.ExceptionPolicyName;
    }

    //获取Handle-Error-Action名称
    public string GetHandleErrorActionName()
    {
        string actionName = ControllerContext.RouteData.GetRequiredString("action");
        ActionDescriptor actionDescriptor = this.Descriptor.FindAction(ControllerContext, actionName);
        if (null == actionDescriptor)
        {
            return string.Empty;
        }
        HandleErrorActionAttribute handleErrorActionAttribute = actionDescriptor.GetCustomAttributes(true).OfType<HandleErrorActionAttribute>().FirstOrDefault()??
            Descriptor.GetCustomAttributes(true).OfType<HandleErrorActionAttribute>().FirstOrDefault()?? new HandleErrorActionAttribute("");
        return handleErrorActionAttribute.HandleErrorAction;
    }

    //用于执行Handle-Error-Action的ActionInvoker
    public HandleErrorActionInvoker HandleErrorActionInvoker { get; private set; }

    public ExtendedController()
    {
        this.HandleErrorActionInvoker = new HandleErrorActionInvoker();
    }
}

ExtendedController的Descriptor属性用于返回描述自身的ControllerDescriptor对象，实际上是一个ReflectedControllerDescriptor对象。为了避免频繁的反射操作造成对性能的影响，我们将基于某个类型解析出来的ReflectedControllerDescriptor对象进行了全局性缓存。

GetExceptionPolicyName方法用于返回当前采用的异常处理策略名称。异常处理策略名称是通过具有如下定义的ExceptionPolicyAttribute特性来指定的。该特性既可以应用在Controller类型上，也可以应用在Action方法上，换句话说，我们可以采用不同的策略来处理从不同Action执行过程中抛出的异常。GetExceptionPolicyName利用ControllerDesctior和ActionDescriptor可以很容易地得到应用的ExceptionPolicyAttribute特性，进而得到相应的异常处理策略名称。

[AttributeUsage( AttributeTargets.Class| AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public class ExceptionPolicyAttribute: Attribute
{
    public string ExceptionPolicyName { get; private set; }
    public ExceptionPolicyAttribute(string exceptionPolicyName)
    {
        this.ExceptionPolicyName = exceptionPolicyName;
    }
}

另一个方法GetHandleErrorActionName用于获取通过应用在Action方法上的特性HandleErrorActionAttribute设置的Handle-Error-Action的名称。该特性定义如下，它既可以应用于某个Action方法，也可以应用于Controller类。GetHandleErrorActionName方法同样利用ControllerDesctior和ActionDescriptor得到应用的ExceptionPolicyAttribute特性，并最终得到对应的异常处理Action名称。

[AttributeUsage( AttributeTargets.Class| AttributeTargets.Method, AllowMultiple = false)]
public class HandleErrorActionAttribute: Attribute
{
    public string HandleErrorAction { get; private set; }
    public HandleErrorActionAttribute(string handleErrorAction = "")
    {
        this.HandleErrorAction = handleErrorAction;
    }
}

通过HandleErrorActionAttribute特性设置的Handle-Error-Action需要手工执行以实现对当前请求的响应，为此我们创建了一个具有如下定义的HandleErrorActionInvoker。它是ControllerActionInvoker的子类，Handle-Error-Action需要手工执行以实现对当前请求的响应的执行通过虚方法InvokeActionMethod来完成。ExtendedController的HandleErrorActionInvoker返回的就是这样一个对象。

public class HandleErrorActionInvoker: ControllerActionInvoker
{
    public virtual ActionResult InvokeActionMethod(ControllerContext controllerContext, ActionDescriptor actionDescriptor)
    {
        IDictionary<string, object> parameterValues = this.GetParameterValues(controllerContext, actionDescriptor);
        return base.InvokeActionMethod(controllerContext, actionDescriptor, parameterValues);
    }
}

二、实现在OnException方法中的异常处理逻辑

整个异常处理和最终对请求的相应实现在如下所示的OnException方法中，流程并不复杂，在这里就不一一赘述了。不过对于整个处理流程，有两个点值得一提：其一，在调用EntLib的EHAB对异常处理过程中，允许相应的ExceptionHandler设置一个友好的错误消息，而这个消息被保存在当前HttpContext的Items中。其二，在调用异常处理方法之前，我们错误消息添加到当前的ModelState中，这也是为什么在上面的实例演示中错误消息会自动出现在ValidationSummary中的根本原因。

public class ExtendedController: Controller
{
    //其他成员
    protected override void OnException(ExceptionContext filterContext)
    {
        //或者当前的ExceptionPolicy，如果不存在，则直接调用基类OnException方法
        string exceptionPolicyName = this.GetExceptionPolicyName();
        if (string.IsNullOrEmpty(exceptionPolicyName))
        {
            base.OnException(filterContext);
            return;
        }

        //利用EntLib的EHAB进行异常处理，并获取错误消息和最后抛出的异常
        filterContext.ExceptionHandled = true;
        Exception exceptionToThrow;
        string errorMessage;
        try
        {
            ExceptionPolicy.HandleException(filterContext.Exception,exceptionPolicyName, out exceptionToThrow);
            errorMessage = System.Web.HttpContext.Current.GetErrorMessage();
        }
        finally
        {
            System.Web.HttpContext.Current.ClearErrorMessage();
        }
        exceptionToThrow = exceptionToThrow ?? filterContext.Exception;

        //对于Ajax请求，直接返回一个用于封装异常的JsonResult
        if (Request.IsAjaxRequest())
        {
            filterContext.Result = Json(new ExceptionDetail(exceptionToThrow, errorMessage));
            return;
        }

        //如果设置了匹配的HandleErrorAction，则调用之；
        //否则将Error View呈现出来
        string handleErrorAction = this.GetHandleErrorActionName();
        string controllerName = ControllerContext.RouteData.GetRequiredString("controller");
        string actionName = ControllerContext.RouteData.GetRequiredString("action");
        errorMessage = string.IsNullOrEmpty(errorMessage) ? exceptionToThrow.Message : errorMessage;
        if (string.IsNullOrEmpty(handleErrorAction))
        {
            filterContext.Result = View("Error", new ExtendedHandleErrorInfo(exceptionToThrow, controllerName, actionName, errorMessage));
        }
        else
        {
            ActionDescriptor actionDescriptor = Descriptor.FindAction(ControllerContext, handleErrorAction);
            ModelState.AddModelError("", errorMessage);
            filterContext.Result = this.HandleErrorActionInvoker.InvokeActionMethod(ControllerContext, actionDescriptor);
        }
    }
}

三、将处理后的错误消息存放在HttpContext的Items中

在调用EntLib的EHAB进行异常处理之后从当前HttpContext提取错误消息，以及最后清除消息分别是通过HttpContext的扩展方法GetErrorMessage和ClearErrorMessage实现的。如下面的代码片断所示，除了这两个扩展方法我们还定义了另一个用于设置错误消息的SetErrorMessage方法。

public static class HttpContextExtensions
{
    public static string keyOfErrorMessage = Guid.NewGuid().ToString();

    public static void SetErrorMessage(this HttpContext context, string errorMessage)
    {
        context.Items[keyOfErrorMessage]=errorMessage;
    }

    public static string GetErrorMessage(this HttpContext context)
    {
        return context.Items[keyOfErrorMessage] as string;
    }

    public static void ClearErrorMessage(this HttpContext context)
    {
        if (context.Items.Contains(keyOfErrorMessage))
        {
            context.Items.Remove(keyOfErrorMessage);
        }
    }
}

四、用于设置错误消息的ErrorMessageHandler

用于设置错误信息的ErrorMessageHandler以及对应配置元素类型ErrorMessageHandlerData定义如下。ErrorMessageHandler表示错误消息的ErrorMessage属性在构造函数中被初始化，而在实现的HandleException方法中直接通过调用当前HttpContext的扩展方法SetErrorMessage进行错误消息的设置。

[ConfigurationElementType(typeof(ErrorMessageHandlerData))]
public class ErrorMessageHandler: IExceptionHandler
{
    public string ErrorMessage { get; private set; }
    public ErrorMessageHandler(string errorMessage)
    {
        this.ErrorMessage = errorMessage;
    }
    public Exception HandleException(Exception exception, Guid handlingInstanceId)
    {
        if (null != HttpContext.Current)
        {
            HttpContext.Current.SetErrorMessage(this.ErrorMessage);
        }
        return exception;
    }
}

public class ErrorMessageHandlerData : ExceptionHandlerData
{
    [ConfigurationProperty("errorMessage", IsRequired=true)]
    public string ErrorMessage
    {
        get { return (string)this["errorMessage"]; }
        set { this["errorMessage"] = value; }
    }

    public override IEnumerable<TypeRegistration> GetRegistrations(string namePrefix)
    {
        yield return new TypeRegistration<IExceptionHandler>(() => new ErrorMessageHandler(this.ErrorMessage))
        {
            Name = this.BuildName(namePrefix),
            Lifetime = TypeRegistrationLifetime.Transient
        };
    }
}

 

ASP.NET MVC集成EntLib实现“自动化”异常处理[实例篇]
ASP.NET MVC集成EntLib实现“自动化”异常处理[实现篇]