C#寫日誌工具類(新版)

阿新 • • 發佈：2021-10-07

昨天打算把我以前寫的一個C#寫日誌工具類放到GitHub上，卻發現了一個BUG，當然，已經修復了。

然後寫Demo對比了NLog和log4net，發現我這個LogUtil比它們效能低了不止一個數量級。工作多年，平時都是用別人寫的庫，自己寫的很少。因為當初自己沒有時間研究log4net或NLog，並且寫個簡單的日誌工具類自己也有能力實現，所以就自己寫了LogUtil自己用，修修改改了很多次了，居然還是有BUG，因為用了多執行緒和鎖，BUG還很隱蔽，而且效能還比較差，程式碼寫的很挫。因為邏輯複雜，更容易出BUG。用NLog或log4net它不香嗎？但又心有不甘，而且對於自己寫的一些小的程式，可能第三方日誌類庫的dll比自己的程式都大，所以也有必要自己寫一個，以便平時寫各種Demo用。

之前寫的很挫，邏輯很複雜的日誌工具類：https://www.cnblogs.com/s0611163/p/4023859.html

日誌型別LogType類：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Utils
{
    /// <summary>
    /// 日誌型別
    /// </summary>
    public enum LogType
    {
        Debug,

        Info,

        Error
    }
}

View Code

當前日誌寫入流LogStream類：

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Utils
{
    internal class LogStream
    {
        public FileStream CurrentFileStream { get; set; }

        public StreamWriter CurrentStreamWriter { get 
; set; }

        public int CurrentArchiveIndex { get; set; }

        public long CurrentFileSize { get; set; }

        public string CurrentDateStr { get; set; }

        public string CurrentLogFilePath { get; set; }

        public string CurrentLogFileDir { get; set; }
    }
}

View Code

LogWriter類：

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;

namespace Utils
{
    internal class LogWriter
    {
        #region 欄位屬性

        private LogType _logType;

        private string _basePath;

        private int _fileSize = 10 * 1024 * 1024; //日誌分隔檔案大小

        private LogStream _currentStream = new LogStream();

        private string _dateFormat = "yyyyMMdd"; //日誌檔名日期格式化

        private string _rootFolder = "Log"; //日誌資料夾名稱

        #endregion

        #region LogWriter
        public LogWriter(LogType logType)
        {
            _logType = logType;

            Init();
        }
        #endregion

        #region Init
        /// <summary>
        /// 初始化
        /// </summary>
        private void Init()
        {
            //初始化 _basePath
            InitBasePath();

            //建立目錄
            CreateLogDir();

            //更新日誌寫入流
            UpdateCurrentStream();
        }
        #endregion

        #region 初始化 _basePath
        /// <summary>
        /// 初始化 _basePath
        /// </summary>
        private void InitBasePath()
        {
            UriBuilder uri = new UriBuilder(Assembly.GetExecutingAssembly().CodeBase);
            _basePath = Path.GetDirectoryName(Uri.UnescapeDataString(uri.Path));
        }
        #endregion

        #region 初始化 _currentArchiveIndex
        /// <summary>
        /// 初始化 _currentArchiveIndex
        /// </summary>
        private void InitCurrentArchiveIndex()
        {
            Regex regex = new Regex(_currentStream.CurrentDateStr + "_*(\\d*).txt");
            string[] fileArr = Directory.GetFiles(_currentStream.CurrentLogFileDir, _currentStream.CurrentDateStr + "*");
            foreach (string file in fileArr)
            {
                Match match = regex.Match(file);
                if (match.Success)
                {
                    string str = match.Groups[1].Value;
                    if (!string.IsNullOrWhiteSpace(str))
                    {
                        int temp = Convert.ToInt32(str);
                        if (temp > _currentStream.CurrentArchiveIndex)
                        {
                            _currentStream.CurrentArchiveIndex = temp;
                        }
                    }
                    else
                    {
                        _currentStream.CurrentArchiveIndex = 0;
                    }
                }
            }
        }
        #endregion

        #region 初始化 _currentFileSize
        /// <summary>
        /// 初始化 _currentFileSize
        /// </summary>
        private void InitCurrentFileSize()
        {
            FileInfo fileInfo = new FileInfo(_currentStream.CurrentLogFilePath);
            _currentStream.CurrentFileSize = fileInfo.Length;
        }
        #endregion

