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,如需转载请自行联系原作者

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
8月前
|
存储 NoSQL Redis
阿里面试:Redis 为啥那么快?怎么实现的100W并发?说出了6大架构,面试官跪地: 纯内存 + 尖端结构 + 无锁架构 + EDA架构 + 异步日志 + 集群架构
阿里面试:Redis 为啥那么快?怎么实现的100W并发?说出了6大架构,面试官跪地: 纯内存 + 尖端结构 + 无锁架构 + EDA架构 + 异步日志 + 集群架构
阿里面试:Redis 为啥那么快?怎么实现的100W并发?说出了6大架构,面试官跪地: 纯内存 + 尖端结构 +  无锁架构 +  EDA架构  + 异步日志 + 集群架构
|
10月前
|
存储 SQL 关系型数据库
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log、原理、写入过程;binlog与redolog区别、update语句的执行流程、两阶段提交、主从复制、三种日志的使用场景;查询日志、慢查询日志、错误日志等其他几类日志
786 35
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log
|
10月前
|
存储 缓存 关系型数据库
图解MySQL【日志】——Redo Log
Redo Log(重做日志)是数据库中用于记录数据页修改的物理日志,确保事务的持久性和一致性。其主要作用包括崩溃恢复、提高性能和保证事务一致性。Redo Log 通过先写日志的方式,在内存中缓存修改操作,并在适当时候刷入磁盘,减少随机写入带来的性能损耗。WAL(Write-Ahead Logging)技术的核心思想是先将修改操作记录到日志文件中,再择机写入磁盘,从而实现高效且安全的数据持久化。Redo Log 的持久化过程涉及 Redo Log Buffer 和不同刷盘时机的控制参数(如 `innodb_flush_log_at_trx_commit`),以平衡性能与数据安全性。
449 5
图解MySQL【日志】——Redo Log
|
9月前
|
监控 Java 应用服务中间件
Tomcat log日志解析
理解和解析Tomcat日志文件对于诊断和解决Web应用中的问题至关重要。通过分析 `catalina.out`、`localhost.log`、`localhost_access_log.*.txt`、`manager.log`和 `host-manager.log`等日志文件,可以快速定位和解决问题,确保Tomcat服务器的稳定运行。掌握这些日志解析技巧,可以显著提高运维和开发效率。
852 13
|
11月前
|
SQL 关系型数据库 MySQL
MySQL事务日志-Undo Log工作原理分析
事务的持久性是交由Redo Log来保证,原子性则是交由Undo Log来保证。如果事务中的SQL执行到一半出现错误,需要把前面已经执行过的SQL撤销以达到原子性的目的,这个过程也叫做"回滚",所以Undo Log也叫回滚日志。
543 7
MySQL事务日志-Undo Log工作原理分析
|
9月前
|
SQL 存储 关系型数据库
简单聊聊MySQL的三大日志(Redo Log、Binlog和Undo Log)各有什么区别
在MySQL数据库管理中,理解Redo Log(重做日志)、Binlog(二进制日志)和Undo Log(回滚日志)至关重要。Redo Log确保数据持久性和崩溃恢复;Binlog用于主从复制和数据恢复,记录逻辑操作;Undo Log支持事务的原子性和隔离性,实现回滚与MVCC。三者协同工作,保障事务ACID特性。文章还详细解析了日志写入流程及可能的异常情况,帮助深入理解数据库日志机制。
1074 0
|
10月前
|
存储 关系型数据库 MySQL
图解MySQL【日志】——Undo Log
Undo Log(回滚日志)是 MySQL 中用于实现事务原子性和一致性的关键机制。在默认的自动提交模式下,MySQL 隐式开启事务,每条增删改语句都会记录到 Undo Log 中。其主要作用包括:
324 0
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
3641 31
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
7月前
|
监控 容灾 算法
阿里云 SLS 多云日志接入最佳实践:链路、成本与高可用性优化
本文探讨了如何高效、经济且可靠地将海外应用与基础设施日志统一采集至阿里云日志服务(SLS),解决全球化业务扩展中的关键挑战。重点介绍了高性能日志采集Agent(iLogtail/LoongCollector)在海外场景的应用,推荐使用LoongCollector以获得更优的稳定性和网络容错能力。同时分析了多种网络接入方案,包括公网直连、全球加速优化、阿里云内网及专线/CEN/VPN接入等,并提供了成本优化策略和多目标发送配置指导,帮助企业构建稳定、低成本、高可用的全球日志系统。
808 54

热门文章

最新文章