ASP. net mvc custom filter attributes implement log Functions

BKJIA recommends ASP. net mvc Framework video tutorial to you. We hope this tutorial will help you better understand ASP. net mvc.

Currently, Enterprise-level development projects, especially websites, generally use the log function. Think about most of them, either using the Enterprise Logging Application Block function or writing a component to record system log events, better tracking and understanding of system operation, ASP is now used. net mvc filter attribute to implement the log function!

ASP. net mvc filter is an attribute that can be applied to the controller's later action. when the Controller or action method is called, ASP. net mvc filters are triggered before and after the call. First, let's take a look at the inheritance used when the action in the Control is called. The custom log class:

To achieve the above effect, you can customize a class of LogMessageAttribute, which inherits the IActionFilter and IResultFilter interfaces and can also inherit and override the class FilterAttribute.

IActionFilter interface is defined:

 
 

  
  
public interface IActionFilter  
  
  
{  
  
  
    // Methods  
  
  
    void OnActionExecuted(ActionExecutedContext filterContext);  
  
  
    void OnActionExecuting(ActionExecutingContext filterContext);  
  
  
} 
 
 

OnActionExecuting: Run before calling the action method in the Controller.

OnActionExecuted: it is run after the action method in the Controller is called, but before the OnResultExecuting method of the IResultFilter interface is executed

IResultFilter interface is defined:

 
 

  
  
public interface IResultFilter  
  
  
{  
  
  
    // Methods  
  
  
    void OnResultExecuted(ResultExecutedContext filterContext);  
  
  
    void OnResultExecuting(ResultExecutingContext filterContext);  
  
  
} 
 
 

OnResultExecuting: The action method in the Controller is called and executed before play.
OnResultExecuted: The action method in the Controller is called and processed.

Next is the main scene: LogMessageAttribute custom class

 
 

  
  
[AttributeUsage (AttributeTargets. Class | AttributeTargets. Method, Inherited = true, AllowMultiple = true)]
  
  
Public class LogMessageAttribute: FilterAttribute, IActionFilter, IResultFilter
  
  
{
  
  
/// <Summary>
  
  
/// <Param name = "LogName"> log file path </para>
  
  
/// </Summary>
  
  
Public string LogName {get; set ;}
  
  
 
  
  

  
  
 
  
  
/// <Summary>
  
  
/// Record the time, system version, current thread ID, and other records
  
  
/// </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 #################");
  
  
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 ");
  
  
}
  
  
}
 
 

Customize the LogMessageAttribute class and apply it to the attributes of Controller or action. When the Controller is executing or a View is displayed and an HTTP request data is sent, some logs are recorded in the log file.

Apply custom attributes to the project 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);  
  
  
     }  
 
 

Run the program, as you can see at the beginning of the article!

Conclusion: To customize ASP. net mvc filter attributes, you only need to inherit IActionFilter and IResultFilter to implement the desired functions.

Original article title: ASP. net mvc custom filter attribute for Enterprise log function

Link: http://www.cnblogs.com/skyyang/archive/2010/04/30/1724580.html