.Net怎么使用日志框架NLog

這篇文章主要講解了“.Net怎么使用日志框架NLog”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“.Net怎么使用日志框架NLog”吧！

在Nuget中安裝NLog

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

使用NLog

NLog的使用方式基本上和其它的Log庫(kù)差不多，分為T(mén)race、Debug、Info、Error、Fatal五個(gè)等級(jí)

    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");
    }

不過(guò)它提供的方法倒是蠻多的，光Trace就有42種重載形式。雖然功能強(qiáng)大事件好事，但某種程度上也增加了學(xué)習(xí)成本。

配置NLog

執(zhí)行了上面的語(yǔ)句后，實(shí)際上是沒(méi)有任何效果的。因?yàn)槲覀冞€沒(méi)有配置日志的輸出路徑。這個(gè)輸出路徑一般是在配置文件中配置的（也支持硬編碼），NLog支持兩種配置文件格式

• 配置信息嵌入在.NET應(yīng)用程序標(biāo)準(zhǔn)的*.exe.config或者web.config文件里

• 保存在獨(dú)立文件里，也叫單一格式

第一張方式比較常規(guī)，但我不喜歡這種方式，因?yàn)樗推渌c日志無(wú)關(guān)的配置寫(xiě)在一塊兒了，不方便在不同的項(xiàng)目中共享配置。這里主要介紹下獨(dú)立文件的方式。NLog支持如下三種文件名的配置文件："NLog.config"、"*.exe.nlog"和"NLog.dll.nlog"，我比較喜歡第一種。不管哪一種，其內(nèi)容是一樣的，一個(gè)簡(jiǎn)單的示例如下：

<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>

它主要包括兩個(gè)部分：輸出目標(biāo)target和路由規(guī)則rule。下面就分別介紹一下他們。

輸出目標(biāo)target

每個(gè)target代表一個(gè)輸出目標(biāo)，它主要包含兩個(gè)屬性：name和type。name是輸出模板的名稱(chēng)，在后面的路由規(guī)則中使用，type則是輸出類(lèi)型，常見(jiàn)的有

• Console        輸出到控制臺(tái)

• Debugger     輸出到

• File        輸出到文件

• Mail        輸出為郵件發(fā)送

• Network        輸出到網(wǎng)絡(luò)地址

• Database        輸出到數(shù)據(jù)庫(kù)

當(dāng)選擇某一種類(lèi)型的時(shí)候，還需要配置相應(yīng)的參數(shù)。如輸出類(lèi)型是File時(shí)，我們要配置日志路徑filename，這里是可以使用一些變量的（花括號(hào)里面的部分），我這里的例子：

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

輸出的日志格式為 /Log/2014-10-01/err.txt    每天生成一個(gè)文件夾，非常方便。

輸出格式的控制：

有的時(shí)候，我們需要對(duì)時(shí)間、異常等這些對(duì)象的輸出格式進(jìn)行控制。它們可以通過(guò)修改layout參數(shù)來(lái)實(shí)現(xiàn)。這一部分是相對(duì)比較復(fù)雜的，不在本文討論范圍之列，有空的話(huà)我再專(zhuān)門(mén)介紹下。

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

<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>

路由規(guī)則rule

路由規(guī)則主要用于將日志和輸出目標(biāo)匹配起來(lái)，它一般有如下幾個(gè)屬性

• name - 記錄者的名字 (允許使用通配符*)

• minlevel - 匹配日志范圍的最低級(jí)別

• maxlevel - 匹配日志范圍的最高級(jí)別

• level - 匹配的單一日志級(jí)別

• levels - 匹配的一系列日志級(jí)別，由逗號(hào)分隔。

• writeTo - 規(guī)則匹配時(shí)日志應(yīng)該被寫(xiě)入的一系列目標(biāo)，由逗號(hào)分隔。

看上去有好幾個(gè)屬性，實(shí)際上用起來(lái)還是比較簡(jiǎn)單的，例如我前面的三條規(guī)則解釋如下：

    <logger name="*" writeTo="console" />    將所有的日志輸出到控制臺(tái)中
    <logger name="*" minlevel="Debug" writeTo="debugger" />            將Debug級(jí)別以上的日志輸出到Debugger中
    <logger name="*" minlevel="Error" writeTo="error_file" />        將Error級(jí)別以上的日志輸出到文件中

另外，NLOG支持配置多個(gè)路由規(guī)則，可以非常方便我們的輸出。

簡(jiǎn)單的封裝：

前面已經(jīng)列舉過(guò)NLog的使用方法，雖然其使用并不算發(fā)雜，但一個(gè)簡(jiǎn)單的Wrapper可以降低使用門(mén)檻，規(guī)范使用方式，甚至方便后期切換日志框架，很多時(shí)候還是非常有必要的。這里給一個(gè)簡(jiǎn)單的封裝：

    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);
        }
    }

感謝各位的閱讀，以上就是“.Net怎么使用日志框架NLog”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì).Net怎么使用日志框架NLog這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！