        #region CreateLogDir()
        /// <summary>
        /// 建立日誌目錄
        /// </summary>
        private void CreateLogDir()
        {
            string logDir = Path.Combine(_basePath, _rootFolder + "\\" + _logType.ToString());
            if (!Directory.Exists(logDir))
            {
                Directory.CreateDirectory(logDir);
            }
        }
        #endregion

        #region CreateStream
        /// <summary>
        /// 建立日誌寫入流
        /// </summary>
        private void CreateStream()
        {
            _currentStream.CurrentFileStream = new FileStream(_currentStream.CurrentLogFilePath, FileMode.Append, FileAccess.Write, FileShare.ReadWrite);
            _currentStream.CurrentStreamWriter = new StreamWriter(_currentStream.CurrentFileStream, Encoding.UTF8);
        }
        #endregion

        #region CloseStream
        /// <summary>
        /// 關閉日誌寫入流
        /// </summary>
        private void CloseStream()
        {
            if (_currentStream.CurrentStreamWriter != null)
            {
                _currentStream.CurrentStreamWriter.Close();
            }

            if (_currentStream.CurrentFileStream != null)
            {
                _currentStream.CurrentFileStream.Close();
            }
        }
        #endregion

        #region 拼接日誌內容
        /// <summary>
        /// 拼接日誌內容
        /// </summary>
        private static string CreateLogString(LogType logType, string log)
        {
            return string.Format(@"{0} {1} {2}", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff"), ("[" + logType.ToString() + "]").PadRight(7, ' '), log);
        }
        #endregion

        #region 寫檔案
        /// <summary>
        /// 寫檔案
        /// </summary>
        private void WriteFile(string log)
        {
            try
            {
                //判斷是否更新Stream
                string dateStr = DateTime.Now.ToString(_dateFormat);
                if (_currentStream.CurrentDateStr != dateStr)
                {
                    _currentStream.CurrentDateStr = dateStr;
                    UpdateCurrentStream();
                }

                //判斷是否建立Archive
                int byteCount = Encoding.UTF8.GetByteCount(log);
                _currentStream.CurrentFileSize += byteCount;
                if (_currentStream.CurrentFileSize >= _fileSize)
                {
                    _currentStream.CurrentFileSize = 0;
                    CreateArchive();
                }

                //日誌內容寫入檔案
                _currentStream.CurrentStreamWriter.WriteLine(log);
                _currentStream.CurrentStreamWriter.Flush();
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message + "\r\n" + ex.StackTrace);
            }
        }
        #endregion

        #region CreateArchive
        /// <summary>
        /// 建立日誌存檔
        /// </summary>
        private void CreateArchive()
        {
            string fileName = Path.GetFileNameWithoutExtension(_currentStream.CurrentLogFilePath);

            CloseStream(); //關閉日誌寫入流
            File.Move(_currentStream.CurrentLogFilePath, Path.Combine(_currentStream.CurrentLogFileDir, fileName + "_" + (++_currentStream.CurrentArchiveIndex) + ".txt")); //存檔
            CreateStream(); //建立日誌寫入流
        }
        #endregion

        #region UpdateCurrentStream
        /// <summary>
        /// 更新日誌寫入流
        /// </summary>
        private void UpdateCurrentStream()
        {
            try
            {
                //關閉日誌寫入流
                CloseStream();

                //建立新的日誌路徑
                _currentStream.CurrentDateStr = DateTime.Now.ToString(_dateFormat);
                _currentStream.CurrentLogFileDir = Path.Combine(_basePath, _rootFolder + "\\" + _logType.ToString());
                _currentStream.CurrentLogFilePath = Path.Combine(_currentStream.CurrentLogFileDir, _currentStream.CurrentDateStr + ".txt");

                //建立日誌寫入流
                CreateStream();

                //初始化 _currentArchiveIndex
                InitCurrentArchiveIndex();

                //初始化 _currentFileSize
                InitCurrentFileSize();
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message + "\r\n" + ex.StackTrace);
            }
        }
        #endregion

