碼上歡樂
相關內容    簡體    繁體

C# Log4net記錄日志

本文轉載自   查看原文   2017-07-20 11:01   5922    C#/ MVC

前言

1、需求

需求很簡單，就是在C#開發中高速寫日志。比如在高並發，高流量的地方需要寫日志。我們知道程序在操作磁盤時是比較耗時的，所以我們把日志寫到磁盤上會有一定的時間耗在上面，這些並不是我們想看到的。

 

解決方案

2.1、簡單原理說明

使用列隊先緩存到內存，然后我們一直有個線程再從列隊中寫到磁盤上，這樣就可以高速高性能的寫日志了。因為速度慢的地方我們分離出來了，也就是說程序在把日志扔給列隊后，程序的日志部分就算完成了，后面操作磁盤耗時的部分程序是不需要關心的，由另一個線程操作。

俗話說，魚和熊掌不可兼得，這樣會有一個問題，就是如果日志已經到列隊了這個時候程序崩潰或者電腦斷電都會導致日志部分丟失，但是有些地方為了高性能的寫日志，是否可以忽略一些情況，請各位根據情況而定。

 

2.2、示例圖

 

關鍵代碼部分

這里寫日志的部分LZ選用了比較常用的log4net，當然也可以選擇其他的日志組件，比如nlog等等。

3.1、日志至列隊部分

第一步我們首先需要把日志放到列隊中，然后才能從列隊中寫到磁盤上。

 public void EnqueueMessage(string message, FlashLogLevel level, Exception ex = null)
        {
            if ((level == FlashLogLevel.Debug && _log.IsDebugEnabled)
             || (level == FlashLogLevel.Error && _log.IsErrorEnabled)
             || (level == FlashLogLevel.Fatal && _log.IsFatalEnabled)
             || (level == FlashLogLevel.Info && _log.IsInfoEnabled)
             || (level == FlashLogLevel.Warn && _log.IsWarnEnabled))
            {
                _que.Enqueue(new FlashLogMessage
                {
                    Message = "[" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss,fff") + "]\r\n" + message,
                    Level = level,
                    Exception = ex
                });

                // 通知線程往磁盤中寫日志
                _mre.Set();
            }
        }

_log是log4net日志組件的ILog，其中包含了寫日志，判斷日志等級等功能，代碼開始部分的if判斷就是判斷等級和現在的日志等級做對比，看是否需要寫入列隊，這樣可以有效的提高日志的性能。

其中的_que是ConcurrentQueue列隊。_mre是ManualResetEvent信號，ManualResetEvent是用來通知線程列隊中有新的日志，可以從列隊中寫入磁盤了。當從列隊中寫完日志后，重新設置信號，在等待下次有新的日志到來。

 

3.2、列隊到磁盤

從列隊到磁盤我們需要有一個線程從列隊寫入磁盤，也就是說我們在程序啟動時就要加載這個線程，比如asp.net中就要在global中的Application_Start中加載。

