C#实现自动化Log日志

ゝ一世哀愁。 2023-07-17 06:24 96阅读 0赞

在开发项目的时候，我们不免要使用Log记录日志，使用最多的是Log4Net和EntLib Log，在需要记录日志的代码处加入log.Write(日志信息)，假设我需要跟踪业务方法，记录方法的传递参数，执行时间，返回数据等；或者我需要查看方法的调用关系，希望进入方法的时候自动记录参数信息，出方法时记录结果和执行时间信息。这时就是一个典型的AOP运用，Java在AOP方面是很容易实现的，因为java有类加载器。但是.Net在AOP方面就不怎么容易，严格意义上.Net没有真正的AOP。这话并不代表.Net不能实现AOP，比如：PostSharp和Enterprise library就能实现。

先介绍一下PostSharp，我们知道.net代码将编译成MSIL（微软中间语言），然后CPU将MSIL的exe文件生成本地CPU的二进制文件格式，PostSharp就是在编译过程中加入IL代码，因而完成AOP功能。
缺点：编译器需要PostSharp组件，维护代码困难，因为IL代码不好识别；
优点：使用方便（PostSharp2是收费版，破解也比较方便，在此不介绍破解）

这里我重点介绍如何使用Enterprise Library实现自动化Log。
1.首先我们需要下载Enterprise Library，最新为5.0版本；
2.新建一个控制台项目，并添加以下程序集
Microsoft.Practices.EnterpriseLibrary.Common
Microsoft.Practices.EnterpriseLibrary.Logging
Microsoft.Practices.EnterpriseLibrary.PolicyInjection
Microsoft.Practices.ServiceLocation
Microsoft.Practices.Unity
Microsoft.Practices.Unity.Interception
3.添加AutoLogCallHandler类，实现ICallHandler接口
这个类是执行调用目标方法，在调用目标方法前获取方法的参数信息，并用EntLib Log记录日志；
方法结束后，再次记录日志，并统计执行时间和异常处理

[csharp] view plain copy print ?

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.Practices.Unity.InterceptionExtension;
  6. using Microsoft.Practices.EnterpriseLibrary.Logging;
  7. using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
  8. using System.Diagnostics;
  9. using System.Reflection;
  11. namespace AutoLog {
  12. public class AutoLogCallHandler:ICallHandler {
  14. private LogWriter logWriter = EnterpriseLibraryContainer.Current.GetInstance();
  16. public AutoLogCallHandler() { }
  18. public IMethodReturn Invoke(IMethodInvocation input, GetNextHandlerDelegate getNext) {
  19. StringBuilder sb = null;
  20. ParameterInfo pi = null;
  22. string methodName = input.MethodBase.Name;
  23. logWriter.Write(string.Format(“Enter method “ + methodName));
  26. if (input.Arguments != null && input.Arguments.Count > 0) {
  27. sb = new StringBuilder();
  28. for (int i = 0; i < input.Arguments.Count; i++) {
  29. pi = input.Arguments.GetParameterInfo(i);
  30. sb.Append(pi.Name).Append(“ : “).Append(input.Arguments[i]).AppendLine();
  31. }
  32. logWriter.Write(sb.ToString());
  33. }
  36. Stopwatch sw = new Stopwatch();
  37. sw.Start();
  39. IMethodReturn result = getNext()(input, getNext);
  40. //如果发生异常则，result.Exception != null
  41. if (result.Exception != null) {
  42. logWriter.Write(“Exception:” + result.Exception.Message);
  43. //必须将异常处理掉，否则无法继续执行
  44. result.Exception = null;
  45. }
  47. sw.Stop();
  48. logWriter.Write(string.Format(“Exit method {0}, use {1}.”,methodName, sw.Elapsed));
  50. return result;
  51. }
  53. public int Order { get; set; }
  54. }

  55. }

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Practices.Unity.InterceptionExtension;
    using Microsoft.Practices.EnterpriseLibrary.Logging;
    using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
    using System.Diagnostics;
    using System.Reflection;

    namespace AutoLog {

    1. public class AutoLogCallHandler:ICallHandler {
    3.     private LogWriter logWriter = EnterpriseLibraryContainer.Current.GetInstance<LogWriter>();
    5.     public AutoLogCallHandler() { }
    7.     public IMethodReturn Invoke(IMethodInvocation input, GetNextHandlerDelegate getNext) {
    8.         StringBuilder sb = null;
    9.         ParameterInfo pi = null;
    11.         string methodName = input.MethodBase.Name;
    12.         logWriter.Write(string.Format("Enter method " + methodName));
  1.             if (input.Arguments != null && input.Arguments.Count > 0) {
  2.                 sb = new StringBuilder();
  3.                 for (int i = 0; i < input.Arguments.Count; i++) {
  4.                     pi = input.Arguments.GetParameterInfo(i);
  5.                     sb.Append(pi.Name).Append(" : ").Append(input.Arguments[i]).AppendLine();
  6.                 }
  7.                 logWriter.Write(sb.ToString());
  8.             }        
  11.             Stopwatch sw = new Stopwatch();
  12.             sw.Start();
  14.             IMethodReturn result = getNext()(input, getNext);
  15.             //如果发生异常则，result.Exception != null
  16.             if (result.Exception != null) {
  17.                 logWriter.Write("Exception:" + result.Exception.Message);
  18.                 //必须将异常处理掉，否则无法继续执行
  19.                 result.Exception = null;
  20.             }
  22.             sw.Stop();
  23.             logWriter.Write(string.Format("Exit method {0}, use {1}.",methodName, sw.Elapsed));
  25.             return result;
  26.         }
  28.         public int Order { get; set; }
  29.     }
  30. }

