在上一篇文章中講解了自定義異常過濾器,這篇文章會結合工做中的真實案例講解一下如何使用自定義異常過濾器。瀏覽器
本案例要實現的功能需求:在發生異常時記錄日誌,日誌內容包括髮生異常的Controller名稱、Action名稱、使用瀏覽器類型和版本等。cookie
首先建立項目中須要使用的工具類。網絡
在案例中使用Log4net來記錄日誌。首先要添加對Log4net的引用,直接在NuGet裏面搜索Log4net,而後安裝便可。app
日誌消息實體類代碼以下:dom
using System; using System.Collections.Generic; using System.Linq; using System.Web; namespace MVCCuetomerExcepFilterDemo.Models { /// <summary> /// 日誌消息實體類 /// </summary> public class LogMessageEntity { /// <summary> /// 操做時間 /// </summary> public DateTime OperationTime { get; set; } /// <summary> /// Url地址 /// </summary> public string Url { get; set; } /// <summary> /// 類名 /// </summary> public string Class { get; set; } /// <summary> /// IP /// </summary> public string Ip { get; set; } /// <summary> /// 主機 /// </summary> public string Host { get; set; } /// <summary> /// 瀏覽器 /// </summary> public string Browser { get; set; } /// <summary> /// 操做人 /// </summary> public string UserName { get; set; } /// <summary> /// 內容 /// </summary> public string Content { get; set; } /// <summary> /// 異常信息 /// </summary> public string ExceptionInfo { get; set; } /// <summary> /// 異常來源 /// </summary> public string ExceptionSource { get; set; } /// <summary> /// 異常信息備註 /// </summary> public string ExceptionRemark { get; set; } } }
建立日誌級別枚舉類型,分別對應Log4net中的日誌級別,代碼以下:ide
using System; using System.Collections.Generic; using System.ComponentModel; using System.Linq; using System.Web; namespace MVCCuetomerExcepFilterDemo.Models.Enums { /// <summary> /// 日誌級別 /// </summary> public enum LogLevel { /// <summary> /// 錯誤 /// </summary> [Description("錯誤")] Error, /// <summary> /// 警告 /// </summary> [Description("警告")] Warning, /// <summary> /// 信息 /// </summary> [Description("信息")] Info, /// <summary> /// 調試 /// </summary> [Description("調試")] Debug } }
建立一個對日誌格式進行格式化的類,代碼以下:工具
using MVCCuetomerExcepFilterDemo.Models; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Web; namespace MVCCuetomerExcepFilterDemo.Util { /// <summary> /// 日誌格式器 /// </summary> public class LogFormat { /// <summary> /// 生成錯誤 /// </summary> /// <param name="logMessage">對象</param> /// <returns></returns> public string ErrorFormat(LogMessageEntity logMessage) { StringBuilder strInfo = new StringBuilder(); strInfo.Append("1. 錯誤: >> 操做時間: " + logMessage.OperationTime + " 操做人: " + logMessage.UserName + " \r\n"); strInfo.Append("2. 地址: " + logMessage.Url + " \r\n"); strInfo.Append("3. 類名: " + logMessage.Class + " \r\n"); strInfo.Append("4. Ip : " + logMessage.Ip + " 主機: " + logMessage.Host + " 瀏覽器: " + logMessage.Browser + " \r\n"); strInfo.Append("5. 內容: " + logMessage.Content + "\r\n"); strInfo.Append("-----------------------------------------------------------------------------------------------------------------------------\r\n"); return strInfo.ToString(); } /// <summary> /// 生成警告 /// </summary> /// <param name="logMessage">對象</param> /// <returns></returns> public string WarnFormat(LogMessageEntity logMessage) { StringBuilder strInfo = new StringBuilder(); strInfo.Append("1. 警告: >> 操做時間: " + logMessage.OperationTime + " 操做人: " + logMessage.UserName + " \r\n"); strInfo.Append("2. 地址: " + logMessage.Url + " \r\n"); strInfo.Append("3. 類名: " + logMessage.Class + " \r\n"); strInfo.Append("4. Ip : " + logMessage.Ip + " 主機: " + logMessage.Host + " 瀏覽器: " + logMessage.Browser + " \r\n"); strInfo.Append("5. 內容: " + logMessage.Content + "\r\n"); strInfo.Append("-----------------------------------------------------------------------------------------------------------------------------\r\n"); return strInfo.ToString(); } /// <summary> /// 生成信息 /// </summary> /// <param name="logMessage">對象</param> /// <returns></returns> public string InfoFormat(LogMessageEntity logMessage) { StringBuilder strInfo = new StringBuilder(); strInfo.Append("1. 信息: >> 操做時間: " + logMessage.OperationTime + " 操做人: " + logMessage.UserName + " \r\n"); strInfo.Append("2. 地址: " + logMessage.Url + " \r\n"); strInfo.Append("3. 類名: " + logMessage.Class + " \r\n"); strInfo.Append("4. Ip : " + logMessage.Ip + " 主機: " + logMessage.Host + " 瀏覽器: " + logMessage.Browser + " \r\n"); strInfo.Append("5. 內容: " + logMessage.Content + "\r\n"); strInfo.Append("-----------------------------------------------------------------------------------------------------------------------------\r\n"); return strInfo.ToString(); } /// <summary> /// 生成調試 /// </summary> /// <param name="logMessage">對象</param> /// <returns></returns> public string DebugFormat(LogMessageEntity logMessage) { StringBuilder strInfo = new StringBuilder(); strInfo.Append("1. 調試: >> 操做時間: " + logMessage.OperationTime + " 操做人: " + logMessage.UserName + " \r\n"); strInfo.Append("2. 地址: " + logMessage.Url + " \r\n"); strInfo.Append("3. 類名: " + logMessage.Class + " \r\n"); strInfo.Append("4. Ip : " + logMessage.Ip + " 主機: " + logMessage.Host + " 瀏覽器: " + logMessage.Browser + " \r\n"); strInfo.Append("5. 內容: " + logMessage.Content + "\r\n"); strInfo.Append("-----------------------------------------------------------------------------------------------------------------------------\r\n"); return strInfo.ToString(); } /// <summary> /// 生成異常信息 /// </summary> /// <param name="logMessage">對象</param> /// <returns></returns> public string ExceptionFormat(LogMessageEntity logMessage) { StringBuilder strInfo = new StringBuilder(); strInfo.Append("1. 調試: >> 操做時間: " + logMessage.OperationTime + " 操做人: " + logMessage.UserName + " \r\n"); strInfo.Append("2. 地址: " + logMessage.Url + " \r\n"); strInfo.Append("3. 類名: " + logMessage.Class + " \r\n"); strInfo.Append("4. 主機: " + logMessage.Host + " Ip : " + logMessage.Ip + " 瀏覽器: " + logMessage.Browser + " \r\n"); strInfo.Append("5. 異常: " + logMessage.ExceptionInfo + "\r\n"); //strInfo.Append("6. 來源: " + logMessage.ExceptionSource + "\r\n"); //strInfo.Append("7. 實例: " + logMessage.ExceptionRemark + "\r\n"); strInfo.Append("-----------------------------------------------------------------------------------------------------------------------------\r\n"); return strInfo.ToString(); } } }
建立日誌類,代碼以下:測試
using log4net; using System; using System.Collections.Generic; using System.Linq; using System.Web; namespace MVCCuetomerExcepFilterDemo.Util { /// <summary> /// 日誌 /// </summary> public class Log { private ILog logger; public Log(ILog log) { this.logger = log; } public void Debug(object message) { this.logger.Debug(message); } public void Error(object message) { this.logger.Error(message); } public void Info(object message) { this.logger.Info(message); } public void Warn(object message) { this.logger.Warn(message); } } }
建立日誌初始化類,代碼以下:ui
using log4net; using MVCCuetomerExcepFilterDemo.Models; using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Web; namespace MVCCuetomerExcepFilterDemo.Util { /// <summary> /// 日誌初始化 /// </summary> public class LogFactory { static LogFactory() { FileInfo configFile = new FileInfo(HttpContext.Current.Server.MapPath("/XmlConfig/log4net.config")); log4net.Config.XmlConfigurator.Configure(configFile); } public static Log GetLogger(Type type) { return new Log(LogManager.GetLogger(type)); } public static Log GetLogger(string str) { return new Log(LogManager.GetLogger(str)); } } }
最後添加log4net的配置文件:this
<?xml version="1.0" encoding="utf-8" ?> <configuration> <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/> </configSections> <log4net> <!--根配置--> <root> <!--日誌級別:可選值: ERROR > WARN > INFO > DEBUG --> <level value="ERROR"/> <level value="WARN"/> <level value="INFO"/> <level value="DEBUG"/> <appender-ref ref="ErrorLog" /> <appender-ref ref="WarnLog" /> <appender-ref ref="InfoLog" /> <appender-ref ref="DebugLog" /> </root> <!-- 錯誤 Error.log--> <appender name="ErrorLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,能夠是相對路徑或絕對路徑--> <param name="File" value="D:\log"/> <!--文件名,按日期生成文件夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Error.log""/> <!--追加到文件--> <appendToFile value="true"/> <!--建立日誌文件的方式,可選值:Date[日期],文件大小[Size],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個文件--> <staticLogFileName value="false"/> <!--單個文件大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的文件數,設爲"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="ERROR" /> <param name="LevelMax" value="ERROR" /> </filter> </appender> <!-- 警告 Warn.log--> <appender name="WarnLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,能夠是相對路徑或絕對路徑--> <param name="File" value="D:\log"/> <!--文件名,按日期生成文件夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Warn.log""/> <!--追加到文件--> <appendToFile value="true"/> <!--建立日誌文件的方式,可選值:Date[日期],文件大小[Size],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個文件--> <staticLogFileName value="false"/> <!--單個文件大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的文件數,設爲"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="WARN" /> <param name="LevelMax" value="WARN" /> </filter> </appender> <!-- 信息 Info.log--> <appender name="InfoLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,能夠是相對路徑或絕對路徑--> <param name="File" value="D:\log"/> <!--文件名,按日期生成文件夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Info.log""/> <!--追加到文件--> <appendToFile value="true"/> <!--建立日誌文件的方式,可選值:Date[日期],文件大小[Size],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個文件--> <staticLogFileName value="false"/> <!--單個文件大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的文件數,設爲"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="INFO" /> <param name="LevelMax" value="INFO" /> </filter> </appender> <!-- 調試 Debug.log--> <appender name="DebugLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,能夠是相對路徑或絕對路徑--> <param name="File" value="D:\log"/> <!--文件名,按日期生成文件夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Debug.log""/> <!--追加到文件--> <appendToFile value="true"/> <!--建立日誌文件的方式,可選值:Date[日期],文件大小[Size],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個文件--> <staticLogFileName value="false"/> <!--單個文件大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的文件數,設爲"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="DEBUG" /> <param name="LevelMax" value="DEBUG" /> </filter> </appender> </log4net> <startup> <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" /> </startup> </configuration>
該工具幫助類用於獲取IP、瀏覽器信息等內容,代碼以下:
using System; using System.Collections.Generic; using System.Linq; using System.Net; using System.Net.Sockets; using System.Web; namespace MVCCuetomerExcepFilterDemo.Util { /// <summary> /// 網絡操做幫助類 /// </summary> public class NetHelper { #region Ip(獲取Ip) /// <summary> /// 獲取Ip /// </summary> public static string Ip { get { var result = string.Empty; if (HttpContext.Current != null) result = GetWebClientIp(); if (string.IsNullOrWhiteSpace(result)) result = GetLanIp(); return result; } } /// <summary> /// 獲取Web客戶端的Ip /// </summary> private static string GetWebClientIp() { var ip = GetWebRemoteIp(); foreach (var hostAddress in Dns.GetHostAddresses(ip)) { if (hostAddress.AddressFamily == AddressFamily.InterNetwork) return hostAddress.ToString(); } return string.Empty; } /// <summary> /// 獲取Web遠程Ip /// </summary> private static string GetWebRemoteIp() { return HttpContext.Current.Request.ServerVariables["HTTP_X_FORWARDED_FOR"] ?? HttpContext.Current.Request.ServerVariables["REMOTE_ADDR"]; } /// <summary> /// 獲取局域網IP /// </summary> private static string GetLanIp() { foreach (var hostAddress in Dns.GetHostAddresses(Dns.GetHostName())) { if (hostAddress.AddressFamily == AddressFamily.InterNetwork) return hostAddress.ToString(); } return string.Empty; } #endregion #region Host(獲取主機名) /// <summary> /// 獲取主機名 /// </summary> public static string Host { get { return HttpContext.Current == null ? Dns.GetHostName() : GetWebClientHostName(); } } /// <summary> /// 獲取Web客戶端主機名 /// </summary> private static string GetWebClientHostName() { if (!HttpContext.Current.Request.IsLocal) return string.Empty; var ip = GetWebRemoteIp(); var result = Dns.GetHostEntry(IPAddress.Parse(ip)).HostName; if (result == "localhost.localdomain") result = Dns.GetHostName(); return result; } #endregion #region Browser(獲取瀏覽器信息) /// <summary> /// 獲取瀏覽器信息 /// </summary> public static string Browser { get { if (HttpContext.Current == null) return string.Empty; var browser = HttpContext.Current.Request.Browser; return string.Format("{0} {1}", browser.Browser, browser.Version); } } #endregion } }
上篇文章中講過了,要建立自定義異常類,只須要建立一個繼承自HandleErrorAttribute的類,並重寫OnException方法便可,自定義異常類代碼以下:
using MVCCuetomerExcepFilterDemo.Models; using MVCCuetomerExcepFilterDemo.Util; using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; namespace MVCCuetomerExcepFilterDemo.Extension { /// <summary> /// 錯誤日誌(Controller發生異常時會執行這裏) /// </summary> public class ExceptionFilters : HandleErrorAttribute { public override void OnException(ExceptionContext filterContext) { WriteLog(filterContext); base.OnException(filterContext); filterContext.ExceptionHandled = true; filterContext.HttpContext.Response.StatusCode = 200; } /// <summary> /// 寫入日誌(log4net) /// </summary> /// <param name="context">提供使用</param> private void WriteLog(ExceptionContext context) { if (context == null) return; var log = LogFactory.GetLogger(context.Controller.ToString()); Exception Error = context.Exception; LogMessageEntity logMessage = new LogMessageEntity(); logMessage.OperationTime = DateTime.Now; logMessage.Url = HttpContext.Current.Request.RawUrl; logMessage.Class = context.Controller.ToString(); logMessage.Ip = NetHelper.Ip; logMessage.Host = NetHelper.Host; logMessage.Browser = NetHelper.Browser; // 這裏爲了方便直接用默認的,真實案例中不能這樣寫 logMessage.UserName = "admin"; if (Error.InnerException == null) { logMessage.ExceptionInfo = Error.Message; } else { logMessage.ExceptionInfo = Error.InnerException.Message; } string strMessage = new LogFormat().ExceptionFormat(logMessage); log.Error(strMessage); } } }
控制器裏面有一個LogOn登陸的方法,代碼以下:
using MVCCuetomerExcepFilterDemo.Extension; using MVCCuetomerExcepFilterDemo.Models; using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; using System.Web.Security; namespace MVCCuetomerExcepFilterDemo.Controllers { public class AccountController : Controller { // GET: Account public ActionResult Index() { return View(); } /// <summary> /// 登陸成功顯示的視圖 /// </summary> /// <returns></returns> public ActionResult Welcome() { return View(); } /// <summary> /// 顯示登陸視圖 /// </summary> /// <returns></returns> public ActionResult LogOn() { LogOnViewModel model = new LogOnViewModel(); return View(model); } /// <summary> /// 處理用戶點擊登陸提交回發的表單 /// </summary> /// <param name="model"></param> /// <returns></returns> [HttpPost] [ExceptionFilters] public ActionResult LogOn(LogOnViewModel model) { try { string userName = model.UserName.Trim(); int password = Convert.ToInt32(model.Password); // 用戶名是admin,密碼是123456表示驗證經過 if (userName.Equals("admin")&&password.Equals(123456)) { // 判斷是否勾選了記住我 if (model.RememberMe) { //2880分鐘有效期的cookie FormsAuthentication.SetAuthCookie(model.UserName, true); } else { //會話cookie FormsAuthentication.SetAuthCookie(model.UserName, false); } // 跳轉到Account控制器的Welcome方法 return RedirectToAction("Welcome"); } else { return View(model); } } catch (Exception ex) { // 拋出異常 throw; } } } }
在控制器代碼中,若是輸入的用戶名是admin,密碼是123456就經過,而後顯示Welcome視圖,若是密碼轉換失敗的時候就記錄異常日誌。
首先輸入正確的用戶名和密碼:
點擊登陸,而後顯示Welcome視圖:
此次輸入錯誤的密碼:
再次點擊登陸,這時查看生成的日誌:
在上面的代碼中,咱們在LogOn()方法上面使用了ExceptionFilters這個特性,這樣在控制器發生異常的時候就會進入ExceptionFilters自定義異常類,而後記錄日誌。可是這樣有一個問題:使用這種方式要再每一個action方法上面都添加該特性,若是action方法比較多,寫起來也是很煩的,那麼有沒有什麼好的辦法呢?能夠在控制器上面添加ExceptionFilters特性,這樣就是針對整個控制器裏面的action了。那麼還有沒有更簡潔的辦法。看App_Start文件夾下面的FilterConfig定義:
using MVCCuetomerExcepFilterDemo.Extension; using System.Web; using System.Web.Mvc; namespace MVCCuetomerExcepFilterDemo { public class FilterConfig { public static void RegisterGlobalFilters(GlobalFilterCollection filters) { filters.Add(new HandleErrorAttribute()); } } }
能夠看到這裏是添加的HandleErrorAttribute類,若是換成自定義的異常類會如何呢?修改後的FilterConfig文件以下:
using MVCCuetomerExcepFilterDemo.Extension; using System.Web; using System.Web.Mvc; namespace MVCCuetomerExcepFilterDemo { public class FilterConfig { public static void RegisterGlobalFilters(GlobalFilterCollection filters) { //filters.Add(new HandleErrorAttribute()); // 使用自定義異常類 filters.Add(new ExceptionFilters()); } } }
AccountController控制器代碼修改以下:
using MVCCuetomerExcepFilterDemo.Extension; using MVCCuetomerExcepFilterDemo.Models; using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; using System.Web.Security; namespace MVCCuetomerExcepFilterDemo.Controllers { public class AccountController : Controller { // GET: Account public ActionResult Index() { return View(); } /// <summary> /// 登陸成功顯示的視圖 /// </summary> /// <returns></returns> public ActionResult Welcome() { return View(); } /// <summary> /// 顯示登陸視圖 /// </summary> /// <returns></returns> public ActionResult LogOn() { LogOnViewModel model = new LogOnViewModel(); return View(model); } /// <summary> /// 處理用戶點擊登陸提交回發的表單 /// </summary> /// <param name="model"></param> /// <returns></returns> [HttpPost] // [ExceptionFilters] public ActionResult LogOn(LogOnViewModel model) { try { string userName = model.UserName.Trim(); int password = Convert.ToInt32(model.Password); // 用戶名是admin,密碼是123456表示驗證經過 if (userName.Equals("admin")&&password.Equals(123456)) { // 判斷是否勾選了記住我 if (model.RememberMe) { //2880分鐘有效期的cookie FormsAuthentication.SetAuthCookie(model.UserName, true); } else { //會話cookie FormsAuthentication.SetAuthCookie(model.UserName, false); } // 跳轉到Account控制器的Welcome方法 return RedirectToAction("Welcome"); } else { return View(model); } } catch (Exception ex) { // 拋出異常 throw; } } } }
這樣發生異常的時候就會自動進入自定義異常類了,而後記錄日誌。