/// <summary>
        /// 另一個線程記錄日志，只在程序初始化時調用一次
        /// </summary>
        public void Register()
        {
            Thread t = new Thread(new ThreadStart(WriteLog));
            t.IsBackground = false;
            t.Start();
        }

        /// <summary>
        /// 從隊列中寫日志至磁盤
        /// </summary>
        private void WriteLog()
        {
            while (true)
            {
                // 等待信號通知
                _mre.WaitOne();

                FlashLogMessage msg;
                // 判斷是否有內容需要如磁盤 從列隊中獲取內容，並刪除列隊中的內容
                while (_que.Count > 0 && _que.TryDequeue(out msg))
                {
                    // 判斷日志等級，然后寫日志
                    switch (msg.Level)
                    {
                        case FlashLogLevel.Debug:
                            _log.Debug(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Info:
                            _log.Info(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Error:
                            _log.Error(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Warn:
                            _log.Warn(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Fatal:
                            _log.Fatal(msg.Message, msg.Exception);
                            break;
                    }
                }

                // 重新設置信號
                _mre.Reset();
　　　　　　　　  Thread.Sleep(1);
            }
        }

完整代碼

using log4net;
using log4net.Config;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace Emrys.FlashLog
{
    public sealed class FlashLogger
    {
        /// <summary>
        /// 記錄消息Queue
        /// </summary>
        private readonly ConcurrentQueue<FlashLogMessage> _que;

        /// <summary>
        /// 信號
        /// </summary>
        private readonly ManualResetEvent _mre;

        /// <summary>
        /// 日志
        /// </summary>
        private readonly ILog _log;

        /// <summary>
        /// 日志
        /// </summary>
        private static FlashLogger _flashLog = new FlashLogger();


        private FlashLogger()
        {
            var configFile = new FileInfo(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "log4net.config"));
            if (!configFile.Exists)
            {
                throw new Exception("未配置log4net配置文件！");
            }

            // 設置日志配置文件路徑
            XmlConfigurator.Configure(configFile);

            _que = new ConcurrentQueue<FlashLogMessage>();
            _mre = new ManualResetEvent(false);
            _log = LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
        }

        /// <summary>
        /// 實現單例
        /// </summary>
        /// <returns></returns>
        public static FlashLogger Instance()
        {
            return _flashLog;
        }

        /// <summary>
        /// 另一個線程記錄日志，只在程序初始化時調用一次
        /// </summary>
        public void Register()
        {
            Thread t = new Thread(new ThreadStart(WriteLog));
            t.IsBackground = false;
            t.Start();
        }

        /// <summary>
        /// 從隊列中寫日志至磁盤
        /// </summary>
        private void WriteLog()
        {
            while (true)
            {
                // 等待信號通知
                _mre.WaitOne();

                FlashLogMessage msg;
                // 判斷是否有內容需要如磁盤 從列隊中獲取內容，並刪除列隊中的內容
                while (_que.Count > 0 && _que.TryDequeue(out msg))
                {
                    // 判斷日志等級，然后寫日志
                    switch (msg.Level)
                    {
                        case FlashLogLevel.Debug:
                            _log.Debug(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Info:
                            _log.Info(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Error:
                            _log.Error(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Warn:
                            _log.Warn(msg.Message, msg.Exception);
                            break;
                        case FlashLogLevel.Fatal:
                            _log.Fatal(msg.Message, msg.Exception);
                            break;
                    }
                }

                // 重新設置信號
                _mre.Reset();
                Thread.Sleep(1);
            }
        }


        /// <summary>
        /// 寫日志
        /// </summary>
        /// <param name="message">日志文本</param>
        /// <param name="level">等級</param>
        /// <param name="ex">Exception</param>
        public void EnqueueMessage(string message, FlashLogLevel level, Exception ex = null)
        {
            if ((level == FlashLogLevel.Debug && _log.IsDebugEnabled)
             || (level == FlashLogLevel.Error && _log.IsErrorEnabled)
             || (level == FlashLogLevel.Fatal && _log.IsFatalEnabled)
             || (level == FlashLogLevel.Info && _log.IsInfoEnabled)
             || (level == FlashLogLevel.Warn && _log.IsWarnEnabled))
            {
                _que.Enqueue(new FlashLogMessage
                {
                    Message = "[" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss,fff") + "]\r\n" + message,
                    Level = level,
                    Exception = ex
                });

                // 通知線程往磁盤中寫日志
                _mre.Set();
            }
        }

        public static void Debug(string msg, Exception ex = null)
        {
            Instance().EnqueueMessage(msg, FlashLogLevel.Debug, ex);
        }

        public static void Error(string msg, Exception ex = null)
        {
            Instance().EnqueueMessage(msg, FlashLogLevel.Error, ex);
        }

        public static void Fatal(string msg, Exception ex = null)
        {
            Instance().EnqueueMessage(msg, FlashLogLevel.Fatal, ex);
        }

        public static void Info(string msg, Exception ex = null)
        {
            Instance().EnqueueMessage(msg, FlashLogLevel.Info, ex);
        }

        public static void Warn(string msg, Exception ex = null)
        {
            Instance().EnqueueMessage(msg, FlashLogLevel.Warn, ex);
        }

    }

    /// <summary>
    /// 日志等級
    /// </summary>
    public enum FlashLogLevel
    {
        Debug,
        Info,
        Error,
        Warn,
        Fatal
    }


    /// <summary>
    /// 日志內容
    /// </summary>
    public class FlashLogMessage
    {
        public string Message { get; set; }
        public FlashLogLevel Level { get; set; }
        public Exception Exception { get; set; }

    }





}
View Code

性能對比和應用

4.1、性能對比

經過測試發現

使用原始的log4net寫入日志100000條數據需要：19104毫秒。

同樣數據使用列隊方式只需要251毫秒。

 

 

應用

4.2.1、需要在程序啟動時注冊，如asp.net 程序中在Global.asax中的Application_Start注冊。

public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);

            FlashLogger.Instance().Register();
        }
    }

 

4.2.2、在需要寫入日志的地方直接調用FlashLogger的靜態方法即可。

            FlashLogger.Debug("Debug");
            FlashLogger.Debug("Debug", new Exception("testexception"));
            FlashLogger.Info("Info");
            FlashLogger.Fatal("Fatal");
            FlashLogger.Error("Error");
            FlashLogger.Warn("Warn", new Exception("testexception"));

代碼開源

前去 Git下載

 

本文為轉載文章，原文地址：http://www.cnblogs.com/emrys5/p/flashlog.html


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 C#使用log4net記錄日志 C#使用Log4Net記錄日志 C# 使用 log4net 記錄日志 C#使用log4net記錄日志 C#使用Log4Net記錄日志 C# Winform 運用Log4Net記錄日志 C#使用log4net記錄日志 C#使用Log4Net記錄日志（轉） C# Log4Net學習筆記：記錄日志到數據庫 C# 利用Log4net記錄日志簡單實例
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM