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-->
  <add exception="Exceptions.PasswordErrorException"
     view ="PasswordErrorView"
     handler="ExceptionHandlers.PasswordErrorExceptionHandler"/>
  <groups>
   <!--group可以配置一種異常的view和handler-->
   <group view="EmptyErrorView" handler="ExceptionHandlers.EmptyExceptionHandler">
    <add exception="Exceptions.UserNameEmptyException"/>
    <add exception="Exceptions.EmailEmptyException"/>
   </group>    
  </groups>
 </exceptions>
</settingException>

　　其中，add 節點用於增加具體的異常，它的 exception 屬性是必須的，而view表示錯誤頁，handler表示具體處理程序，如果view和handler都沒有，異常將交給默認的HandleErrorAttribute處理。而group節點用於分組，例如上面的UserNameEmptyException和EmailEmptyException對應同一個處理程序和視圖。

　　程序會反射讀取這個配置信息，並創建相應的對象。我們把這個配置文件放到Web.config中，保證它可以隨時改隨時生效。

2.2 異常信息包裝對象

　　這裡我們定義一個實體對象，對應上面的節點。如下：

public class ExceptionConfig
{
  /// <summary>
  /// 視圖
  /// </summary>
  public string View{get;set;}
 
  /// <summary>
  /// 異常對象
  /// </summary>
  public Exception Exception{get;set;}
 
  /// <summary>
  /// 異常處理程序
  /// </summary>
  public IExceptionHandler Handler{get;set;}
}

2.3 定義Handler接口

　　上面我們說到，不同異常可能需要不同處理方式。這裡我們設計一個接口如下：

public interface IExceptionHandler
{
  /// <summary>
  /// 異常是否處理完成
  /// </summary>
  bool HasHandled{get;set;}
 
  /// <summary>
  /// 處理異常
  /// </summary>
  /// <param name="ex"></param>
  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<Type, ExceptionConfig> Container =
    new Dictionary<Type, ExceptionConfig>();
 
  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<GroupElement>())
    { 
      ExceptionConfig config = new ExceptionConfig();
      config.View = group.View;
      config.Handler = CreateHandler(group.Handler);
      foreach(var item in group.AddCollection.Cast<AddElement>())
      {
        Exception ex = CreateException(item.Exception);
        config.Exception = ex;
        Container[ex.GetType()] = config;
      }
    }
  }
 
  private static void InitFromAddCollection(AddCollection collection)
  {
    foreach(var item in collection.Cast<AddElement>())
    {
      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節點：

/// <summary>
/// settingExceptions節點
/// </summary>
public class SettingExceptionSection : ConfigurationSection
{
  [ConfigurationProperty("exceptions",IsRequired=true)]
  public ExceptionsElement Exceptions
  {
    get
    {
      return (ExceptionsElement)base["exceptions"];
    }
  }
}

　　exceptions節點：

/// <summary>
/// exceptions節點
/// </summary>
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節點集：

/// <summary>
/// group節點集
/// </summary>
[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節點：

/// <summary>
/// group節點
/// </summary>
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節點集：

/// <summary>
/// add節點集
/// </summary>  
public class AddCollection : ConfigurationElementCollection
{     
  /*override*/
 
  protected override ConfigurationElement CreateNewElement()
  {
    return new AddElement();
  }
 
  protected override object GetElementKey(ConfigurationElement element)
  {
    return element;
  }
}

　　add節點：

/// <summary>
/// add節點
/// </summary>
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();
}

　　可以看到，相應的Handler會被執行，浏覽器也會出現我們配置的錯誤頁面。

四、總結

　　事實上這只是一個比較簡單的例子，所以我稱它為簡單的模塊，而是用框架、庫之類的詞。當然我們可以根據實際情況對它進行擴展和優化。微軟企業庫視乎也集成這樣的模塊，有興趣的朋友可以了解一下。