C# 简易异步日志类 [ C# | Log | TextWriterTraceListener ]

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介:

前言

  即使是小型项目,也需要日志的功能,这里就不讨论Log4Net之类的框架,提供一个异步的、控制台输出+日志文件输出的简易日志帮助类。
 

 

正文

  一、帮助类文件Logger.cs

// =========================================
//
//  作 者:农民伯伯
//  邮 箱:over140@gmail.com
//  博 客: http://over140.cnblogs.com/
//  时 间:2009-7-16
//  描 述:日志类,注意需要在日志记录的目录给用户写入权限!
//
// =========================================

using  System;
using  System.Configuration;
using  System.Collections.Generic;
using  System.Data.SqlClient;
using  System.Diagnostics;
using  System.IO;
using  System.Text;
using  System.Runtime.CompilerServices;
using  System.Web;


namespace  CentralHousesTest
{
    
///   <summary>
    
///  日志类
    
///   </summary>
     public   sealed   class  Logger
    {
        
#region  Member Variables

        
///   <summary>
        
///  用于Trace的组织输出的类别名称
        
///   </summary>
         private   const   string  trace_sql  =   " \r\n***********************TRACE_SQL {0}*****************************\r\nTRACE_SQL " ;

        
///   <summary>
        
///  用于Trace的组织输出的类别名称
        
///   </summary>
         private   const   string  trace_exception  =   " \r\n***********************TRACE_EXCEPTION {0}*********************** " ;

        
///   <summary>
        
///  当前日志的日期
        
///   </summary>
         private   static  DateTime CurrentLogFileDate  =  DateTime.Now;

        
///   <summary>
        
///  日志对象
        
///   </summary>
         private   static  TextWriterTraceListener twtl;

        
///   <summary>
        
///  日志根目录
        
///   </summary>
         private   const   string  log_root_directory  =   @" D:\log " ;

        
///   <summary>
        
///  日志子目录
        
///   </summary>
         private   static   string  log_subdir;


        
///   <summary>
        
///  "      {0} = {1}"
        
///   </summary>
         private   const   string  FORMAT_TRACE_PARAM  =   "       {0} = {1} " ;

        
///   <summary>
        
///  1   仅控制台输出
        
///  2   仅日志输出
        
///  3   控制台+日志输出
        
///   </summary>
         private   static   readonly   int  flag  =   2 ;          // 可以修改成从配置文件读取

        
#endregion

        
#region  Constructor

        
static  Logger()
        {
            System.Diagnostics.Trace.AutoFlush 
=   true ;

            
switch  (flag)
            {
                
case   1 :
                    System.Diagnostics.Trace.Listeners.Add(
new  ConsoleTraceListener());
                    
break ;
                
case   2 :
                    System.Diagnostics.Trace.Listeners.Add(TWTL);
                    
break ;
                
case   3 :
                    System.Diagnostics.Trace.Listeners.Add(
new  ConsoleTraceListener());
                    System.Diagnostics.Trace.Listeners.Add(TWTL);
                    
break ;
            }
        }

        
#endregion

        
#region  Method

        
#region  trace

        
///   <summary>
        
///  异步错误日志
        
///   </summary>
        
///   <param name="value"></param>
         public   static   void  Trace(Exception ex)
        {
            
new  AsyncLogException(BeginTraceError).BeginInvoke(ex,  null null );
        }

        
///   <summary>
        
///  异步SQL日志
        
///   </summary>
        
///   <param name="cmd"></param>
         public   static   void  Trace(SqlCommand cmd)
        {
            
new  AsyncLogSqlCommand(BeginTraceSqlCommand).BeginInvoke(cmd,  null null );
        }

        
///   <summary>
        
///  异步SQL日志
        
///   </summary>
        
///   <param name="sql"></param>
        
///   <param name="parameter"></param>
         public   static   void  Trace( string  sql,  params  SqlParameter[] parameter)
        {
            
new  AsyncLogSql(BeginTraceSql).BeginInvoke(sql, parameter,  null null );
        }

        
#endregion

        
#region  delegate

        
private   delegate   void  AsyncLogException(Exception ex);
        
private   delegate   void  AsyncLogSqlCommand(SqlCommand cmd);
        
private   delegate   void  AsyncLogSql( string  sql,  params  SqlParameter[] parameter);

        
private   static   void  BeginTraceError(Exception ex)
        {
            
if  ( null   !=  ex)
            {
                
// 检测日志日期
                StrategyLog();

                
// 输出日志头
                System.Diagnostics.Trace.WriteLine( string .Format(trace_exception, DateTime.Now));
                
while  ( null   !=  ex)
                {
                    System.Diagnostics.Trace.WriteLine(
string .Format( " {0} {1}\r\n{2}\r\nSource:{3} " , ex.GetType().Name, ex.Message, ex.StackTrace, ex.Source));
                    ex 
=  ex.InnerException;
                }
            }
        }

        
private   static   void  BeginTraceSqlCommand(SqlCommand cmd)
        {
            
if  ( null   !=  cmd)
            {
                SqlParameter[] parameter 
=   new  SqlParameter[cmd.Parameters.Count];
                cmd.Parameters.CopyTo(parameter, 
0 );
                BeginTraceSql(cmd.CommandText, parameter);
            }
        }

        
private   static   void  BeginTraceSql( string  sql,  params  SqlParameter[] parameter)
        {
            
if  ( ! string .IsNullOrEmpty(sql))
            {
                
// 检测日志日期
                StrategyLog();

                System.Diagnostics.Trace.WriteLine(sql, 
string .Format(trace_sql, DateTime.Now));
                
if  (parameter  !=   null )
                {
                    
foreach  (SqlParameter param  in  parameter)
                    {
                        System.Diagnostics.Trace.WriteLine(
string .Format(FORMAT_TRACE_PARAM, param.ParameterName, param.Value));
                    }
                }
            }
        }

        
#endregion

        
#region  helper

        
///   <summary>
        
///  根据日志策略生成日志
        
///   </summary>
         private   static   void  StrategyLog()
        {
            
// 判断日志日期
             if  (DateTime.Compare(DateTime.Now.Date, CurrentLogFileDate.Date)  !=   0 )
            {
                DateTime currentDate 
=  DateTime.Now.Date;

                
// 生成子目录
                BuiderDir(currentDate);
                
// 更新当前日志日期
                CurrentLogFileDate  =  currentDate;

                System.Diagnostics.Trace.Flush();

                
// 更改输出
                 if  (twtl  !=   null )
                    System.Diagnostics.Trace.Listeners.Remove(twtl);

                System.Diagnostics.Trace.Listeners.Add(TWTL);
            }
        }

        
///   <summary>
        
///  根据年月生成子目录
        
///   </summary>
        
///   <param name="currentDate"></param>
         private   static   void  BuiderDir(DateTime currentDate)
        {
            
int  year  =  currentDate.Year;
            
int  month  =  currentDate.Month;
            
// 年/月
             string  subdir  =   string .Concat(year,  ' \\ ' , month);
            
string  path  =  Path.Combine(log_root_directory, subdir);
            
if  ( ! Directory.Exists(path))
            {
                Directory.CreateDirectory(path);
            }
            log_subdir 
=  subdir;
        }

        
#endregion

        
#endregion

        
#region  Properties

        
///   <summary>
        
///  日志文件路径
        
///   </summary>
        
///   <returns></returns>
         private   static   string  GetLogFullPath
        {
            
get
            {
                
return   string .Concat(log_root_directory,  ' \\ ' string .Concat(log_subdir,  @" \log " , CurrentLogFileDate.ToShortDateString(),  " .txt " ));
            }
        }

        
///   <summary>
        
///  跟踪输出日志文件
        
///   </summary>
         private   static  TextWriterTraceListener TWTL
        {
            
get
            {
                
if  (twtl  ==   null )
                {
                    
if  ( string .IsNullOrEmpty(log_subdir))
                        BuiderDir(DateTime.Now);
                    
else
                    {
                        
string  logPath  =  GetLogFullPath;
                        
if  ( ! Directory.Exists(Path.GetDirectoryName(logPath)))
                            BuiderDir(DateTime.Now);
                    }
                    twtl 
=   new  TextWriterTraceListener(GetLogFullPath);
                }
                
return  twtl;
            }
        }

        
#endregion

    }
}

 

  二、示例

    2.1  错误记录

         static   void  Main( string [] args)
        {
            IList
< string >  list  =   null ;

            
try
            {
                Console.WriteLine(list.Count);
            }
            
catch  (Exception ex)
            {
                Logger.Trace(ex);
            }

            Console.ReadLine();
        }

 

      代码说明:错误很明显,未实例化就使用Count属性。

      日志截图:

 

 