        #region 寫日誌
        /// <summary>
        /// 寫日誌
        /// </summary>
        /// <param name="log">日誌內容</param>
        public void WriteLog(string log)
        {
            try
            {
                log = CreateLogString(_logType, log);
                WriteFile(log);
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message + "\r\n" + ex.StackTrace);
            }
        }
        #endregion

    }
}

View Code

靜態類LogUtil類：

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;

namespace Utils
{
    /// <summary>
    /// 寫日誌類
    /// </summary>
    public class LogUtil
    {
        #region 欄位

        private static LogWriter _infoWriter = new LogWriter(LogType.Info);

        private static LogWriter _debugWriter = new LogWriter(LogType.Debug);

        private static LogWriter _errorWriter = new LogWriter(LogType.Error);

        #endregion

        #region 寫操作日誌
        /// <summary>
        /// 寫操作日誌
        /// </summary>
        public static void Log(string log)
        {
            _infoWriter.WriteLog(log);
        }
        #endregion

        #region 寫除錯日誌
        /// <summary>
        /// 寫除錯日誌
        /// </summary>
        public static void Debug(string log)
        {
            _debugWriter.WriteLog(log);
        }
        #endregion

        #region 寫錯誤日誌
        public static void Error(Exception ex, string log = null)
        {
            Error(string.IsNullOrEmpty(log) ? ex.Message + "\r\n" + ex.StackTrace : (log + "：") + ex.Message + "\r\n" + ex.StackTrace);
        }

        /// <summary>
        /// 寫錯誤日誌
        /// </summary>
        public static void Error(string log)
        {
            _errorWriter.WriteLog(log);
        }
        #endregion

    }

}

View Code

測試程式碼(LogUtil、NLog、log4net寫日誌效能對比)：

using NLog;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Diagnostics;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
using Utils;

namespace LogUtilTest
{
    public partial class Form1 : Form
    {
        private Logger _log = NLog.LogManager.GetCurrentClassLogger();

        private log4net.ILog _log2 = null;

        private int n = 300000;

        public Form1()
        {
            InitializeComponent();
            ThreadPool.SetMinThreads(20, 20);

            UriBuilder uri = new UriBuilder(Assembly.GetExecutingAssembly().CodeBase);
            string path = Path.GetDirectoryName(Uri.UnescapeDataString(uri.Path));
            FileInfo configFile = new FileInfo(Path.Combine(path, "log4net.config"));
            log4net.Config.XmlConfigurator.Configure(configFile);

            _log2 = log4net.LogManager.GetLogger(typeof(Form1));
        }

        #region Log
        private void Log(string log)
        {
            if (!this.IsDisposed)
            {
                if (this.InvokeRequired)
                {
                    this.BeginInvoke(new Action(() =>
                    {
                        textBox1.AppendText(DateTime.Now.ToString("HH:mm:ss.fff") + " " + log + "\r\n\r\n");
                    }));
                }
                else
                {
                    textBox1.AppendText(DateTime.Now.ToString("HH:mm:ss.fff") + " " + log + "\r\n\r\n");
                }
            }
        }
        #endregion

        private void button1_Click(object sender, EventArgs e)
        {
            LogUtil.Log("測試寫 Info 日誌");
            LogUtil.Debug("測試寫 Debug 日誌");
            LogUtil.Error("測試寫 Error 日誌");
        }

