.Net使用日志框架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支持两种配置文件格式

• 配置信息嵌入在.net应用程序标准的*.exe.config或者web.config文件里

• 保存在独立文件里，也叫单一格式

第一张方式比较常规，但我不喜欢这种方式，因为它和其它与日志无关的配置写在一块儿了，不方便在不同的项目中共享配置。这里主要介绍下独立文件的方式。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 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支持配置多个路由规则，可以非常方便我们的输出。

简单的封装：

前面已经列举过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);
        }
    }

到此这篇关于.net使用日志框架nlog的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持。