.Net專案中NLog的配置與使用

追逐時光發表於2019-07-14

引言：

　　因為之前在專案開發中一直都是使用的Log4Net作為專案的日誌記錄框架，最近忽然感覺對它已經有點膩了，所以嘗試著使用了NLog作為新專案的日誌記錄框架（當然作為一名有志向的攻城獅永遠都不能只侷限於眼前的技術，要不斷的使用和學習新的技術）。當然serilog也是一個不錯的日誌記錄框架喲，不過今天主要還是要講述的是NLog在專案中的配置和使用。

NLog框架原始碼：https://github.com/NLog/NLog

一、匯入NLog NuGet PackAge：

 

 二、配置NLog 配置檔案：

注意：在這裡我是專門新建了一個NLog.config 配置檔案用來進行獨立配置，當然你也可以在web.config中完成相應的配置！！
NLog詳細配置檔案資訊，請檢視官網說明：https://github.com/nlog/nlog/wiki/configuration-file
可參考曉晨大佬的NLog配置：https://www.cnblogs.com/stulzq/p/8504860.html

a、我的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">

  <targets>
    <!--此部分中的所有目標將自動非同步-->
    <target name="asyncFile" xsi:type="AsyncWrapper">
      <!--專案日誌儲存檔案路徑說明fileName="${basedir}/儲存目錄，以年月日的格式建立/${shortdate}/${記錄器名稱}-${單級記錄}-${shortdate}.txt"-->
      <target name="log_file" xsi:type="File"
              fileName="${basedir}/ProjectLogs/${shortdate}/${logger}-${level}-${shortdate}.txt"
              layout="${longdate} | ${message} ${onexception:${exception:format=message} ${newline} ${stacktrace} ${newline}"
              archiveFileName="${basedir}/archives/${logger}-${level}-${shortdate}-{#####}.txt"
              archiveAboveSize="102400"
              archiveNumbering="Sequence"
              concurrentWrites="true"
              keepFileOpen="false" />
    </target>
    <!--使用可自定義的著色將日誌訊息寫入控制檯-->
    <target name="colorConsole" xsi:type="ColoredConsole" layout="[${date:format=HH\:mm\:ss}]:${message} ${exception:format=message}" />
  </targets>

  <!--規則配置,final - 最終規則匹配後不處理任何規則-->
  <rules>
    <logger name="Microsoft.*" minlevel="Info" writeTo="" final="true" />
    <logger name="*" minlevel="Info" writeTo="asyncFile" />
    <logger name="*" minlevel="Warn" writeTo="colorConsole" />
  </rules>
</nlog>

b、NLog配置檔案資訊簡單概述：

1、rules【規則】說明：

　　規則是logger具有以下屬性的元素：
name - 記錄器名稱過濾器 - 可能包含萬用字元（*和？）
minlevel - 記錄的最低階別
maxlevel - 記錄的最高階別
level - 單級記錄
levels - 逗號分隔的記錄級別列表
writeTo - 逗號分隔的要寫入的目標列表
final - 最終規則匹配後不處理任何規則
enabled- 設定為false禁用規則而不刪除它
ruleName- 規則識別符號，允許使用Configuration.FindRuleByName和進行規則查詢Configuration.RemoveRuleByName。在NLog 4.6.4中引入
注意：雖然命名了規則logger，但它沒有定義記錄器。它引用一個或多個記錄器。
通過將規則name模式與記錄器名稱匹配，將規則對映到記錄器。規則name屬性可以包括萬用字元（*和？），以通過萬用字元匹配來匹配記錄器名稱。
* - 匹配0個或更多字元
? - 恰好匹配1個字元

2、targets【目標】：

　　每個目標由一個target元素表示。每個目標需要兩個屬性：
name - 目標名稱
type - 目標型別 - 例如“檔案”，“資料庫”，“郵件”。使用名稱空間時，此屬性已命名xsi:type。
除了這些屬性之外，目標通常還接受其他引數，這些引數會影響診斷跟蹤的寫入方式。每個目標都有一組不同的引數，它們在專案主頁上有詳細描述，並且它們是上下文相關的。Intellisense也可以在Visual Studio中使用。
例如，File目標接受fileName定義輸出檔名的引數，Console目標具有error引數，該引數確定診斷跟蹤是否寫入標準錯誤（stderr）而不是程式的標準輸出（stdout）。
此示例演示了一個targets定義多個目標的部分：兩個檔案，一個網路目標和OutputDebugString目標：

< targets >
< target name = “ f1 ” xsi ：type = “ File ” fileName = “ file1.txt ” />
< target name = “ f2 ” xsi ：type = “ File ” fileName = “ file2.txt ” /> 
< target name = “ n1 ” xsi ：type = “ Network ” address = “ tcp：// localhost：4001 ” />
< target name = “ ds ” xsi ：type = “ OutputDebugString ” />
</ targets >

NLog提供了許多預定義的目標。實際上建立自己的目標非常容易 - 請參閱如何編寫自定義目標。

三、NLog使用：

　　在這裡，我封裝了一個NLog使用幫助類，提供給全站呼叫，這樣就可以避免在不同的類中例項化Nlog物件的步驟。

LoggerHelper.cs：

    /// <summary>
    /// nLog使用幫助類
    /// </summary>
    public class LoggerHelper
    {
        /// <summary>
        /// 例項化nLog，即為獲取配置檔案相關資訊
        /// </summary>
        private readonly NLog.Logger _logger = LogManager.GetCurrentClassLogger();

        private static LoggerHelper _obj;

        public static LoggerHelper _
        {
            get => _obj ?? (new LoggerHelper());
            set => _obj = value;
        }

        #region Debug，除錯
        public void Debug(string msg)
        {
            _logger.Debug(msg);
        }

        public void Debug(string msg, Exception err)
        {
            _logger.Debug(err, msg);
        }
        #endregion

        #region Info，資訊
        public void Info(string msg)
        {
            _logger.Info(msg);
        }

        public void Info(string msg, Exception err)
        {
            _logger.Info(err, msg);
        }
        #endregion

        #region Warn，警告
        public void Warn(string msg)
        {
            _logger.Warn(msg);
        }

        public void Warn(string msg, Exception err)
        {
            _logger.Warn(err, msg);
        }
        #endregion

        #region Trace，追蹤
        public void Trace(string msg)
        {
            _logger.Trace(msg);
        }

        public void Trace(string msg, Exception err)
        {
            _logger.Trace(err, msg);
        }
        #endregion

        #region Error，錯誤
        public void Error(string msg)
        {
            _logger.Error(msg);
        }

        public void Error(string msg, Exception err)
        {
            _logger.Error(err, msg);
        }
        #endregion

        #region Fatal,致命錯誤
        public void Fatal(string msg)
        {
            _logger.Fatal(msg);
        }

        public void Fatal(string msg, Exception err)
        {
            _logger.Fatal(err, msg);
        }
        #endregion
    }

四、執行記錄結果：

　　因為我在NLog.config配置檔案中配置的日誌儲存路徑為：ProjectLogs/當前時間（yyyy-MM-dd）/
如下圖所示：

 

相關文章