4.要自动化日志就需要创建一个标记属性，指定方法能自动进行日志
这里就创建AutoLogCallHandlerAttribute标记属性

[csharp] view plain copy print ?

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.Practices.Unity.InterceptionExtension;
  6. using Microsoft.Practices.EnterpriseLibrary.Logging;
  7. using System.Diagnostics;
  8. using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
  10. namespace AutoLog {
  12. public class AutoLogCallHandlerAttribute:HandlerAttribute {
  14. public override ICallHandler CreateHandler(Microsoft.Practices.Unity.IUnityContainer container) {
  15. return new AutoLogCallHandler() { Order = this.Order };
  16. }
  17. }

  18. }

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Practices.Unity.InterceptionExtension;
    using Microsoft.Practices.EnterpriseLibrary.Logging;
    using System.Diagnostics;
    using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;

    namespace AutoLog {

    1. public class AutoLogCallHandlerAttribute:HandlerAttribute {
    3.     public override ICallHandler CreateHandler(Microsoft.Practices.Unity.IUnityContainer container) {
    4.         return new AutoLogCallHandler() { Order = this.Order };
    5.     }
    6. }

    }

5.创建实体类
注意：我在Work和ToString方法上方加上了AutoLogCallHandler属性，它是AutoLogCallHandlerAttribute的简写形式。用以指示这两个方法用AutoLogCallHandler的Invoke来处理。

[csharp] view plain copy print ?

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.Practices.Unity;
  7. namespace AutoLog {
  9. public class Employee : MarshalByRefObject
  10. {
  12. public Employee() {}
  14. public string Name { get; set; }
  16. [AutoLogCallHandler()]
  17. public void Work() {
  18. Console.WriteLine(“Now is {0},{1} is working hard!”,DateTime.Now.ToShortTimeString(),Name);
  19. throw new Exception(“Customer Exception”);
  20. }
  22. [AutoLogCallHandler()]
  23. public override string ToString() {
  24. return string.Format(“I’m {0}.”,Name);
  25. }
  26. }

  27. }

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Practices.Unity;

    namespace AutoLog {

    1. public class Employee : MarshalByRefObject 
    2. {
    4.     public Employee() {}
    6.     public string Name { get; set; }
    8.     [AutoLogCallHandler()]
    9.     public void Work() {
    10.         Console.WriteLine("Now is {0},{1} is working hard!",DateTime.Now.ToShortTimeString(),Name);
    11.         throw new Exception("Customer Exception");
    12.     }
    14.     [AutoLogCallHandler()]
    15.     public override string ToString() {
    16.         return string.Format("I'm {0}.",Name);
    17.     }
    18. }

    }

