如何解决EnterLib异常处理框架最大的局限——基于异常"类型"的异常处理策略

个人觉得EnterLib的EHAB（Exception Handling Application Block）是一个不错的异常处理框架，借助于EHAB，我们可以配置的方式来自定义异常处理策略，从而带来最大的灵活性和可维护性。但是，在我看来，EHAB有一个最大的局限，把就是异常处理策略的粒度过大——只能提供基于异常类型级别。本篇文章通过一个自定义ExceptionHandler很好地解决了这个问题。

一、EnterLib基于异常类型的异常处理策略

EnterLib的异常处理策略基本上可以通过这样的的公式来表示：Exception Policy = Exception Type + Exception Handlers + Post Handling Action，它表达的意思是：“对于某种类型的异常，应该采用哪些Exception Handler去处理，而被处理后的异常还需要采用怎样的后续操作（将异常吃掉、或者是重新抛出）”。

也就是说，抛出类型的异常类型决定了最终采取的处理策略，这在大部分情况下是可以接受的。但是在很多场景中，不同情况下也可以抛出相同类型的异常，我们期望的行为是：尽管异常类型一样，我们也可以根据具体抛出的异常定义不同的异常处理策略。

一个最为典型的场景就是基于数据库的数据存取，如果你采用的SQL Server，抛出的异常永远只有一种：SqlException。如果完全按照EnterLib EHAB的做法，在任何情况下抛出的SqlException对应的处理方式都是一样的。但是抛出SqlException的情况非常多，比如Server连接断开、认证失败、数据库对象不存在、违反一致性约束等等，如果异常处理框架能够根据最终抛出的异常的具体属性，“智能”地应用相应的策略去处理，这才是我们乐于看到的。

二、一个特殊的ExceptionHandler——FilterableHandler

为了解决这个问题，我创建了一个特殊的Exception Handler，我将它起名为FilterableHandler。说它特别，是因为FilterableHandler并不从事具体的异常处理操作（比如异常封装、替换、日志等），而是为某个具体的异常类型重新定义了异常处理策略。

实际上，我在很早之前就定义了一个相似的FilterableHandler，有兴趣的话可以参考《创建一个自定义Exception Handler改变ELAB的异常处理机制》。由于在最新的EnterLib中，底层的实现机制发生了根本性的改变，这个ExceptionHandler已经不能在使用。所以我对其进行的了修正，同时根据可扩展性进行重新设计。

之所以称这个ExceptionHandler为FilterableHandler，是在于它具有对抛出的异常具有“筛选”的功能。说得具体点，FilterableHandler将抛出的异常对象，传入一组具有筛选功能的ExceptionHandler列表，我个人将这个列表命名为FiterableExceptionHandlerPipeline。FiterableExceptionHandlerPipeline对象包含一个筛选器和一组ExceptionHandler，如果传入的异常通过了筛选器的筛选，该异常最终被分发到相应的ExceptionHandler列表中进行处理。FiterableExceptionHandlerPipeline大概的定义如下：

public class FilterableHandlerPipeline
{
    public IFilter Filter { get; private set; }
    public IEnumerable<IExceptionHandler> ExceptionHandlers { get; private set; }

    public FilterableHandlerPipeline(IFilter filter, IEnumerable<IExceptionHandler> exceptionHandlers)
    {
        Guard.ArgumentNotNull(filter, "filter");
        Guard.ArgumentNotNull(exceptionHandlers, "exceptionHandlers");
        this.Filter = filter;
        this.ExceptionHandlers = exceptionHandlers;
    }
}

而IFilter接口在更为简单，仅仅具有如下一个唯一的Match方法。布尔类型的返回值表明是否和指定的异常相匹配，当返回值为True的时候，FiterableExceptionHandlerPipeline采用用自己的ExceptionHandler列表去处理抛出的异常，否则就直接忽略掉。

public interface IFilter
{
    bool Match(Exception ex);
}

你可以从下面给出的关于FilterableHandler的完整的代码去分析具体的异常处理实现原理。而实际上，最为复杂的不是FilterableHandler本身的实现，而是与之相关的配置元素的定义。由于这会涉及到很多关于EnterLib底层和Unity相关的知识点，不是三言两语就能讲明白的，所以在这里就不对FilterableHandler的配置体系作介绍了，有兴趣的话可以通过这里直接下载源代码。