2.2  数据库记录

             using  (SqlConnection con  =   new  SqlConnection( " Data Source=OVERA;Initial Catalog=Northwind;User ID=sa;Password=sa; " ))
            {
                con.Open();
                SqlCommand sqlCmd 
=   new  SqlCommand( " SELECT * FROM Customers WHERE CompanyName = @CompanyName " , con);
                sqlCmd.Parameters.Add(
new  SqlParameter( " @CompanyName " " Alfreds Futterkiste " ));

                Logger.Trace(sqlCmd);

                SqlDataReader sdr 
=  sqlCmd.ExecuteReader();
                
while  (sdr.Read())
                {
                    Console.Write(sdr.GetName(
1 ));
                    Console.Write(
"  :  " );
                    Console.WriteLine( sdr[
1 ]); 
                }
                sdr.Close();
            }

            Console.ReadLine();
        }

      日志截图:

 

 

需要注意这里日志策略改为了仅日志文件输出。

 


 

  三、注意事项

    3.1  进行日志文件输出的时候需要有写的权限。

    3.2  实际使用中可能还会有一个变量控制是否进行日志记录。

    3.3  错误记录一般会在Global.asax的Application_Error里面加上。

 

结束语  

  对于一般的小项目这个日志类是够用的了,日志的策略还可以根据自己的需求改变一下,合适就行: )  



