Work Time Manager【開源項目】- 建立本身日誌組件 2.0重構【WPF MaterialDesign 示例開源項目】 Work Time Manager 【.net】建立屬於本身的l

時間 2019-12-11

標籤 work time manager 開源項目建立本身日誌組件 2.0 wpf materialdesign 示例開源項目 .net 屬於简体版

原文原文鏈接

Hello all ，我又回來了html

此次咱們真是開始來聊聊開源項目裏，小而有用的模塊或者組件的開發思想。git

同時，軟件已經更新到1.60的版本了，支持新用戶註冊，能夠再也不使用統一的test帳戶了。github

您能夠經過如下路徑進行下載：c#

一、在GitHub上fellow一下項目，下載到本地，生成一下，便可獲取最新版程序。api

二、本地是beta v0.5版本的用戶能夠直接在程序右上角點擊更新多線程

三、最後給非微軟系開發者的是如下的壓縮包，直接解壓便可使用。架構

【點擊下載】post

若是你還不知道是什麼軟件，能夠查看這篇博文：性能

【WPF MaterialDesign 示例開源項目】 Work Time Manager

今天，咱們聊聊客戶端的日誌組件。學習

我也不知道說組件合不合適，反正就是屬於軟件一部分而且能夠被重複利用的小模塊我稱之爲組件。

此次的日誌類就是很典型的一個組件，日誌有不少特色;

一、會被使用在軟件的任意一個地方

二、隨時都會被調用

三、使用率極高

四、頻繁的io操做

在我剛剛接觸c#的時候，就使用過了Log4net，可是，那時候就萌生的想法是，我一個程序可能也才幾m大小，一個日誌組件就比上我一個主程序了，這明顯是不合適的。

因而兩年前尚未畢業的我着手作了本身的第一個日誌組件。

【.net】建立屬於本身的log組件——改進版

基礎的思想仍是好的，包括:線程，阻塞，資源競爭等都作了必定的考慮。

俗話說初生牛犢不怕虎，啥也不太知道的本身就這麼開幹了。

寫了初版經過開線程來作的日誌組件。

但是，畢竟年輕，問題仍是顯而易見的。一秒打100條就不行了。

因而在我從新着手c#開發的時候，抽了點時間，來了一次重構。

首先，從總體架構下手：

- 舊組件特色：

* 使用多線程隊列，用互斥變量控制線程對文本的寫入。

* 經過單例加鎖的方式，控制資源的爭奪

* 線程是隨機被選中入鎖的，寫入的日誌時間順序可能不對

* 一個線程一次文本操做，開關都在一個線程操做，一次只寫入一條變量

- 優勢：

* 多線程操做，表面提升操做效率

　 * 單例加鎖，確保惟一

- 缺點：

* 性能底下，過分操做io致使性能嚴重冗餘

* 一次只寫一條

- 改進

* 使用生產者消費者模式，分開操做，限制線程數量

* 使用棧隊列，先進先出，保證日誌順序

* 單例IO變量，批量進行寫入操做

改形成果：

using System;
using System.Collections;
using System.IO;
using System.Text;
using System.Threading;
using System.Windows.Threading;

namespace Helper
{
    public static class LogHelper
    {
        private static readonly Queue LogQueue = new Queue();

        private static bool _isStreamClose = true;

        private static bool _isThreadBegin = false;

        private static StreamWriter _fileStreamWriter;

        private static readonly string fileName =@"BugLog.txt";

        static int _intervalTime = 10000;// 10s

        static System.Timers.Timer _timer = new System.Timers.Timer(_intervalTime);

        /// <summary>
        /// 添加日誌隊列
        /// </summary>
        /// <param name="message"></param>
        public static void AddLog(string message)
        {
            string logContent = $"[{DateTime.Now:yyyy-MM-dd hh:mm:ss}] =>{message}";
            LogQueue.Enqueue(logContent);
            if (!_isThreadBegin)
            {
                BeginThread();
            }
        }

        public static void AddLog(Exception ex)
        {
            var logContent = $"[{DateTime.Now:yyyy-MM-dd hh:mm:ss}]錯誤發生在：{ex.Source}，\r\n 內容：{ex.Message}";
            logContent += $"\r\n  跟蹤：{ex.StackTrace}";
            LogQueue.Enqueue(logContent);
            if (!_isThreadBegin)
            {
                BeginThread();
            }
        }

        /// <summary>
        /// 讀取日誌隊列的一條數據
        /// </summary>
        /// <returns></returns>
        private static object GetLog()
        {
            return LogQueue.Dequeue();
        }

        /// <summary>
        /// 開啓定時查詢線程
        /// </summary>
        public static void BeginThread()
        {
            _isThreadBegin = true;

            //實例化Timer類，設置間隔時間爲10000毫秒；     

            _timer.Interval = _intervalTime;

            _timer.Elapsed += SetLog;

            //到達時間的時候執行事件；   

            _timer.AutoReset = true;

            //設置是執行一次（false）仍是一直執行(true)；     

            _timer.Enabled = true;
        }


        /// <summary>
        /// 寫入日誌
        /// </summary>
        private static void SetLog(object source, System.Timers.ElapsedEventArgs e)
        {
            if (LogQueue.Count == 0)
            {
                if (_isStreamClose) return;
                _fileStreamWriter.Flush();
                _fileStreamWriter.Close();
                _isStreamClose = true;
                return;
            }
            if (_isStreamClose)
            {
                Isexist();
                string errLogFilePath = Environment.CurrentDirectory + @"\Log\" + fileName.Trim();
                if (!File.Exists(errLogFilePath))
                {
                    FileStream fs1 = new FileStream(errLogFilePath, FileMode.Create, FileAccess.Write);
                    _fileStreamWriter = new StreamWriter(fs1);
                }
                else
                {
                    _fileStreamWriter = new StreamWriter(errLogFilePath, true);
                }
                _isStreamClose = false;
            }

            var strLog = new StringBuilder();

            var onceTime = 50;

            var lineNum = LogQueue.Count > onceTime ? onceTime : LogQueue.Count;

            for (var i = 0; i < lineNum; i++)
            {
                strLog.AppendLine(GetLog().ToString());
            }

            _fileStreamWriter.WriteLine(strLog.ToString());

        }

        /// <summary>
        /// 判斷是否存在日誌文件
        /// </summary>
        private static void Isexist()
        {
            string path = Environment.CurrentDirectory + @"\Log\";
            if (!File.Exists(path))
            {
                Directory.CreateDirectory(path);
            }
        }
    }
}