ASP.NET MVC自定義過濾屬性實現log功能
51CTO向您推薦《ASP.NET MVC框架視頻教程》,希望通過本教程能讓大家更好的理解ASP.NET MVC。
現在的企業級開發項目,特別是網站一般都會用到log功能,想想大部分會用Enterprise Logging Application Block 的功能 或者自己寫一個組件,記錄系統日志事件,更好的跟蹤了解系統運行情況, 現用ASP.NET MVC 的過濾屬性實現log功能!
ASP.NET MVC的filter 是一個屬性,可以應用到controller 后者action.當Controller或者action method 被調用時,ASP.NET MVC的filter在調用執行前后會被觸發。 先看下當Control 里面的action 被調用時的利用繼承,自定義類log的效果圖:
要實現上面的效果,現自定義一個類LogMessageAttribute,LogMessageAttribute繼承接口IActionFilter ,IResultFilter,也可以選擇性的繼承重寫類FilterAttribute。
IActionFilter interface 定義為:
- public interface IActionFilter
- {
- // Methods
- void OnActionExecuted(ActionExecutedContext filterContext);
- void OnActionExecuting(ActionExecutingContext filterContext);
- }
OnActionExecuting :在Controller 里面的action method 調用之前運行
OnActionExecuted:在Controller 里面的action method 調用之后運行,但是在IResultFilter接口的OnResultExecuting方法執行之前
IResultFilter interface定義為:
- public interface IResultFilter
- {
- // Methods
- void OnResultExecuted(ResultExecutedContext filterContext);
- void OnResultExecuting(ResultExecutingContext filterContext);
- }
OnResultExecuting:在Controller 里面的action method調用處理玩前執行.
OnResultExecuted:在Controller 里面的action method調用處理玩后執行.
接下來是重頭戲:LogMessageAttribute自定義類
- [AttributeUsage(AttributeTargets.Class |AttributeTargets.Method ,Inherited=true ,AllowMultiple=true )]
- public class LogMessageAttribute:FilterAttribute,IActionFilter,IResultFilter
- {
- /// <summary>
- /// <param name="LogName ">日志文件路徑</para>
- /// </summary>
- public string LogName { get; set; }
- /// <summary>
- /// 記錄時間,系統版本,當前線程ID 等記錄
- /// </summary>
- /// <param name="controller"></param>
- /// <param name="action"></param>
- /// <param name="message"></param>
- public void LogMessage(string controller, string action, string message)
- {
- if (!string.IsNullOrEmpty(LogName))
- {
- TextWriter writer = new StreamWriter(LogName, true);
- writer.WriteLine("################# Begin #################");
- writer.WriteLine("Time:[{0}]",DateTime.Now.ToString("yyyy-MM-dd- hh:mm:ss"));
- writer.WriteLine("Controller:{0}",controller);
- writer.WriteLine("Action:{0}",action);
- writer.WriteLine("Message:{0}",message);
- writer.WriteLine("Operating System version is:{0}",System.Environment.OSVersion.Version.ToString());
- writer.WriteLine("Current Thread ID is:{0}",AppDomain.GetCurrentThreadId());
- writer.WriteLine("############### Over ###############");
- writer.Close();
- }
- }
- public void OnActionExecuting(ActionExecutingContext filterContext)
- {
- LogMessage(filterContext.RouteData.Values["controller"].ToString(),
- filterContext.RouteData.Values["action"].ToString(),
- "Action exeuting...");
- }
- public void OnActionExecuted(ActionExecutedContext filterContext)
- {
- LogMessage(filterContext.RouteData.Values["controller"].ToString(),
- filterContext.RouteData.Values["action"].ToString(),
- "Action executed.");
- }
- public void OnResultExecuting(ResultExecutingContext filterContext)
- {
- LogMessage(filterContext.RouteData.Values["controller"].ToString(),
- filterContext.RouteData.Values["action"].ToString(),
- "Result executing...");
- }
- public void OnResultExecuted(ResultExecutedContext filterContext)
- {
- LogMessage(filterContext.RouteData.Values["controller"].ToString(),
- filterContext.RouteData.Values["action"].ToString(),
- "Result executed");
- }
- }
自定義好LogMessageAttribute類,應用到Controller或者action的屬性。在Controller 正在執行,或者呈現一個View,一個HTTP請求數據時,就會在日志文件記錄一些日志.
在項目的Controller里面應用自定義的屬性
- [Logging(LogName = @"D:\Project\Project\MVCProject\sky.ExtendMVCFramework\sky.ExtendMVCFramework\Log.log")]
- public ActionResult DesplayEmployee()
- {
- ViewData["Message"] = "Our employees welcome you to our site!";
- List<Employee> employees = new List<Employee>
- {
- new Employee {
- FirstName="sky",
- LastName="yang",
- Email = "weflytotti@163.com",
- Department ="Development"
- },
- new Employee {
- FirstName="sky",
- LastName="yang",
- Email = "weflytotti@163.com",
- Department ="Development"
- }
- };
- return View(employees);
- }
運行程序,正如文章開始所看到的截圖!
總結:自定義ASP.NET MVC 的過濾屬性實現自己想要的功能只需要繼承IActionFilter ,IResultFilter。
原文標題:ASP.NET MVC 自定義過濾屬性實現Enterprise的log功能
鏈接:http://www.cnblogs.com/skyyang/archive/2010/04/30/1724580.html
【編輯推薦】