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

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

 

在Nuget中安裝NLog

NLog可以直接使用Nuget安裝：　PM > Install-Package Nlog

 

使用NLog

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種重載形式。雖然功能強大事件好事，但某種程度上也增加了學習成本。

 

配置NLog

執行了上面的語句后，實際上是沒有任何效果的。因為我們還沒有配置日志的輸出路徑。這個輸出路徑一般是在配置文件中配置的（也支持硬編碼），NLog支持兩種配置文件格式

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

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

<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="Console" />
        <target name="debugger" xsi:type="Debugger" layout="${date:format=HH\:mm\:ss.fff}: ${message}" />
        <target name="error_file" xsi:type="File"
                        fileName="${basedir}/Logs/Error/${shortdate}/error.txt" maxArchiveFiles="30"
                        layout="${longdate} | ${level:uppercase=false} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
    </targets>
    <rules>
        <!--<logger name="*" writeTo="console" />-->
        <logger name="*" minlevel="Debug" writeTo="debugger" />
        <logger name="*" minlevel="Error" writeTo="error_file" />
    </rules>
</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的官方示例
• Most useful NLog configurations

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

<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}"/>
        
        <!--VS輸出窗口-->
        <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="*" writeTo="console" />-->
        <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可以降低使用門檻，規范使用方式，甚至方便后期切換日志框架，很多時候還是非常有必要的。這里給一個簡單的封裝： 

    class Logger
    {
        NLog.Logger logger;

        private Logger(NLog.Logger logger)
        {
            this.logger = logger;
        }

        public Logger(string name)
            :this(NLog.LogManager.GetLogger(name))
        {
        }

        public static Logger Default { get; private set; }
        static Logger()
        {
            Default = new Logger(NLog.LogManager.GetCurrentClassLogger());
        }

        public void Debug(string msg, params object[] args)
        {
            logger.Debug(msg, args);
        }

        public void Debug(string msg, Exception err)
        {
            logger.Debug(msg, err);
        }

        public void Info(string msg, params object[] args)
        {
            logger.Info(msg, args);
        }

        public void Info(string msg, Exception err)
        {
            logger.Info(msg, err);
        }

        public void Trace(string msg, params object[] args)
        {
            logger.Trace(msg, args);
        }

        public void Trace(string msg, Exception err)
        {
            logger.Trace(msg, err);
        }

        public void Error(string msg, params object[] args)
        {
            logger.Error(msg, args);
        }

        public void Error(string msg, Exception err)
        {
            logger.Error(msg, err);
        }

        public void Fatal(string msg, params object[] args)
        {
            logger.Fatal(msg, args);
        }

        public void Fatal(string msg, Exception err)
        {
            logger.Fatal(msg, err);
        }
    }

雖然比較簡單，但大多數簡單的場景下還是夠用的。如果要更強大一點的封裝可以考慮 Common.Logging, SimpleLoggingFacade等一些成型的庫。

 

第三方查看工具

和log4net一樣，NLog也是被一些第三方log查看工具所支持的，我這里就搜索到了兩個：Sentinel和 Harvester 。我用這些查看工具的地方不大多，沒有具體去研究它們。不過NLog是支持DB輸出的，感覺輸出到DB中后用SQL查詢要更加方便而強大些，就是實時性差些。

 

學習資料：

本文這里只是方便NLOG快速入門，仍屬於管中窺豹階段，NLOG本身還是非常強大的，園子里有一系列文章進行了比較深入的介紹，有這方面需求的朋友可以看看：

http://www.cnblogs.com/dflying/category/78087.html

另外，網上也有不少寫得非常好的入門介紹文檔，也可以學習一下：

• Introduction to NLog
• Trace Activities with NLog
• Logging setup in 5 minutes with NLog
• 介紹好用函式庫：NLog - Advanced .NET Logging