基於AOP的MVC攔截異常讓代碼更優美

時間 2019-11-25

標籤基於 aop mvc 攔截異常代碼優美简体版

原文原文鏈接

與asp.net 打交道不少年，現在天微軟的優秀框架愈來愈多，其中微軟在基於mvc的思想架構，也推出了本身的一套asp.net mvc 框架，若是你親身體驗過它，會不由自主的說‘漂亮’。回過頭來，‘漂亮’終歸有個好的思想，其中相似於AOP的思想，就在其中體現的淋漓盡致，今天本文主要討論的是基於AOP思想構成的‘異常過濾器’。咱們的目的只有一個，讓try...catch...無處盾形，讓代碼更健壯優美。html

1、理解mvc裏filter是怎麼運行的web

老外的一篇文章是這樣的草圖windows

經過翻譯中文是這樣的架構

其中有一個異常過濾器mvc

經過上述的表格能夠清楚的看出，當Controller或Action執行時，IExceptionFiter的實現基類都將有‘能力’處理的，其中微軟在mvc中默認實現了一個實現類HandleErrorAttribute框架

看看這個的源碼是怎麼能出的asp.net

public virtual void OnException(ExceptionContext filterContext)
        {
            if (filterContext == null)
            {
                throw new ArgumentNullException("filterContext");
            }
            if (!filterContext.IsChildAction && (!filterContext.ExceptionHandled && filterContext.HttpContext.IsCustomErrorEnabled))
            {
                Exception innerException = filterContext.Exception;
                if ((new HttpException(null, innerException).GetHttpCode() == 500) && this.ExceptionType.IsInstanceOfType(innerException))
                {
                    string controllerName = (string) filterContext.RouteData.Values["controller"];
                    string actionName = (string) filterContext.RouteData.Values["action"];
                    HandleErrorInfo model = new HandleErrorInfo(filterContext.Exception, controllerName, actionName);
                    ViewResult result = new ViewResult {
                        ViewName = this.View,
                        MasterName = this.Master,
                        ViewData = new ViewDataDictionary<HandleErrorInfo>(model),
                        TempData = filterContext.Controller.TempData
                    };
                    filterContext.Result = result;
                    filterContext.ExceptionHandled = true;
                    filterContext.HttpContext.Response.Clear();
                    filterContext.HttpContext.Response.StatusCode = 500;
                    filterContext.HttpContext.Response.TrySkipIisCustomErrors = true;
                }
            }
        }

這些代碼的思路是這樣的異步

HandleErrorAttribute-->HandleErrorInfo(model)-->ViewResult-->{ViewName:Error}ide

即拋出一個Share文件夾裏的Error視圖。測試

能夠看出以Filter形式給出的，說明它有能力以特性的形式‘貼’在控制器Controller或Action上，讓代碼更爲‘優美’！由於Filter微軟也給咱們留了‘FilterConfig’入口，能夠全局性的‘注入’

至此，咱們能夠看出，有至少有兩種形式來規劃的個人‘異常’，一是以特性的形式‘貼’在Controller和Action上，二是，以全局的‘FilterConfig’註冊。無論怎麼樣，結果只有一個，try...catch...離咱們漸漸遠去了，不是嗎？那咱們繼續看下去！

異常經過以'裏'向'外'拋出去的，就像咱們經常看到的異常黃頁，那個是拋到最外面的一個異常頁面。

1.Action-->HandleErrorAttribute（默認）-->IExceptionFilter-->OnException

2.Controller-->HandleErrorAttribute（默認）-->IExceptionFilter-->OnException

2、自定義咱們的異常類

在自定義咱們的異常輔助類前，咱們首先明確的幾點：

1.全局的異經常使用CustomExceptionAttribute自定義異常類來捕獲。

2.對於Action是JsonResult的用Json格式的‘事件’用‘AsyncExceptionAttribute’異常來捕獲。

順序是：Action-->AsyncExceptionAttribute-->CustomExceptionAttribute-->HandleErrorAttribute（默認）-->IExceptionFilter-->OnException

在Action裏發生異常，若是是JsonResult，用AsyncExceptionAttribute來捕獲出去，而後進行全局的CustomExceptionAttribute

當設定 filterContext.ExceptionHandled=True時表示此異常’已被處理‘，反之異常在後續的捕獲機制中向外拋出，這個由本身的須要自由訂製。

1）AsyncExceptionAttribute定義：

若是是JsonResult異常的話，咱們進行處理組合成一個Data,狀態爲success=false,message='異常信息'。

