一個簡單好用的日誌框架NLog

時間 2019-11-11

標籤一個簡單好用日誌框架 nlog 简体版

原文原文鏈接

以前我介紹過如何使用log4net來記錄日誌，但最近喜歡上了另外一個簡單好用的日誌框架NLog。關於NLog和log4net的比較這裏就很少討論了，感興趣的朋友能夠參看.NET日誌工具介紹和log4net vs. Nlog這兩篇文章。本文主要介紹一下如何在項目中使用NLog。html

在Nuget中安裝NLog git

NLog能夠直接使用Nuget安裝：　PM > Install-Package Nloggithub

使用NLog web

NLog的使用方式基本上和其它的Log庫差很少，分爲Trace、Debug、Info、Error、Fatal五個等級數據庫

    private static Logger logger = LogManager.GetCurrentClassLogger();
    static void Main(string[] args)
    {
        logger.Trace("Trace Message");
        logger.Debug("Debug Message");
        logger.Info("Info Message");
        logger.Error("Error Message");
        logger.Fatal("Fatal Message");
    }網絡

不過它提供的方法卻是蠻多的，光Trace就有42種重載形式。雖然功能強大事件好事，但某種程度上也增長了學習成本。 app

配置NLog 框架

執行了上面的語句後，其實是沒有任何效果的。由於咱們尚未配置日誌的輸出路徑。這個輸出路徑通常是在配置文件中配置的（也支持硬編碼），NLog支持兩種配置文件格式 ide

配置信息嵌入在.NET應用程序標準的*.exe.config或者web.config文件裏
保存在獨立文件裏，也叫單一格式

第一張方式比較常規，但我不喜歡這種方式，由於它和其它與日誌無關的配置寫在一起了，不方便在不一樣的項目中共享配置。這裏主要介紹下獨立文件的方式。NLog支持以下三種文件名的配置文件："NLog.config"、"*.exe.nlog"和"NLog.dll.nlog"，我比較喜歡第一種。無論哪種，其內容是同樣的，一個簡單的示例以下：工具

它主要包括兩個部分：輸出目標target和路由規則rule。下面就分別介紹一下他們。

輸出目標target

每一個target表明一個輸出目標，它主要包含兩個屬性：name和type。name是輸出模板的名稱，在後面的路由規則中使用，type則是輸出類型，常見的有

Console 輸出到控制檯
Debugger 輸出到
File 輸出到文件
Mail 輸出爲郵件發送
Network 輸出到網絡地址
Database 輸出到數據庫

當選擇某一種類型的時候，還須要配置相應的參數。如輸出類型是File時，咱們要配置日誌路徑filename，這裏是可使用一些變量的（花括號裏面的部分），我這裏的例子：

fileName="${basedir}/Logs/Error/${shortdate}/error.txt"

輸出的日誌格式爲 /Log/2014-10-01/err.txt 天天生成一個文件夾，很是方便。

輸出格式的控制：

有的時候，咱們須要對時間、異常等這些對象的輸出格式進行控制。它們能夠經過修改layout參數來實現。這一部分是相對比較複雜的，不在本文討論範圍之列，有空的話我再專門介紹下。

參考示例：

網上有許多現成的示例，直接參考一下比從頭寫起要們節省很多時間，這裏我簡單的列舉兩個，歡迎讀者朋友推薦。

順便這兒也貼一個我經常使用的配置文檔：

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        
        <target name="console" xsi:type="ColoredConsole"
                        layout="${date:format=HH\:mm\:ss}> ${message}"/>

        
        <target name="debugger" xsi:type="Debugger"
                        layout="${date:format=HH\:mm\:ss} | ${level:padding=-5} | ${message}" />

        
        <target name="error_file" xsi:type="File" maxArchiveFiles="30"
                        fileName="${basedir}/Logs/Error/${shortdate}/error.txt"
                        layout="${longdate} | ${level:uppercase=false:padding=-5} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
    </targets>
    <rules>
        
        <logger name="*" minlevel="Debug" writeTo="debugger" />
        <logger name="*" minlevel="Error" writeTo="error_file" />
    </rules>
</nlog>

路由規則rule

路由規則主要用於將日誌和輸出目標匹配起來，它通常有以下幾個屬性

name - 記錄者的名字 (容許使用通配符*)
minlevel - 匹配日誌範圍的最低級別
maxlevel - 匹配日誌範圍的最高級別
level - 匹配的單一日誌級別
levels - 匹配的一系列日誌級別，由逗號分隔。
writeTo - 規則匹配時日誌應該被寫入的一系列目標，由逗號分隔。

看上去有好幾個屬性，實際上用起來仍是比較簡單的，例如我前面的三條規則解釋以下：

    <logger name="*" writeTo="console" />    將全部的日誌輸出到控制檯中
    <logger name="*" minlevel="Debug" writeTo="debugger" />            將Debug級別以上的日誌輸出到Debugger中
    <logger name="*" minlevel="Error" writeTo="error_file" />        將Error級別以上的日誌輸出到文件中

另外，NLOG支持配置多個路由規則，能夠很是方便咱們的輸出。

因爲篇幅有限，這裏介紹得比較簡略。更詳細的配置文件設置能夠參看官方文檔：https://github.com/nlog/NLog/wiki/Configuration-file#configuration-file-locations

簡單的封裝：

前面已經列舉過NLog的使用方法，雖然其使用並不算髮雜，但一個簡單的Wrapper能夠下降使用門檻，規範使用方式，甚至方便後期切換日誌框架，不少時候仍是很是有必要的。這裏給一個簡單的封裝：

 1     class Logger
 2     {
 3         NLog.Logger logger;
 4 
 5         private Logger(NLog.Logger logger)
 6         {
 7             this.logger = logger;
 8         }
 9 
10         public Logger(string name)
11             :this(NLog.LogManager.GetLogger(name))
12         {
13         }
14 
15         public static Logger Default { get; private set; }
16         static Logger()
17         {
18             Default = new Logger(NLog.LogManager.GetCurrentClassLogger());
19         }
20 
21         public void Debug(string msg, params object[] args)
22         {
23             logger.Debug(msg, args);
24         }
25 
26         public void Debug(string msg, Exception err)
27         {
28             logger.Debug(msg, err);
29         }
30 
31         public void Info(string msg, params object[] args)
32         {
33             logger.Info(msg, args);
34         }
35 
36         public void Info(string msg, Exception err)
37         {
38             logger.Info(msg, err);
39         }
40 
41         public void Trace(string msg, params object[] args)
42         {
43             logger.Trace(msg, args);
44         }
45 
46         public void Trace(string msg, Exception err)
47         {
48             logger.Trace(msg, err);
49         }
50 
51         public void Error(string msg, params object[] args)
52         {
53             logger.Error(msg, args);
54         }
55 
56         public void Error(string msg, Exception err)
57         {
58             logger.Error(msg, err);
59         }
60 
61         public void Fatal(string msg, params object[] args)
62         {
63             logger.Fatal(msg, args);
64         }
65 
66         public void Fatal(string msg, Exception err)
67         {
68             logger.Fatal(msg, err);
69         }
70     }