本文转自over140 51CTO博客,原文链接:http://blog.51cto.com/over140/584204,如需转载请自行联系原作者

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
12天前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
121 30
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
1月前
|
XML JSON Java
Logback 与 log4j2 性能对比:谁才是日志框架的性能王者?
【10月更文挑战第5天】在Java开发中,日志框架是不可或缺的工具,它们帮助我们记录系统运行时的信息、警告和错误,对于开发人员来说至关重要。在众多日志框架中,Logback和log4j2以其卓越的性能和丰富的功能脱颖而出,成为开发者们的首选。本文将深入探讨Logback与log4j2在性能方面的对比,通过详细的分析和实例,帮助大家理解两者之间的性能差异,以便在实际项目中做出更明智的选择。
221 3
|
1月前
|
存储 缓存 关系型数据库
MySQL事务日志-Redo Log工作原理分析
事务的隔离性和原子性分别通过锁和事务日志实现,而持久性则依赖于事务日志中的`Redo Log`。在MySQL中,`Redo Log`确保已提交事务的数据能持久保存,即使系统崩溃也能通过重做日志恢复数据。其工作原理是记录数据在内存中的更改,待事务提交时写入磁盘。此外,`Redo Log`采用简单的物理日志格式和高效的顺序IO,确保快速提交。通过不同的落盘策略,可在性能和安全性之间做出权衡。
1630 14
|
1月前
|
Python
log日志学习
【10月更文挑战第9天】 python处理log打印模块log的使用和介绍
31 0
|
1月前
|
数据可视化
Tensorboard可视化学习笔记(一):如何可视化通过网页查看log日志
关于如何使用TensorBoard进行数据可视化的教程,包括TensorBoard的安装、配置环境变量、将数据写入TensorBoard、启动TensorBoard以及如何通过网页查看日志文件。
194 0
|
3月前
|
Kubernetes Ubuntu Windows
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
131 3
|
1月前
|
存储 分布式计算 NoSQL
大数据-136 - ClickHouse 集群 表引擎详解1 - 日志、Log、Memory、Merge
大数据-136 - ClickHouse 集群 表引擎详解1 - 日志、Log、Memory、Merge
40 0
|
1月前
|
缓存 Linux 编译器
【C++】CentOS环境搭建-安装log4cplus日志组件包及报错解决方案
通过上述步骤,您应该能够在CentOS环境中成功安装并使用log4cplus日志组件。面对任何安装或使用过程中出现的问题,仔细检查错误信息,对照提供的解决方案进行调整,通常都能找到合适的解决之道。log4cplus的强大功能将为您的项目提供灵活、高效的日志管理方案,助力软件开发与维护。
54 0
|
2月前
|
Java
日志框架log4j打印异常堆栈信息携带traceId,方便接口异常排查
日常项目运行日志,异常栈打印是不带traceId,导致排查问题查找异常栈很麻烦。
|
2月前
|
存储 监控 数据可视化
SLS 虽然不是直接使用 OSS 作为底层存储,但它凭借自身独特的存储架构和功能,为用户提供了一种专业、高效的日志服务解决方案。
【9月更文挑战第2天】SLS 虽然不是直接使用 OSS 作为底层存储,但它凭借自身独特的存储架构和功能,为用户提供了一种专业、高效的日志服务解决方案。
150 9