這裏沒有作filterContext.ExceptionHandled=True處理，爲了讓異常向’外拋‘CustomExceptionAttribute 處理，由於咱們要記錄這個異常日誌，而不是僅僅的顯示給UI界面。

2）CustomExceptionAttribute全局異常：

 public override void OnException(ExceptionContext filterContext)
        {

            int StatusCode = filterContext.HttpContext.Response.StatusCode;

            if (filterContext.Exception != null && StatusCode != 404)
            {

                //寫入日誌 記錄
                string message = string.Format("------------------------------------------------------------------------------------------------------------------------------------------------------------\r\n下面是捕獲的異常信息摘要：\r\n 時間：{0}\r\n消息類型：{1}\r\n 消息內容：{2}\r\n 引起異常的方法：{3}\r\n 引起異常源：{4}"
                     , DateTime.Now
                     , filterContext.Exception.GetType().Name
                     , filterContext.Exception.Message
                     , filterContext.Exception.TargetSite
                     , filterContext.Exception.Source + filterContext.Exception.StackTrace
                     );

                DbEntityValidationException e = filterContext.Exception as DbEntityValidationException;

                if (e != null && e.EntityValidationErrors.Count() > 0)
                {
                    System.Text.StringBuilder tempDate = new StringBuilder("\r\n下面是捕獲的驗證類詳細信息:\r\n");

                    foreach (var eve in e.EntityValidationErrors)
                    {
                        tempDate.AppendLine(string.Format("Entity of type \"{0}\" in state \"{1}\" has the following validation errors:",
           eve.Entry.GetType().Name, eve.Entry.State));

                        foreach (var ve in eve.ValidationErrors)
                        {
                            tempDate.AppendLine(string.Format("- Property: \"{0}\", Error: \"{1}\"",
                                ve.PropertyName, ve.ErrorMessage));
                        }
                    }

                    message += tempDate.Append("\r\n").ToString();
                }

                Task t = new Task(() =>
                {
                    WL.Common.SysLogHelp.WriteLogFile("ErrorLog", message, filterContext.HttpContext);
                });

                t.Start();
                //t.Wait();
            }

            if (filterContext.Result is JsonResult)
                filterContext.ExceptionHandled = true;
            else
                base.OnException(filterContext);

        }

CustomExceptionAttribute全局異常定交方法，首先排除不是404的異常，由於，404多是死鏈，網站不該該處理，交給IIS級的異常程程序處理。

IIS配置管理員（windows 2012）

IIS 配置管理器裏有兩個’錯誤‘處理機制，在.NET配選項裏配置404頁，有個一潛在的問題StatusCode=304而不是404,微軟也有相關的說明，而在IIS錯誤頁裏配置的話沒有問題！

//在此節裏配置不會獲得正確的404 StateCode
</customErrors>

提倡的應該在 HttpErrors節點配置

<httpErrors errorMode="Custom" existingResponse="Replace">
<clear/>
<error statusCode="404" path="ErrorPages\404.html"/>
<error statusCode="500" path="ErrorPages\500.html"/>
</httpErrors>

再看看打印出的404頁面狀態碼

此次就正確了，因此404頁要交給IIS處理，咱們上述代碼沒有處理404頁，若是處理的話，那麼可能得不到StatusCode=404的狀態碼，表面上UI沒有任何問題，但對於SEO而言，死鏈得不到及時處理。

話題轉回來，繼續咱們的文章。

同時上面的代碼對於filterContext.Result is JsonResult 設置filterContext.ExceptionHandled = true，而對於其它的異常base.OnException(filterContext)，繼續向外面處理，防止有其它異常不能及時處理。咱們用了Task任務異步來寫入日誌，寫日誌畢竟也是浪費時間的嘛。

如今咱們測試下，這兩種異常吧，看看代碼是否是’優美‘了許多

前臺Test Code:

後臺Test Code:

測試結果：

UI層捕獲顯示

Log txt Exception:

再看看，其它的測試方式？

正常test:

修改下前臺code,後臺代碼不變,進行異常test:

全局捕獲的異常日誌：

對比之前的try...catch...話，明顯前者漂亮了許多。

小結：在傳統的web form 框架裏對於集成AOP思想，是一個較操心的事情，微軟也看到了這點，新的mvc框架確實比之前改進了不少，爲咱們對於代碼的精化及設計思路上更進了一步，諸如異常捕獲，權限驗證等也能很好的體現出來。若是你仍是之前的程序猿，如今也算體會到了設計師的暢快感，不是嗎？