6.测试代码
注意：必须使用PolicyInjection.Create()来创建对象，不然无法实现。

[csharp] view plain copy print ?

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.Practices.EnterpriseLibrary.PolicyInjection;
  6. using Microsoft.Practices.Unity;
  7. using Microsoft.Practices.EnterpriseLibrary.Logging;
  8. using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
  10. namespace AutoLog {
  11. class Program {
  13. private static LogWriter logWriter = EnterpriseLibraryContainer.Current.GetInstance();
  15. static void Main(string[] args) {
  18. Employee emp = PolicyInjection.Create();
  20. emp.Name = “Lele”;
  22. emp.Work();
  23. Console.WriteLine(emp);
  24. }
  25. }

  26. }

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Practices.EnterpriseLibrary.PolicyInjection;
    using Microsoft.Practices.Unity;
    using Microsoft.Practices.EnterpriseLibrary.Logging;
    using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;

    namespace AutoLog {

    1. class Program {
    3.     private static LogWriter logWriter = EnterpriseLibraryContainer.Current.GetInstance<LogWriter>();
    5.     static void Main(string[] args) {
  1.             Employee emp = PolicyInjection.Create<Employee>();
  3.             emp.Name = "Lele";
  5.             emp.Work();
  6.             Console.WriteLine(emp);
  7.         }
  8.     }
  9. }

7.还需要用EntLib的配置工具完成Log配置，将Log信息写入Trace.log文件中

[html] view plain copy print ?

  1. <?xml version=”1.0”?>
  8. <add name=”Flat File Trace Listener” type=”Microsoft.Practices.EnterpriseLibrary.Logging.TraceListeners.FlatFileTraceListener, Microsoft.Practices.EnterpriseLibrary.Logging, Version=5.0.505.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35”
  9. listenerDataType=”Microsoft.Practices.EnterpriseLibrary.Logging.Configuration.FlatFileTraceListenerData, Microsoft.Practices.EnterpriseLibrary.Logging, Version=5.0.505.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35”
  10. fileName=”trace.log” formatter=”Text Formatter” />
  13. <add type=”Microsoft.Practices.EnterpriseLibrary.Logging.Formatters.TextFormatter, Microsoft.Practices.EnterpriseLibrary.Logging, Version=5.0.505.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35”
  14. template=”Timestamp: {timestamp}{newline}
  15. Message: {message}{newline}
  16. Category: {category}{newline}
  17. Priority: {priority}{newline}
  18. EventId: {eventid}{newline}
  19. Severity: {severity}{newline}
  20. Title:{title}{newline}
  21. Machine: {localMachine}{newline}
  22. App Domain: {localAppDomain}{newline}
  23. ProcessId: {localProcessId}{newline}
  24. Process Name: {localProcessName}{newline}
  25. Thread Name: {threadName}{newline}
  26. Win32 ThreadId:{win32ThreadId}{newline}
  27. Extended Properties: {dictionary({key} - {value}{newline})}“
  28. name=”Text Formatter” />

  50. <?xml version=”1.0”?>
































好了，测试一下，控制台输入：
Now is 14:03,Lele is working hard!
I’m Lele.
再看看Trace.log文件内容：