        private void button2_Click(object sender, EventArgs e)
        {
            Task.Run(() =>
            {
                Log("==== 開始 ========");
                Stopwatch stopwatch = new Stopwatch();
                stopwatch.Start();
                List<Task> taskList = new List<Task>();
                Task tsk = null;
                int taskCount = 0;

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        LogUtil.Log("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        LogUtil.Debug("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        LogUtil.Error("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                Task.WaitAll(taskList.ToArray());
                Log("Task Count=" + taskCount);

                Log("==== 結束 " + "，耗時：" + stopwatch.Elapsed.TotalSeconds.ToString("0.000") + " 秒 ========");
                stopwatch.Stop();
            });
        }

        //對比NLog
        private void button3_Click(object sender, EventArgs e)
        {
            Task.Run(() =>
            {
                Log("==== 開始 ========");
                Stopwatch stopwatch = new Stopwatch();
                stopwatch.Start();
                List<Task> taskList = new List<Task>();
                Task tsk = null;
                int taskCount = 0;

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        _log.Info("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        _log.Debug("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        _log.Error("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                Task.WaitAll(taskList.ToArray());
                Log("Task Count=" + taskCount);

                Log("==== 結束 " + "，耗時：" + stopwatch.Elapsed.TotalSeconds.ToString("0.000") + " 秒 ========");
                stopwatch.Stop();
            });
        }

        //對比log4net
        private void button4_Click(object sender, EventArgs e)
        {
            Task.Run(() =>
            {
                Log("==== 開始 ========");
                Stopwatch stopwatch = new Stopwatch();
                stopwatch.Start();
                List<Task> taskList = new List<Task>();
                Task tsk = null;
                int taskCount = 0;

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        _log2.Info("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        _log2.Debug("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                tsk = Task.Run(() =>
                {
                    for (int i = 0; i < n; i++)
                    {
                        _log2.Error("測試日誌 " + i.ToString("000000"));
                        Interlocked.Increment(ref taskCount);
                    }
                });
                taskList.Add(tsk);

                Task.WaitAll(taskList.ToArray());
                Log("Task Count=" + taskCount);

                Log("==== 結束 " + "，耗時：" + stopwatch.Elapsed.TotalSeconds.ToString("0.000") + " 秒 ========");
                stopwatch.Stop();
            });
        }

    }
}

View Code

log4net.config配置檔案：

<?xml version="1.0" encoding="utf-8"?>
<log4net>
  <!-- 日誌檔案配置-->
  <root>
    <level value="ALL"/>
    <!--按檔案儲存日誌-->
    <appender-ref ref="DebugAppender"/>
    <appender-ref ref="InfoAppender"/>
    <appender-ref ref="ErrorAppender" />
  </root>
  <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
    <param name="File" value=".\\Logs\\Error\\" />
    <!--日誌記錄的存在路-->
    <param name="AppendToFile" value="true" />
    <!--為true就表示日誌會附加到檔案，為false，則會重新建立一個新檔案-->
    <param name="MaxSizeRollBackups" value="100" />
    <!--建立最大檔案數-->
    <param name="maximumFileSize" value="10MB" />
    <!--檔案大小-->
    <param name="StaticLogFileName" value="false" />
    <!--是否指定檔名-->
    <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;"/>
    <!--檔案格式-->
    <param name="RollingStyle" value="Composite" />
    <!--建立新檔案的方式，可選為Size（按檔案大小），Date（按日期），Once（每啟動一次建立一個檔案），Composite（按日期及檔案大小），預設為Composite-->
    <layout type="log4net.Layout.PatternLayout">
      <!--輸出內容佈局-->
      <param name="ConversionPattern" value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
      <!--method會影響效能-->
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <param name="LevelMin" value="ERROR" />
      <param name="LevelMax" value="ERROR" />
    </filter>
  </appender>
  <appender name="InfoAppender" type="log4net.Appender.RollingFileAppender">
    <param name="File" value=".\\Logs\\Info\\" />
    <param name="AppendToFile" value="true" />
    <param name="MaxSizeRollBackups" value="100" />
    <param name="maximumFileSize" value="10MB" />
    <param name="StaticLogFileName" value="false" />
    <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />
    <param name="RollingStyle" value="Composite" />
    <layout type="log4net.Layout.PatternLayout">
      <param name="ConversionPattern" value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <param name="LevelMin" value="INFO" />
      <param name="LevelMax" value="INFO" />
    </filter>
  </appender>
  <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
    <param name="File" value=".\\Logs\\Debug\\" />
    <param name="AppendToFile" value="true" />
    <param name="MaxSizeRollBackups" value="100" />
    <param name="maximumFileSize" value="10MB" />
    <param name="StaticLogFileName" value="false" />
    <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />
    <param name="RollingStyle" value="Composite" />
    <layout type="log4net.Layout.PatternLayout">
      <param name="ConversionPattern" value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <param name="LevelMin" value="DEBUG" />
      <param name="LevelMax" value="DEBUG" />
    </filter>
  </appender>
</log4net>

View Code

NLog.config配置檔案：

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
      autoReload="true"
      throwExceptions="false"
      internalLogLevel="Off"
      internalLogFile="d:\nlog\nlog-internal.log">

  <!-- optional, add some variables
  https://github.com/nlog/NLog/wiki/Configuration-file#variables
  -->
  <variable name="myvar" value="myvalue"/>
  <variable name="rootFolder" value="nlog"/>

  <!--
  See https://github.com/nlog/nlog/wiki/Configuration-file
  for information on customizing logging rules and outputs.
   -->

  <targets>

    <!--
    add your targets here
    See https://github.com/nlog/NLog/wiki/Targets for possible targets.
    See https://github.com/nlog/NLog/wiki/Layout-Renderers for the possible layout renderers.
    -->

    <!--
    Write events to a file with the date in the filename.
    <target xsi:type="File" name="f" fileName="${basedir}/logs/${shortdate}.log"
            layout="${longdate} ${uppercase:${level}} ${message}" />
    -->
    <target xsi:type="File" name="info" fileName="${basedir}/${rootFolder}/info/${shortdate}.log"
            layout="${longdate} ${uppercase:${level}} ${message}"
            archiveFileName="${basedir}/${rootFolder}/info/${shortdate}-{#####}.log"
            archiveAboveSize="10485760"
            archiveNumbering="Sequence"
            maxArchiveFiles="100"
            concurrentWrites="true"
            keepFileOpen="true"
            openFileCacheTimeout="30"
            encoding="UTF-8" />

    <target xsi:type="File" name="debug" fileName="${basedir}/${rootFolder}/debug/${shortdate}.log"
            layout="${longdate} ${uppercase:${level}} ${message}"
            archiveFileName="${basedir}/${rootFolder}/debug/${shortdate}-{#####}.log"
            archiveAboveSize="10485760"
            archiveNumbering="Sequence"
            maxArchiveFiles="100"
            concurrentWrites="true"
            keepFileOpen="true"
            openFileCacheTimeout="30"
            encoding="UTF-8" />

    <target xsi:type="File" name="error" fileName="${basedir}/${rootFolder}/error/${shortdate}.log"
            layout="${longdate} ${uppercase:${level}} ${message}"
            archiveFileName="${basedir}/${rootFolder}/error/${shortdate}-{#####}.log"
            archiveAboveSize="10485760"
            archiveNumbering="Sequence"
            maxArchiveFiles="100"
            concurrentWrites="true"
            keepFileOpen="true"
            openFileCacheTimeout="30"
            encoding="UTF-8" />
  </targets>

  <rules>
    <!-- add your logging rules here -->

    <!--
    Write all events with minimal level of Debug (So Debug, Info, Warn, Error and Fatal, but not Trace)  to "f"
    <logger name="*" minlevel="Debug" writeTo="f" />
    -->
    <logger name="*" minlevel="Info" maxlevel="Info" writeTo="info" />

    <logger name="*" minlevel="Debug" maxlevel="Debug" writeTo="debug" />

    <logger name="*" minlevel="Error" maxlevel="Error" writeTo="error" />
  </rules>
</nlog>

View Code

測試截圖：

寫Info、Debug、Error日誌各30萬行，LogUtil耗時4.562秒，NLog耗時4.979秒，log4net耗時11.797秒，硬碟是固態硬碟。

總結：

一個方法的程式碼行數不宜太長，邏輯要簡單，不容易出BUG；單執行緒相比多執行緒，不容易出BUG。

C#寫日誌工具類(新版)

C#寫日誌工具類(新版)

C# 寫日誌幫助類

c#日誌工具類

Android讀寫檔案工具類詳解

c#寫日誌

日誌工具類

log4j日誌工具類

C# 記憶體快取工具類 MemoryCacheUtil

C++檔案處理工具類

Android日誌檔案的讀寫工具類

如何用nodejs給C#寫一個數據表的實體類生成工具

基於C# 寫一個 Redis 資料同步小工具

C# 日誌操類（除錯程式記錄異常資訊）

Java通用日誌格式化工具類DateUtil

最新版easyExcel工具類.md

C#寫差異檔案備份工具的示例

json轉java物件，java物件轉json，自定義工具類封裝物件與寫給客戶端

Android日誌列印工具類

Java利用POI讀寫Excel檔案工具類

記錄一個純粹的c++寫的ini檔案的讀寫類,網上開源的原始碼,我也樂意完善之後再分享出來

C#寫日誌工具類(新版)

相關推薦