[ConfigurationElementType(typeof(FilterableHandlerData))]
public class FilterableHandler:IExceptionHandler
{
    public IEnumerable<FilterableHandlerPipeline> FilterableHandlerPipelines { get; private set; }
    public IEnumerable<IExceptionHandler> DefaultHandlers { get; private set; }

    public FilterableHandler(IEnumerable<FilterableHandlerPipeline> filterableHandlerPipelines, IEnumerable<IExceptionHandler> defaultHandlers)
    {
        Guard.ArgumentNotNull(defaultHandlers, "defaultHandlers");
        filterableHandlerPipelines = filterableHandlerPipelines ?? new List<FilterableHandlerPipeline>();
        this.FilterableHandlerPipelines = filterableHandlerPipelines;
        this.DefaultHandlers = defaultHandlers;
    }
    public Exception HandleException(Exception exception, Guid handlingInstanceId)
    {
        Guard.ArgumentNotNull(exception,"exception");
        var handlerPipeline = (from pipeline in this.FilterableHandlerPipelines
                               where pipeline.Filter.Match(exception)
                               select pipeline).FirstOrDefault();
        if (null != handlerPipeline)
        {
            return ExecuteHandlerChain(exception, handlingInstanceId, handlerPipeline.ExceptionHandlers);
        }
        else
        {
            return ExecuteHandlerChain(exception, handlingInstanceId, DefaultHandlers);
        }
    }

    private static Exception ExecuteHandlerChain(Exception exception, Guid handlingInstanceId, IEnumerable<IExceptionHandler> handlers)
    {
        var lastHandlerName = String.Empty;
        try
        {
            foreach (var handler in handlers)
            {
                lastHandlerName = handler.GetType().Name;
                exception = handler.HandleException(exception, handlingInstanceId);
            }
        }
        catch (Exception ex)
        {
            var errorMsg = string.Format("Unable to handle the exception: {0}", lastHandlerName);
            throw new ExceptionHandlingException(errorMsg, ex);
        }
        return exception;
    }
}

三、通过FilterableHandler对SqlException进行针对性处理

我现在通过一个简单的例子来演示FilterableHandler如何使用（源代码从这里下载），我们使用的场景就是上面提到过的对SqlException的针对性处理。根据SqlException抛出的场景，本例将起分为三种类型：

• 系统异常：基于SQL Server自身抛出的异常，我们将异常编号，即SqlException的Number小于50000的称为系统异常；
• 业务异常：编程人员根在编写SQL脚本的时候，根据相应的业务逻辑，通过调用RAISERROR语句手工抛出的异常。在默认情况下这种异常的编号为50000；

• 其他：任何编号高于50000的异常。

注：关于RAIERROR语句以及SQL Server异常处理相关的内容，你可以参阅我下面三篇文章：

谈谈基于SQL Server的Exception Handling - PART I
谈谈基于SQL Server 的Exception Handling - PART II
谈谈基于SQL Server 的Exception Handling - PART III

为了对SqlException进行针对处理，我们对抛出的SqlException进行封装。对应于上述三种类型，我定义如如下三种异常：SqlSystemException、SqlBusinessException和DbException。

namespace Artech.ExceptionHandling.Demo
{
    [Serializable]
    public class SqlSystemException : Exception
    {
        public SqlSystemException() { }
        public SqlSystemException(string message) : base(message) { }
        public SqlSystemException(string message, Exception inner) : base(message, inner) { }
        protected SqlSystemException(
          System.Runtime.Serialization.SerializationInfo info,
          System.Runtime.Serialization.StreamingContext context)
            : base(info, context) { }
    }

    [Serializable]
    public class SqlBusinessException : Exception
    {
        public SqlBusinessException() { }
        public SqlBusinessException(string message) : base(message) { }
        public SqlBusinessException(string message, Exception inner) : base(message, inner) { }
        protected SqlBusinessException(
          System.Runtime.Serialization.SerializationInfo info,
          System.Runtime.Serialization.StreamingContext context)
            : base(info, context) { }
    }

    [Serializable]
    public class DbException : Exception
    {
        public DbException() { }
        public DbException(string message) : base(message) { }
        public DbException(string message, Exception inner) : base(message, inner) { }
        protected DbException(
          System.Runtime.Serialization.SerializationInfo info,
          System.Runtime.Serialization.StreamingContext context)
            : base(info, context) { }
    }
}

我们需要作的进行通过配置定义处理SqlException的处理策略，整个配置定义在如下的代码片断中。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
   ... ...
    <exceptionHandling>
        <exceptionPolicies>
            <add name="Policy">
                <exceptionTypes>
                    <add name="All Exceptions" type="System.Data.SqlClient.SqlException, System.Data, Version=4.0.0.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089"
                        postHandlingAction="ThrowNewException">
                        <exceptionHandlers>
                          <add name="filterHandler" type="Artech.ExceptionHandling.FilterableHandler, Artech.ExceptionHandling.Lib">
                            <default>
                              <add name="Wrap Handler" type="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.WrapHandler,
Microsoft.Practices.EnterpriseLibrary.ExceptionHandling"
                                exceptionMessage="Business Error..." wrapExceptionType="Artech.ExceptionHandling.Demo.DbException, Artech.ExceptionHandling.Demo" />
                            </default>
                            <filters>
                              <add name="businessError" type="Artech.ExceptionHandling.PropertyValueEquivalencePipeline, Artech.ExceptionHandling.Lib"
property="Number" value="50000">
                                <exceptionHandlers>
                                  <add name="Wrap Handler" type="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.WrapHandler,
Microsoft.Practices.EnterpriseLibrary.ExceptionHandling"
                               exceptionMessage="Busiess Error..." wrapExceptionType="Artech.ExceptionHandling.Demo.SqlBusinessException, Artech.ExceptionHandling.Demo" />
                                </exceptionHandlers>
                              </add>
                              <add name="systemError" type="Artech.ExceptionHandling.PropertyValueRangePipeline, Artech.ExceptionHandling.Lib" property="Number"
upperBound="50000" upperRangeBoundType="Exclusive">
                                <exceptionHandlers>
                                  <add name="Wrap Handler" type="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.WrapHandler,
Microsoft.Practices.EnterpriseLibrary.ExceptionHandling"
                               exceptionMessage="System Error..." wrapExceptionType="Artech.ExceptionHandling.Demo.SqlSystemException,
Artech.ExceptionHandling.Demo" />
                                </exceptionHandlers>
                              </add>
                            </filters>
                          </add>
                        </exceptionHandlers>
                    </add>
                </exceptionTypes>
            </add>
        </exceptionPolicies>
    </exceptionHandling>
</configuration>

虽然配置稍微复杂了一点，但是结构还算是很清楚的。我们将FilterableHandler作为处理SqlException的唯一的ExceptionHandler。而FilterableHandler整个配置包含如下两个部分<default>和<filters>。<filters>自然就是定义的一组筛选分支，而<default>则是定义了一个后备——如果抛出的异常满足所有的筛选分支，则通过定义在<default>中的ExceptionHandler列表进行才处理。

<add name="filterHandler" type="Artech.ExceptionHandling.FilterableHandler, Artech.ExceptionHandling.Lib">
  <default>
    <add name="Wrap Handler" type="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.WrapHandler, Microsoft.Practices.EnterpriseLibrary.ExceptionHandling"
      exceptionMessage="Business Error..." wrapExceptionType="Artech.ExceptionHandling.Demo.DbException, Artech.ExceptionHandling.Demo" />
  </default>
  <filters>
    <add name="businessError" type="Artech.ExceptionHandling.PropertyValueEquivalencePipeline, Artech.ExceptionHandling.Lib" property="Number" value="50000">
      <exceptionHandlers>
        <add name="Wrap Handler" type="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.WrapHandler,
Microsoft.Practices.EnterpriseLibrary.ExceptionHandling"
     exceptionMessage="Bar" wrapExceptionType="Artech.ExceptionHandling.Demo.SqlBusinessException, Artech.ExceptionHandling.Demo" />
      </exceptionHandlers>
    </add>
    <add name="systemError" type="Artech.ExceptionHandling.PropertyValueRangePipeline, Artech.ExceptionHandling.Lib"
property="Number"  upperBound="50000" upperRangeBoundType="Exclusive">
      <exceptionHandlers>
        <add name="Wrap Handler" type="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.WrapHandler,
Microsoft.Practices.EnterpriseLibrary.ExceptionHandling"
     exceptionMessage="System Error..." wrapExceptionType="Artech.ExceptionHandling.Demo.SqlSystemException, Artech.ExceptionHandling.Demo" />
      </exceptionHandlers>
    </add>
  </filters>
</add>

在<filters>中定义了两个FilterableHandlerPipeline：PropertyValueEquivalencePipeline和PropertyValueRangePipeline。PropertyValueEquivalencePipeline的筛选器根据抛出异常的某个属性的值是否等于指定的值进行筛选，而PropertyValueRangePipeline的筛选器则根据抛出异常的某个属性值是否在指定的范围内进行筛选。在这里用作筛选的属性名名称为Number，PropertyValueRangePipeline指定的上限为5000，upperRangeBoundType为“Exclusive”表示包含此上限，并且没有指定下限，所以这里的筛选逻辑就Number<50000。而PropertyValueEquivalencePipeline通过value属性设置成50000，表明它需要筛选Number=50000的异常。

<filters>下的两个筛选元素，以及<default>节点下的ExceptionHandler列表包含一个EnterLib提供的WrapHandler，对抛出的异常进行封装，在这里我们指定了不同的封装异常类型：SqlBusinessException、SqlSystemException和DbException。

我们验证上面定义的异常处理策略，看看抛出的SqlException是否按照我们的预期进行了相应的封装，我现定义了如下一个辅助方法：HandleException。

private static void HandleException(Action task)
{
    try
    {
        try
        {
            task();
        }
        catch (SqlException ex)
        {
            if (ExceptionPolicy.HandleException(ex, "Policy"))
            {
                throw;
            }
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.GetType().FullName);
    }
}

现在我们分三种情况调用这个辅助方法：

1、创建一个数据库连接，但是指定一个错误的密码，当我们开启连接的时候，系统会自动抛出一个SqlException，这个异常应该被封装成SqlSystemException；

2、通过创建一个DbCommand，执行RAISERROR语句，并指定相应的出错信息、错误严重级别（Serveriry）和状态（State），这个异常应该被封装成SqlBusinessException（Number=50000）；

3、通过创建一个DbCommand，执行RAISERROR语句，指定一个MessageId（通过调用系统存储过程sp_addmessage创建，该值会转换成SqlException的Number），这个异常应该被封装成DbException

HandleException(
        () =>
        {
            var connstring = "Server=.; Database=TestDb; Uid=sa; Pwd=invalidPwd";
            var conection = new SqlConnection(connstring);
            conection.Open();
        });

HandleException(
         () =>
         {
             var connstring = "Server=.; Database=TestDb; Uid=sa; Pwd=password";
             var conection = new SqlConnection(connstring);
             var command = conection.CreateCommand();
             command.CommandText = "RAISERROR ('The order record does not exist',16,1)";
             conection.Open();
             command.ExecuteNonQuery();
         });

HandleException(
         () =>
         {
             var connstring = "Server=.; Database=TestDb; Uid=sa; Pwd=password";
             var conection = new SqlConnection(connstring);
             var command = conection.CreateCommand();
             command.CommandText = "RAISERROR (50001,16,1)";
             conection.Open();
             command.ExecuteNonQuery();
         });

以下的输出和我们的预期完全一致：

Artech.ExceptionHandling.Demo.SqlSystemException
Artech.ExceptionHandling.Demo.SqlBusinessException
Artech.ExceptionHandling.Demo.DbException

四、FiterableHandler的可扩展性

FilterableHandler的核心在于有一组具有不同筛选器的FiterableExceptionHandlerPipeline。我默认定义了两个基于属性比较的FiterableExceptionHandlerPipeline，即PropertyValueEquivalencePipeline和PropertyValueRangePipeline。实际上你可以通过继承FiterableExceptionHandlerPipeline基类，实现你自定义的筛选方式。

作者：Artech
出处：http://artech.cnblogs.com
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。