[plain] view plain copy print ?

  1. -———————————————————-
  2. Timestamp: 2012/3/19 6:03:00
  4. Message: Enter method Work
  6. Category: General
  8. Priority: -1
  10. EventId: 1
  12. Severity: Information
  14. Title:
  16. Machine: PC4
  18. App Domain: AutoLog.exe
  20. ProcessId: 4200
  22. Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe
  24. Thread Name:
  26. Win32 ThreadId:4000
  28. Extended Properties:
  29. -———————————————————-
  30. -———————————————————-
  31. Timestamp: 2012/3/19 6:03:00
  33. Message: Exception:Customer Exception
  35. Category: General
  37. Priority: -1
  39. EventId: 1
  41. Severity: Information
  43. Title:
  45. Machine: PC4
  47. App Domain: AutoLog.exe
  49. ProcessId: 4200
  51. Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe
  53. Thread Name:
  55. Win32 ThreadId:4000
  57. Extended Properties:
  58. -———————————————————-
  59. -———————————————————-
  60. Timestamp: 2012/3/19 6:03:00
  62. Message: Exit method Work, use 00:00:00.0024272.
  64. Category: General
  66. Priority: -1
  68. EventId: 1
  70. Severity: Information
  72. Title:
  74. Machine: PC4
  76. App Domain: AutoLog.exe
  78. ProcessId: 4200
  80. Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe
  82. Thread Name:
  84. Win32 ThreadId:4000
  86. Extended Properties:
  87. -———————————————————-
  88. -———————————————————-
  89. Timestamp: 2012/3/19 6:03:00
  91. Message: Enter method ToString
  93. Category: General
  95. Priority: -1
  97. EventId: 1
  99. Severity: Information
  101. Title:
  103. Machine: PC4
  105. App Domain: AutoLog.exe
  107. ProcessId: 4200
  109. Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe
  111. Thread Name:
  113. Win32 ThreadId:4000
  115. Extended Properties:
  116. -———————————————————-
  117. -———————————————————-
  118. Timestamp: 2012/3/19 6:03:00
  120. Message: Exit method ToString, use 00:00:00.0001410.
  122. Category: General
  124. Priority: -1
  126. EventId: 1
  128. Severity: Information
  130. Title:
  132. Machine: PC4
  134. App Domain: AutoLog.exe
  136. ProcessId: 4200
  138. Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe
  140. Thread Name:
  142. Win32 ThreadId:4000
  144. Extended Properties:

  145. -———————————————————-

    Timestamp: 2012/3/19 6:03:00

    Message: Enter method Work

    Category: General

    Priority: -1

    EventId: 1

    Severity: Information

    Title:

    Machine: PC4

    App Domain: AutoLog.exe

    ProcessId: 4200

    Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe

    Thread Name:

    Win32 ThreadId:4000

    Extended Properties:

    Timestamp: 2012/3/19 6:03:00

    Message: Exception:Customer Exception

    Category: General

    Priority: -1

    EventId: 1

    Severity: Information

    Title:

    Machine: PC4

    App Domain: AutoLog.exe

    ProcessId: 4200

    Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe

    Thread Name:

    Win32 ThreadId:4000

    Extended Properties:

    Timestamp: 2012/3/19 6:03:00

    Message: Exit method Work, use 00:00:00.0024272.

    Category: General

    Priority: -1

    EventId: 1

    Severity: Information

    Title:

    Machine: PC4

    App Domain: AutoLog.exe

    ProcessId: 4200

    Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe

    Thread Name:

    Win32 ThreadId:4000

    Extended Properties:

    Timestamp: 2012/3/19 6:03:00

    Message: Enter method ToString

    Category: General

    Priority: -1

    EventId: 1

    Severity: Information

    Title:

    Machine: PC4

    App Domain: AutoLog.exe

    ProcessId: 4200

    Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe

    Thread Name:

    Win32 ThreadId:4000

    Extended Properties:

    Timestamp: 2012/3/19 6:03:00

    Message: Exit method ToString, use 00:00:00.0001410.

    Category: General

    Priority: -1

    EventId: 1

    Severity: Information

    Title:

    Machine: PC4

    App Domain: AutoLog.exe

    ProcessId: 4200

    Process Name: D:\Codes\Enterprise Library\Enterprise Library Demos\PIAB\Demo\AutoLog\bin\Debug\AutoLog.exe

    Thread Name:

    Win32 ThreadId:4000

    Extended Properties:

实现了自动化Log后，回过头来再看第5步，Employee继承了MarshalByRefObject，一般我们的业务类或数据访问类都有基类，那么我们就需要使用接口
这里我添加一个IEmployee接口，里面就Work方法（ToString是重写Object的）。

[csharp] view plain copy print ?

  1. using System.Collections.Generic;
  2. using System.Linq;
  3. using System.Text;
  4. using Microsoft.Practices.Unity;
  6. namespace AutoLog {
  8. public interface IEmployee {
  9. void Work();
  10. }
  12. public class Employee : IEmployee
  13. {
  15. public Employee() {
  16. //this.Name = “Lele”;
  17. }
  19. public string Name { get; set; }
  21. [AutoLogCallHandler()]
  22. public void Work() {
  23. Console.WriteLine(“Now is {0},{1} is working hard!”,DateTime.Now.ToShortTimeString(),Name);
  24. throw new Exception(“Customer Exception”);
  25. }
  27. [AutoLogCallHandler()]
  28. public override string ToString() {
  29. return string.Format(“I’m {0}.”,Name);
  30. }
  31. }

  32. }

    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Practices.Unity;

    namespace AutoLog {

    1. public interface IEmployee {
    2.     void Work();
    3. }
    5. public class Employee : IEmployee 
    6. {
    8.     public Employee() {
    9.         //this.Name = "Lele";
    10.     }
    12.     public string Name { get; set; }
    14.     [AutoLogCallHandler()]
    15.     public void Work() {
    16.         Console.WriteLine("Now is {0},{1} is working hard!",DateTime.Now.ToShortTimeString(),Name);
    17.         throw new Exception("Customer Exception");
    18.     }
    20.     [AutoLogCallHandler()]
    21.     public override string ToString() {
    22.         return string.Format("I'm {0}.",Name);
    23.     }
    24. }

    }

然后在测试类改动一下

[csharp] view plain copy print ?

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.Practices.EnterpriseLibrary.PolicyInjection;
  6. using Microsoft.Practices.Unity;
  7. using Microsoft.Practices.EnterpriseLibrary.Logging;
  8. using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
  10. namespace AutoLog {
  11. class Program {
  13. private static LogWriter logWriter = EnterpriseLibraryContainer.Current.GetInstance();
  15. static void Main(string[] args) {
  17. IEmployee emp = PolicyInjection.Create();
  19. emp.Work();
  20. Console.WriteLine(emp);
  21. }
  22. }

  23. }

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Practices.EnterpriseLibrary.PolicyInjection;
    using Microsoft.Practices.Unity;
    using Microsoft.Practices.EnterpriseLibrary.Logging;
    using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;

    namespace AutoLog {

    1. class Program {
    3.     private static LogWriter logWriter = EnterpriseLibraryContainer.Current.GetInstance<LogWriter>();
    5.     static void Main(string[] args) {
    7.         IEmployee emp = PolicyInjection.Create<Employee, IEmployee>();
    9.         emp.Work();
    10.         Console.WriteLine(emp);
    11.     }
    12. }

    }

此为大牛：http://blog.csdn.net/qing2005/article/details/7368738

发表评论

表情：
评论列表 （有 0 条评论，96人围观）

还没有评论，来说两句吧...

相关阅读

    相关 c# log4net 输出日志

    C\使用 log4net输出日志 到控制台和文件 1.安装Log4Net 程序包管理控制台搜索Log4Net安装 2.配置Log4Net 安装成功后，在项目根目录新建一

    小咪咪小咪咪/ 0 赞/ 140 阅读

    相关 python log日志

    python 日志管理，可通过引入logging包，实现日志管理 一、配置文件 创建一个配置文件，如logging.conf [loggers] k

    小咪咪小咪咪/ 0 赞/ 413 阅读